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

Termos em alta

Lista os termos mais buscados na loja nos últimos 7 dias, para mostrar como "buscas populares" quando o campo de busca está vazio.

Use esta rota para preencher o menu que abre quando o cliente clica no campo de busca e ainda não digitou nada ("Em alta", "Buscas populares"). A lista vem das buscas reais da loja: só entram termos buscados 5 vezes ou mais nos últimos 7 dias que encontraram produtos na maioria das vezes. Uma loja nova ou com pouco tráfego devolve lista vazia.

A rota nunca falha por falta de dados: sempre responde 200, com a lista possivelmente vazia.

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

Termos de busca em alta

Parâmetros de consulta

limitintegerpadrão: 6
Quantidade de termos, de 1 a 20. Fora dessa faixa volta a 6.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/storefront/search/trending?limit=6"

Resposta

200Termos em alta
json
{ "terms": [{ "term": "camiseta", "searches": 9 }] }

Campos da resposta

termsarray
Termos do mais para o menos buscado. Vazia quando nenhum termo atinge o mínimo.
terms[].termstring
O termo, já normalizado (minúsculas, sem acento).
terms[].searchesinteger
Quantas vezes foi buscado nos últimos 7 dias.

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"}
A lista é atualizada a cada 10 minutos

A plataforma guarda o resultado por 10 minutos por loja, além do cache de 5 minutos da própria resposta. Um termo que acabou de ganhar força pode levar alguns minutos para aparecer. Como o termo vem normalizado, ao exibi-lo coloque a primeira letra em maiúscula se quiser, mas busque sempre com o valor original.

Veja também

  • Busca ao vivo
  • Buscar produtos
Anterior
Busca ao vivo
Próxima
Produtos parecidos
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também