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

Produtos parecidos

Devolve produtos parecidos com um produto, para a seção "Você também pode gostar" da página do produto.

Use esta rota na página de um produto para sugerir alternativas. A plataforma procura os produtos mais próximos em sentido (nome, descrição e características). Quando o produto ainda não tem essa análise, ou a loja não usa busca semântica, a rota cai para os produtos que outros clientes viram junto com ele (veja Quem viu também viu). O campo source diz de onde vieram.

Os resultados passam pelas mesmas regras de visibilidade da busca: não aparecem produtos escondidos, de seller inativo ou sem preço (quando a loja esconde preço zero). O próprio produto nunca vem na lista.

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

Produtos parecidos com um produto

Parâmetros de caminho

iduuidobrigatório
Id do produto.

Parâmetros de consulta

limitintegerpadrão: 8
Quantidade de produtos, de 1 a 24. Fora dessa faixa volta a 8.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/storefront/products/db033935-75ea-4b6f-abbb-13d0fcd6386d/similar?limit=4"

Resposta

200Produtos parecidos
json
{
  "products": [
    {
      "id": "b7ea3cae-d4d3-4dd2-bfcd-f6a9ec0cc8b0",
      "name": "Camiseta Pro Verde 01968",
      "slug": "camiseta-pro-verde-01968-1968",
      "price": 80990,
      "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "category_id": "8fcaf422-1631-4282-b503-85cc57380649",
      "rating_avg": 4.9,
      "rating_count": 3,
      "status": "A",
      "quantity": 19,
      "track_inventory": true
    }
  ],
  "source": "vector"
}

Campos da resposta

productsarray
Produtos no formato descrito em Buscar produtos (price em centavos, price_redacted para visitante em loja que esconde preço). Vazia quando não há sugestões.
sourcestring
vectoralso_viewed
vector quando vieram da semelhança de sentido; also_viewed quando caíram para "quem viu também viu". Na origem also_viewed o item traz menos campos (sem estoque, vendedor e categoria).

Erros

StatusQuandoCorpo
401A loja exige login para navegar e a chamada não tem token{"error":"shopping_requires_login","message":"this storefront requires login to browse"}

Um id que não existe não dá 404: a resposta é 200 com products: [] e source: "also_viewed".

Esconda a seção quando vier vazia

Como um id inexistente e um produto sem vizinhos respondem igual (lista vazia), não mostre o título "Produtos parecidos" sem itens.

Veja também

  • Quem comprou também levou
  • Compre junto
  • Buscar produtos
Anterior
Termos em alta
Próxima
Recomendações e compartilhamento
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também