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
include
disponí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.
Dica: Você também pode consultar os IDs, valores disponíveis para os filtros como
quality
,category_id
,active
, entre outros, acessando diretamente o endpoint de filtros:
Esse endpoint retorna a estrutura completa de filtros, incluindo rótulos, valores disponíveis e parâmetros, permitindo que você construa consultas dinâmicas e com mais precisão.
Filtros disponíveis para a consulta geral de produtos (/products
)
Parâmetro | Tipo | Descrição |
---|---|---|
[category_id] | array | Filtra pelos IDs das categorias dos produtos. |
[collection_id] | array | Filtra pelos IDs das coleções dos produtos. |
customization | string | Filtra produtos que 1 (Contém) ou 0 (Não contém) customizações. |
date | date | Filtra pela data de criação no formato ?date=created_at:YYYY-MM-DD|YYYY-MM-DD . |
custom_shipping | string | Filtra produtos com frete customizado: 1 (Sim), 0 (Não). |
[brand_id] | array | Filtra pelos IDs das marcas dos produtos. |
quality | string | Filtra por qualidade dos produtos. Valores possíveis: |
with_description , without_description , with_seo_title , without_seo_title , | ||
with_seo_description , without_seo_description , with_seo_keywords , without_seo_keywords , | ||
with_images , without_images , with_skus , without_skus , | ||
with_barcode , without_barcode , with_dimensions , without_dimensions , | ||
with_weight , without_weight , with_filters , without_filters , | ||
with_price , without_price , with_erp_code , without_erp_code , | ||
with_categories , without_categories , with_no_stock , with_one_stock | ||
priority | string | Filtra por relevância do produto: 1 (Padrão), 2 (Média), 3 (Alta). |
[flag_id] | array | Filtra pelos IDs dos selos aplicados ao produto. |
active | string | Filtra status: 1 para produtos ativos, 0 para inativos. |
variations_type | string | Filtra produtos com variantes: 1 (Com variantes), 0 (Sem variantes). |
Notas adicionais:
- Parâmetros marcados como
array
aceitam múltiplos valores, usando o formatoparam[]=valor1¶m[]=valor2
. - O parâmetro
date
deve ser usado com o formatodate=created_at:YYYY-MM-DD
para uma data única, oudate=created_at:YYYY-MM-DD|YYYY-MM-DD
para intervalo. - Para
active
,1
significa produtos ativos no sistema,0
produtos desativados. - Para
customization
ecustom_shipping
,1
significa sim,0
significa não.
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 |