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

Para você

Devolve um feed de produtos para a página inicial, personalizado pelo interesse do cliente logado ou, sem perfil, com os mais vendidos da loja.

Use esta rota para o carrossel "Para você" da página inicial ou do carrinho. Se a loja ligou a personalização e o cliente está logado com histórico suficiente (ou você envia produtos de referência em seed_ids), o feed vem ordenado pelo interesse dele e source vale profile. Em todos os outros casos, incluindo lojas que não ligaram a personalização, o feed traz os mais vendidos e source vale bestsellers. A rota nunca devolve erro por falta de perfil.

GET/api/v1/storefront/recommendations/for-youPública

Feed Para você

Cabeçalhos

Authorizationstring

Opcional. Bearer $TOKEN de um cliente logado, para usar o histórico dele.

Parâmetros de consulta

limitintegerpadrão: 12

Quantidade de produtos, de 1 a 48. Fora dessa faixa volta a 12.

seed_idsstring

Ids de produtos de referência (UUID), separados por vírgula, por exemplo os últimos produtos que o visitante abriu. Úteis para visitante anônimo.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/recommendations/for-you?limit=8" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feed

json

{
  "products": [
    {
      "id": "83e6c157-293b-4acb-9f11-003a5e17ec5b",
      "name": "Sandália Plus Preto 00109 - PROMOÇÃO",
      "slug": "sandalia-plus-preto-00109-109",
      "price": 2990,
      "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "category_id": "ce181f00-3449-4823-975b-dfcd9701c4b5",
      "image_url": "/uploads/dfe2555e-bfd0-41a8-9fa1-9586999f3798/product/83e6c157-293b-4acb-9f11-003a5e17ec5b/foto.png",
      "rating_avg": 4.4,
      "rating_count": 10,
      "status": "A",
      "score": 0,
      "quantity": 28,
      "track_inventory": true,
      "zero_price_action": "P",
      "out_of_stock_action": "N"
    }
  ],
  "source": "bestsellers",
  "total": 1
}

Campos da resposta

productsarray

Produtos no formato descrito em Buscar produtos: price e list_price em centavos, price_redacted para visitante em loja que esconde preço.

sourcestring

profilebestsellers

profile quando o feed veio do interesse do cliente; bestsellers quando caiu nos mais vendidos.

totalinteger

Quantidade de produtos devolvidos (não é o total do catálogo).

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"}`

Veja também