VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Kits, mestres e caixas

Os conjuntos de venda da vitrine (kits, produtos mestres com ofertas de sellers, mixes por cliente e caixas de grade) e o mapa de suas rotas.

Além do produto simples, a vitrine vende conjuntos: vários produtos vendidos juntos, o mesmo produto oferecido por vários sellers (lojistas), uma lista montada para um cliente específico ou uma caixa fechada com várias unidades. Esta seção reúne as rotas de leitura desses conjuntos, todas usadas pelas páginas de produto, listagens e carrinho.

Pontos-chave
  • Cada recurso é independente. Kits (bundles) não dependem de módulo; produtos mestres, mixes e caixas dependem de módulos que a loja liga ou desliga. Com o módulo desligado a rota responde 403 com {"error":"module_disabled","module":"..."}.
  • Dinheiro é inteiro em centavos (19990 = R$ 199,90) em todas estas rotas.
  • Só mixes exigem login. As demais rotas são públicas, mas as de kits e produtos mestres respondem 401 shopping_requires_login a visitante quando a loja só permite navegar logado.
  • Um produto mestre nunca é vendido direto na vitrine. O que se vende são as ofertas dos sellers ligadas a ele, e é isso que a rota de ofertas devolve.
  • Kits, caixas e produtos mestres só mostram itens da loja (marketplace). Kits e caixas criados por um seller ficam fora das listagens públicas.

Como funciona

Os conjuntos e quando usar cada um

RecursoO que éQuem montaLogin
Kit (bundle)Lista fixa de produtos com preço calculado, preço fixo ou desconto.Administradornão
Produto mestreFicha de catálogo que agrupa as ofertas de vários sellers para o mesmo produto.Administradornão
Modo catálogoMarca de seller que vende só por orçamento ou link externo, sem carrinho.Sellernão
MixConjunto com preço fechado, componentes obrigatórios e trocas, liberado para clientes ou grupos específicos.Administrador ou sellersim
Caixa (product box)Embalagem de grade (vários tamanhos) ou fechada, com variantes por produto.Administradornão
  1. Montar a vitrine

    Liste os kits em Kits, as caixas em Caixas de produto e, para clientes logados, os mixes em Mixes.

  2. Na página do produto

    Consulte as ofertas dos sellers em Produtos mestres, as variantes de caixa do produto e o modo catálogo em Modo catálogo para decidir qual botão de compra mostrar.

  3. Adicionar ao carrinho

    Estas rotas só leem; a escrita no carrinho é de outra seção. No caso do mix, Resolver mix calcula como o preço fechado se distribui entre as linhas.

Conceitos-chave

Dinheiro e nomes enganosos

Todo valor monetário é inteiro em centavos. Atenção: nos kits, o campo price_bps (e o espelho price_override) não é basis points, é um preço fixo em centavos; já discount_bps é basis points (1000 = 10%) quando discount_type é percentage, e centavos quando é fixed. Veja Kits.

Quem pode ver o quê

Visitantes e clientes veem somente conjuntos ativos e da loja (sem dono seller). Preços de ofertas de produtos mestres e de variantes de caixa são zerados ou omitidos para visitante quando a loja esconde preço para quem não está logado (veja o campo price_redacted). A listagem de kits não aplica essa regra.

Cache

As leituras públicas voltam com Cache-Control: public, max-age=300, stale-while-revalidate=1800 (5 minutos, com revalidação em segundo plano). A lista de variantes de caixa de um cliente logado e as ofertas filtradas pela região do comprador voltam private, no-store. Mixes e demais respostas autenticadas dependem do cliente: não as guarde em cache compartilhado.

Ids

Todos os ids são UUID em string. Kits também têm slug (texto) usado no detalhe.

Endpoints

MétodoCaminhoPara que serveAuth
GET/api/v1/storefront/bundlesListar kitsnenhuma
GET/api/v1/storefront/bundles/{slug}Detalhe de um kitnenhuma
GET/api/v1/storefront/master-productsListar produtos mestres (sempre vazio)nenhuma
GET/api/v1/storefront/master-products/{id}Detalhe de produto mestre (sempre 404)nenhuma
GET/api/v1/storefront/master-products/{id}/offersOfertas dos sellersnenhuma
GET/api/v1/storefront/catalog-store/products/{id}Modo catálogo de um produtonenhuma
GET/api/v1/storefront/catalog-store/vendorsSellers em modo catálogonenhuma
GET/api/v1/storefront/mix-productsListar mixes do clientecliente
GET/api/v1/storefront/mix-products/{id}Detalhe de um mixcliente
POST/api/v1/storefront/mix-products/{id}/resolveResolver mix em linhas de carrinhocliente
GET/api/v1/storefront/product-boxesListar caixasnenhuma
GET/api/v1/storefront/product-boxes/{id}Detalhe de uma caixanenhuma
GET/api/v1/storefront/products/{productID}/boxesVariantes de caixa de um produtonenhuma

Erros comuns

  • Esperar o produto mestre na vitrine. A lista de mestres é sempre vazia e o detalhe é sempre 404. Use /master-products/{id}/offers para comparar sellers.
  • Tratar price_bps como basis points. É preço fixo em centavos; 0 significa "usar o preço calculado".
  • Mandar um id que não é UUID. Várias destas rotas devolvem 500 em vez de 400 quando o id é malformado (veja cada página). Valide o formato antes de chamar.
  • Chamar mixes sem login. Resposta 401 {"error":"missing authorization header"}.
  • Ignorar a região do comprador nas ofertas. Dependendo da configuração da loja, ofertas de sellers que não entregam na região do cliente não aparecem.
  • Usar per_page acima do permitido. O servidor não limita ao máximo: volta ao valor padrão da rota.

Próximos passos

Kits
Lista e detalhe com preço calculado.
Produtos mestres e ofertas
Compare os sellers de um mesmo produto.
Mixes
Conjuntos por cliente e resolução em linhas de carrinho.
Anterior
Links de compartilhamento
Próxima
Kits
Nesta página
  • Como funciona
  • Os conjuntos e quando usar cada um
  • Conceitos-chave
  • Dinheiro e nomes enganosos
  • Quem pode ver o quê
  • Cache
  • Ids
  • Endpoints
  • Erros comuns
  • Próximos passos