Pedido
Visão Geral
Filtros e includes disponíveis para consulta dos pedidos em /orders
Introdução
Esta página documenta os filtros e os includes disponíveis para as rotas GET /orders.
Esses parâmetros permitem que você refine suas consultas e enriqueça a resposta da API com dados relacionados, otimizando o consumo e reduzindo a quantidade de requisições necessárias.
Você encontrará aqui:
- Descrição de cada filtro suportado (por status, canal, UTM, afiliado, produto etc).
- Parâmetros
includedisponíveis para expandir a resposta com entidades relacionadas (cliente, itens, transações, status 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 pedidos e documentação de consulta em um pedido específico focando exclusivamente na qualidade das requisições.
Filtros disponíveis para a consulta geral de pedidos (/orders)
| Parâmetro | Tipo | Descrição |
|---|---|---|
status_id[] | array | Retorna pedidos com os status informados. Exemplo: ?status_id[]=3&status_id[]=4 |
q | string | Busca por número, código de rastreio, nome do cliente, CPF/CNPJ, e-mail do cliente ou ID da transação |
channel | string | Canal de venda. Valores aceitos: store ou marketplace |
affiliation_id[] | array | Filtra pedidos realizados em afiliações específicas |
utm_campaing[] | array | Filtra pedidos por utm_campaign |
utm_source[] | array | Filtra pedidos por utm_source |
product_id[] | array | Filtra pedidos por produtos específicos |
promocode_id[] | array | Filtra pedidos por cupons de desconto específicos |
Includes disponíveis para nas rotas de pedidos (/orders e /orders{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=customer,items,status
| Include | Descrição |
|---|---|
items | Lista de itens do pedido |
customer | Dados completos do cliente |
marketplace | Informações do marketplace, se aplicável |
status | Status atual do pedido |
statuses | Histórico de status do pedido |
shipping_address | Endereço de entrega |
promocode | Cupom de desconto aplicado |
transactions | Transações financeiras vinculadas |
comments | Comentários internos ou visíveis |
files | Arquivos anexados ao pedido |
discounts | Descontos aplicados |
seller | Dados do vendedor (em contexto de marketplace) |
labels | Etiquetas associadas ao pedido |