Documentação › Endpoints v1 › Buscar produtos

Buscar produtos

Busca produtos ativos da loja por nome, descrição, SKU ou código de barras — incluindo correspondências nas variantes.

GET https://api.aproveicheckout.com.br/v1/search?q=termo

Autenticação: token Bearer com a ability storefront:read + header X-Store-Slug. Ver autenticação → Limite de 300 requisições/min — ver erros e limites.

Parâmetros de Query

Parâmetro Padrão Descrição
q Obrigatório — Termo de busca (nome, descrição, SKU ou código de barras)
page 1 Página da listagem
per_page 12 Itens por página (máximo 50)

Exemplo de Requisição

cURL
curl --location 'https://api.aproveicheckout.com.br/v1/search?q=camiseta' \
--header 'Authorization: Bearer SEU_TOKEN' \
--header 'X-Store-Slug: SLUG_DA_LOJA'

Resposta

Mesmo formato de Listar produtos (products no formato Objeto Produto + pagination), com o campo extra query ecoando o termo buscado. Quando o termo casa com uma variante específica, o produto pai é retornado apenas com as variantes que corresponderam à busca.

Response 200
{
  "products": [ { "...": "mesmo formato de Listar produtos" } ],
  "pagination": { "page": 1, "per_page": 12, "total": 1, "total_pages": 1 },
  "query": "camiseta"
}