API atual/Referência completa/Recomendações e compartilhamento

Compre junto

Devolve o combo "Compre junto" de um produto, com os itens, o preço somado, o preço com desconto e a economia, e conta quando o cliente adiciona o combo.

O "Compre junto" (FBT, de frequently bought together) é uma oferta na página do produto: o produto que o cliente está vendo (o âncora) mais um ou dois produtos que costumam ser comprados com ele, por um preço com desconto. O combo é calculado pela loja a partir dos pedidos ou montado à mão pelo lojista.

O combo é só uma oferta de exibição: ele não cria um item especial no carrinho. Para comprar, adicione ao carrinho os produtos listados em items. Esta rota informa o preço do combo para exibição; confira no carrinho o valor final cobrado. Use track-add para registrar que o cliente adicionou o combo, para o lojista medir a conversão.

GET/api/v1/storefront/products/{id}/fbtPública

Combo Compre junto de um produto

Parâmetros de caminho

iduuidobrigatório

Id do produto âncora.

POST/api/v1/storefront/fbt/{id}/track-addPública

Contar a adição de um combo ao carrinho

Parâmetros de caminho

iduuidobrigatório

Id do combo (combo.id da resposta de fbt), não do produto.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/products/db033935-75ea-4b6f-abbb-13d0fcd6386d/fbt"

curl -X POST "$BASE_URL/api/v1/storefront/fbt/6b1d6f0e-3f55-4d5a-9b86-2f1d2c7a9e10/track-add"

Resposta

200Combo disponível

json

{
  "combo": {
    "id": "6b1d6f0e-3f55-4d5a-9b86-2f1d2c7a9e10",
    "bundle_id": null,
    "items": [
      {
        "product_id": "db033935-75ea-4b6f-abbb-13d0fcd6386d",
        "name": "Camiseta Lite Verde 00146",
        "slug": "camiseta-lite-verde-00146-146",
        "image_url": "/uploads/dfe2555e-bfd0-41a8-9fa1-9586999f3798/product/db033935-75ea-4b6f-abbb-13d0fcd6386d/foto.png",
        "price_cents": 39990,
        "in_stock": true
      },
      {
        "product_id": "19c80365-3cb6-47a7-89e5-fdc10ec416aa",
        "name": "Perfume Essencial Preto 02317 - PROMOÇÃO",
        "slug": "perfume-essencial-preto-02317-2317",
        "image_url": "/uploads/dfe2555e-bfd0-41a8-9fa1-9586999f3798/product/19c80365-3cb6-47a7-89e5-fdc10ec416aa/foto.png",
        "price_cents": 1990,
        "in_stock": true
      }
    ],
    "total_price_cents": 41980,
    "combo_price_cents": 39881,
    "savings_cents": 2099
  }
}

200Sem combo

json

{ "combo": null }

200Adição contada

json

{ "ok": true }

A loja de teste usada na documentação não tem um combo ativo, então o exemplo do combo é ilustrativo: o id do combo é fictício e os totais foram calculados com o desconto padrão de 5% sobre os preços reais dos dois produtos.

Campos da resposta

comboobject

O combo, ou null quando o recurso está desligado na loja, o produto não tem combo ativo ou sobraram menos de 2 itens visíveis e com estoque.

combo.iduuid

Id do combo. Use em track-add.

combo.bundle_iduuid

Id do kit (bundle) ligado ao combo, quando existe. null quando o combo não tem kit.

combo.itemsarray

Produtos do combo, com o âncora primeiro. Só entram itens visíveis na vitrine e com estoque.

combo.items[].product_iduuid

Id do produto.

combo.items[].namestring

Nome.

combo.items[].slugstring

Trecho do endereço da página do produto.

combo.items[].image_urlstring

Caminho da imagem principal.

combo.items[].price_centsinteger

Preço do item em centavos.

combo.items[].in_stockboolean

Sempre true: itens sem estoque não entram.

combo.total_price_centsinteger

Soma dos preços dos itens, em centavos.

combo.combo_price_centsinteger

Preço do combo com o desconto da loja (padrão 5%), em centavos.

combo.savings_centsinteger

Economia: total_price_cents menos combo_price_cents.

okboolean

Em track-add, sempre true.

Erros

Status	Quando	Corpo
401	A loja exige login para navegar e a chamada não tem token	`{"error":"shopping_requires_login","message":"this storefront requires login to browse"}`
500	`fbt`: falha ao ler o combo	`{"error":"failed to load combo","detail":"..."}`

track-add é de melhor esforço: responde {"ok": true} mesmo com um id que não existe.

Veja também

Compre junto

Devolve o combo "Compre junto" de um produto, com os itens, o preço somado, o preço com desconto e a economia, e conta quando o cliente adiciona o combo.

GET/api/v1/storefront/products/{id}/fbtPública

Combo Compre junto de um produto

Parâmetros de caminho

iduuidobrigatório

Id do produto âncora.

POST/api/v1/storefront/fbt/{id}/track-addPública

Contar a adição de um combo ao carrinho

Parâmetros de caminho

iduuidobrigatório

Id do combo (combo.id da resposta de fbt), não do produto.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/products/db033935-75ea-4b6f-abbb-13d0fcd6386d/fbt"

curl -X POST "$BASE_URL/api/v1/storefront/fbt/6b1d6f0e-3f55-4d5a-9b86-2f1d2c7a9e10/track-add"

Resposta

200Combo disponível

json

{
  "combo": {
    "id": "6b1d6f0e-3f55-4d5a-9b86-2f1d2c7a9e10",
    "bundle_id": null,
    "items": [
      {
        "product_id": "db033935-75ea-4b6f-abbb-13d0fcd6386d",
        "name": "Camiseta Lite Verde 00146",
        "slug": "camiseta-lite-verde-00146-146",
        "image_url": "/uploads/dfe2555e-bfd0-41a8-9fa1-9586999f3798/product/db033935-75ea-4b6f-abbb-13d0fcd6386d/foto.png",
        "price_cents": 39990,
        "in_stock": true
      },
      {
        "product_id": "19c80365-3cb6-47a7-89e5-fdc10ec416aa",
        "name": "Perfume Essencial Preto 02317 - PROMOÇÃO",
        "slug": "perfume-essencial-preto-02317-2317",
        "image_url": "/uploads/dfe2555e-bfd0-41a8-9fa1-9586999f3798/product/19c80365-3cb6-47a7-89e5-fdc10ec416aa/foto.png",
        "price_cents": 1990,
        "in_stock": true
      }
    ],
    "total_price_cents": 41980,
    "combo_price_cents": 39881,
    "savings_cents": 2099
  }
}

200Sem combo

json

{ "combo": null }

200Adição contada

json

{ "ok": true }

Campos da resposta

comboobject

O combo, ou null quando o recurso está desligado na loja, o produto não tem combo ativo ou sobraram menos de 2 itens visíveis e com estoque.

combo.iduuid

Id do combo. Use em track-add.

combo.bundle_iduuid

Id do kit (bundle) ligado ao combo, quando existe. null quando o combo não tem kit.

combo.itemsarray

Produtos do combo, com o âncora primeiro. Só entram itens visíveis na vitrine e com estoque.

combo.items[].product_iduuid

Id do produto.

combo.items[].namestring

Nome.

combo.items[].slugstring

Trecho do endereço da página do produto.

combo.items[].image_urlstring

Caminho da imagem principal.

combo.items[].price_centsinteger

Preço do item em centavos.

combo.items[].in_stockboolean

Sempre true: itens sem estoque não entram.

combo.total_price_centsinteger

Soma dos preços dos itens, em centavos.

combo.combo_price_centsinteger

Preço do combo com o desconto da loja (padrão 5%), em centavos.

combo.savings_centsinteger

Economia: total_price_cents menos combo_price_cents.

okboolean

Em track-add, sempre true.

Erros

Status	Quando	Corpo
401	A loja exige login para navegar e a chamada não tem token	`{"error":"shopping_requires_login","message":"this storefront requires login to browse"}`
500	`fbt`: falha ao ler o combo	`{"error":"failed to load combo","detail":"..."}`

track-add é de melhor esforço: responde {"ok": true} mesmo com um id que não existe.