​
Introdução

Esta página documenta os includes disponíveis para os recursos promocionais da API, sob o namespace /pricing/*, que abrangem:

  • Combos (compre junto)
  • Promoções de produtos
  • Upsells
  • Cupons de desconto

O parâmetro include permite expandir a resposta da API com dados relacionados, otimizando o consumo e evitando múltiplas chamadas subsequentes.

​
Combos ver na documentação →

Combos são promoções do tipo “compre junto”, onde a compra combinada de produtos gera um benefício ou desconto.

​
Includes disponíveis

IncludeDescrição
productsProdutos que fazem parte do combo

​
Endpoints

GET /v2/{alias}/pricing/combos
GET /v2/{alias}/pricing/combos/{id}

​
Exemplo com include

GET /v2/{alias}/pricing/combos?include=products

​
Promoções de Produtos ver na documentação →

Promoções criadas para aplicar descontos com base em regras relacionadas a categorias, marcas, coleções ou produtos específicos.

​
Includes disponíveis

IncludeDescrição
categoriesCategorias vinculadas à promoção
collectionsColeções aplicáveis
brandsMarcas incluídas na promoção
productsProdutos individuais com desconto
bannersBanners promocionais vinculados

​
Endpoints

GET /v2/{alias}/pricing/promotions
GET /v2/{alias}/pricing/promotions/{id}

​
Exemplo com include

GET /v2/{alias}/pricing/promotions?include=products,categories,banners

​
Upsells ver na documentação →

Upsells são ofertas sugeridas com base em um produto adquirido, apresentando produtos adicionais com possibilidade de desconto.

​
Includes disponíveis

IncludeDescrição
purchased_productProduto que ativa o upsell
suggested_productProduto sugerido como upsell
promocodeCupom promocional associado (se aplicável)

​
Endpoint

GET /v2/{alias}/pricing/upsells

​
Exemplo com include

GET /v2/{alias}/pricing/upsells?include=suggested_product,promocode

​
Cupons de Desconto ver na documentação →

Cupons de desconto são regras promocionais aplicáveis a compras específicas. Podem ter condições ligadas a produtos, coleções, categorias, marcas, formas de pagamento ou até a um cliente individual.

​
Includes disponíveis

IncludeDescrição
customerCliente específico associado ao cupom (quando for o caso)
categoriesCategorias nas quais o cupom pode ser aplicado
collectionsColeções onde o cupom é válido
brandMarca específica (campo singular)
productsProdutos que aceitam o uso do cupom
paymentsMeios de pagamento válidos para o cupom

​
Endpoints

GET /v2/{alias}/pricing/promocodes
GET /v2/{alias}/pricing/promocodes/{id}

​
Exemplo com include

GET /v2/{alias}/pricing/promocodes?include=products,categories,brand