Visão Geral
Filtros e includes disponíveis para consulta de produtos em /products
Introdução
Esta página documenta os filtros e os includes disponíveis para as rotas GET /products.
Esses parâmetros permitem que você refine suas consultas por marca, categoria, selo e coleção, além de enriquecer a resposta da API com dados relacionados como imagens, variações, atributos, SEO e outros elementos importantes para uso em lojas e marketplaces.
Você encontrará aqui:
- Descrição dos filtros suportados (marca, categoria, selo, coleção).
- Parâmetros
includedisponíveis para expandir a resposta com entidades relacionadas (marca, variações, imagens, atributos de busca etc). - Exemplos práticos de uso combinando filtros e includes.
Esta página é uma introdução às páginas de documentação de consulta no endpoint de produtos e documentação de consulta em um produto específico, com foco na qualidade e personalização das requisições.
Filtros disponíveis para a consulta geral de produtos (/products)
| Parâmetro | Tipo | Descrição |
|---|---|---|
brand_id[] | array | Array de IDs de marcas |
category_id[] | array | Array de IDs de categorias |
flag_id[] | array | Array de IDs de selos |
collection_id[] | array | Array de IDs de coleções |
Includes disponíveis nas rotas de produtos (/products e /products/{id})
Use o parâmetro include para retornar dados relacionados no mesmo payload da resposta.
Você pode incluir múltiplos valores separados por vírgula, por exemplo:
?include=brand,images,skus
| Include | Descrição |
|---|---|
dates | Datas relevantes do produto |
brand | Informações da marca |
extras | Dados extras vinculados ao produto |
texts | Campos de texto adicionais |
seo | Informações de SEO do produto |
filters | Filtros configurados para o produto |
flags | Selos aplicados |
variations | Variações do produto (ex: tamanho, cor) |
categories | Categorias associadas |
images | Todas as imagens do produto |
skus | SKUs associados ao produto |
firstImage | Primeira imagem do produto |
searchAttributes | Atributos usados na busca e navegação |
reviews | Avaliações e reviews do produto |
combos | Combos que incluem este produto |