Sugestões

Devolve até 20 nomes de produtos para completar o texto do campo de busca enquanto o cliente digita.

Use esta rota quando só precisa de uma lista curta de produtos para o autocompletar, com nome, imagem e preço, sem categorias, marcas e sellers. Para o menu completo use Busca ao vivo. Em lojas com Meilisearch, a lista vem do índice; nas demais, vem da busca ao vivo da loja, com as mesmas regras (mínimo de caracteres, busca ao vivo ligada ou desligada, visibilidade). Se a loja desligou a busca ao vivo, a lista vem vazia.

A rota nunca devolve erro por falta de recurso: no pior caso responde 200 com suggestions: [].

GET/api/v1/storefront/search/suggestPública

Sugestões de busca

Parâmetros de consulta

qstring

Texto digitado. Vazio devolve lista vazia.

limitintegerpadrão: 10

Quantidade de sugestões. Em lojas com Meilisearch vai de 1 a 20 e, fora dessa faixa, volta a 10. Nas demais lojas o valor é usado como está.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/search/suggest?q=cam&limit=5"

Resposta

200Sugestões

json

{
  "query": "cam",
  "suggestions": [
    {
      "text": "Camiseta Lite Verde 00146",
      "type": "product",
      "id": "db033935-75ea-4b6f-abbb-13d0fcd6386d",
      "slug": "camiseta-lite-verde-00146-146",
      "image_url": "/uploads/dfe2555e-bfd0-41a8-9fa1-9586999f3798/product/db033935-75ea-4b6f-abbb-13d0fcd6386d/foto.png",
      "price": 39990
    }
  ]
}

Campos da resposta

querystring

O texto recebido.

suggestionsarray

Sugestões, da mais relevante para a menos.

suggestions[].textstring

Texto para mostrar e para preencher o campo.

suggestions[].typestring

product

Tipo da sugestão. Hoje sempre product.

suggestions[].iduuid

Id do produto.

suggestions[].slugstring

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

suggestions[].image_urlstring

Caminho da imagem, quando há.

suggestions[].priceinteger

Preço em centavos. 0 com price_redacted: true para visitante em loja que esconde preço.

suggestions[].price_redactedboolean

true quando o preço foi escondido.

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	Em lojas com Meilisearch, o mecanismo falhou	`{"error":"suggest failed","detail":"..."}`

Veja também