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

Kits e Compre junto

Como funcionam os kits de produtos e os combos de Compre junto, como o preço do kit é calculado e a relação entre os dois, com o mapa das rotas.

Duas ferramentas aumentam o valor médio do pedido vendendo produtos em conjunto. O kit (bundle) é um pacote de produtos que a loja monta e vende com preço fechado ou desconto: "Kit churrasco", "Kit skincare". O Compre junto (FBT, de frequently bought together) é o bloco da página do produto que sugere um ou dois companheiros e dá um desconto se o cliente levar tudo; a plataforma descobre os pares olhando os pedidos, e você também pode montar combos à mão.

Pontos-chave
  • Os kits dependem do módulo product-bundles e do privilégio manage_bundles ou manage_catalog. As rotas de Compre junto exigem só manage_catalog e não dependem desse módulo.
  • Dinheiro é sempre inteiro em centavos. Percentuais de desconto são em pontos-base: 1000 é 10%.
  • Um kit tem preço fechado (price_override) ou desconto (discount_type e discount_value). O preço fechado vence.
  • Todo combo do Compre junto é materializado como um kit ativo de slug fbt-<id do combo>, que aparece na lista de kits.
  • O status do kit é uma letra: A ativo, D desativado, H oculto.

Como funciona

Como o preço do kit é calculado

O preço de tabela do kit (calculated_price) é a soma de preço do produto × quantidade de cada item. O preço final (final_price) é:

ConfiguraçãoPreço final
price_override maior que zeroEsse valor (preço fechado), em centavos
discount_type fixedTabela menos o valor fixo (discount_value, em centavos)
discount_type percentageTabela menos tabela × discount_value / 10000
Nada configuradoO preço de tabela

O resultado nunca é negativo.

O ciclo do Compre junto

  1. Minerar

    POST /fbt/mine olha os pedidos dos últimos 180 dias e cria combos com os pares que mais saem juntos.

  2. Revisar

    GET /fbt lista os combos com support_count (em quantos pedidos o par apareceu) e lift (quanto mais comum que o acaso).

  3. Ajustar

    Desative o que não faz sentido, apague o que não quer, e crie à mão os que a mineração não achou.

  4. A vitrine mostra

    A página do produto exibe o combo quando o recurso está ligado nas configurações da loja e ao menos 2 itens estão disponíveis.

Conceitos-chave

Nomes confusos do preço

Por razões de compatibilidade, o mesmo valor aparece com dois nomes: price_bps é o mesmo que price_override (preço fechado, em centavos), e discount_bps é o mesmo que discount_value. Apesar do sufixo bps, price_bps não é percentual. Prefira price_override e discount_value.

Kit de loja e kit de seller

Um kit sem vendor_id é da loja. Um kit com vendor_id é de um seller, e todos os seus produtos precisam ser desse seller.

Compre junto: de onde vêm os combos

Um combo minerado exige o par em pelo menos 3 pedidos bem-sucedidos nos últimos 180 dias, em pelo menos 1% dos pedidos que têm o produto-âncora, com produtos do mesmo seller. Cada combo tem uma âncora e de 1 a 2 companheiros. Combos criados à mão (source: manual) e combos desativados nunca são tocados pela mineração.

Endpoints

MétodoCaminhoPara que serveAuth
GET/api/v1/admin/bundlesLista os kitsadmin
POST/api/v1/admin/bundlesCria um kitadmin
GET/api/v1/admin/bundles/{id}Consulta um kitadmin
PUT/api/v1/admin/bundles/{id}Altera um kitadmin
DELETE/api/v1/admin/bundles/{id}Apaga um kitadmin
GET/api/v1/admin/fbtLista os combos de Compre juntoadmin
POST/api/v1/admin/fbt/mineMinera combos dos pedidosadmin
POST/api/v1/admin/fbt/manualCria um combo à mãoadmin
PUT/api/v1/admin/fbt/{id}/statusAtiva ou desativa um comboadmin
DELETE/api/v1/admin/fbt/{id}Apaga um comboadmin

Erros comuns

  • Criar um kit sem status e receber 500: envie status sempre (active, disabled, hidden ou A, D, H). O valor draft também falha.
  • Esperar que price_bps seja uma porcentagem: é o preço fechado em centavos.
  • Mandar discount_value: 10 para 10%: percentual é em pontos-base, então 10% é 1000.
  • Procurar um kit pelo slug no parâmetro search: a busca olha só o nome e a descrição.
  • Apagar um combo de Compre junto esperando apagar o kit gerado: o kit fbt-... continua na lista de kits. Apague-o à parte.
  • Achar que apagar um combo minerado é definitivo: a próxima mineração pode recriá-lo.
  • Esperar a mineração mudar combos manuais ou desativados: ela nunca os toca.

Próximos passos

Gerenciar kits
Criar, alterar e apagar kits.
Compre junto
Minerar e curar combos.
Anterior
Regras automáticas de selo
Próxima
Gerenciar kits
Nesta página
  • Como funciona
  • Como o preço do kit é calculado
  • O ciclo do Compre junto
  • Conceitos-chave
  • Nomes confusos do preço
  • Kit de loja e kit de seller
  • Compre junto: de onde vêm os combos
  • Endpoints
  • Erros comuns
  • Próximos passos