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 include disponí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.


Dica: Você também pode consultar os IDs, valores disponíveis para filtros como affiliation_id, product_id, status_id, entre outros, acessando diretamente o endpoint de filtros:

GET https://api.dooki.com.br/v2/{alias}/orders/filters

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 pedidos (/orders)

ParâmetroTipoDescrição
affiliation_id[]arrayAfiliações ou gateways associados ao pedido (ex: Appmax, PagSeguro)
blingstringIndica se o pedido foi enviado ao Bling (sent ou not_sent)
freebie_id[]arrayBrindes associados ao pedido
utm_campaign[]arrayNome da campanha de marketing (UTM Campaign)
channelstringCanal de venda (store, payment_retry)
promocode_id[]arrayCupons de desconto aplicados
date=updated_atdateData da última atualização do pedido Ex: ?date=updated_at:2024-06-01|2024-06-30 ou ?date=updated_at:2024-06-30
date=cancelled_atdateData de cancelamento do pedido Ex: ?date=cancelled_at:2024-06-01|2024-06-30
date=created_atdateData de criação do pedido Ex: ?date=created_at:2024-06-30|2025-06-30 ou ?date=created_at:2024-06-30
date=captured_atdateData de pagamento (captura) do pedido Ex: ?date=captured_at:2024-06-01|2024-06-30
shipping_datedateData de previsão de entrega Ex: ?date=shipping_date:2024-07-01
stock_idintID do estoque de origem do pedido
shipment_service[]arrayForma de entrega utilizada (ex: Correios, transportadora, retirada)
payment_method[]arrayMeio de pagamento (ex: pix, billet, credit_card)
order_bump_id[]arrayOrder Bumps adicionados ao pedido
utm_source[]arrayOrigem da campanha (UTM Source)
product_id[]arrayIDs dos produtos incluídos no pedido
status_id[]arrayStatus atual do pedido (ex: pago, cancelado, entregue, em transporte)
upsell_id[]arrayUpsells adquiridos após o checkout
marketplace_accounts[]arrayLista de IDs de contas de marketplaces conectadas (ex: Mercado Livre).
qstringTermo de busca genérico Ex: ?q=termoquebusca
numberintNúmero exato do pedido.
sync_by_erpboleanIndica se o pedido foi sincronizado com ERP (bling, tiny etc).
gateway_id[]arrayFiltra por gateway específico de pagamento (ex: Appmax, Pagar.me, etc.).

Notas sobre o uso de datas

  • Para buscar pedidos em um intervalo de datas, use:
    ?date=created_at:2024-06-30|2025-06-30
    
  • Para buscar pedidos de uma única data, use:
    ?date=created_at:2024-06-30
    

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

IncludeDescrição
itemsLista de itens do pedido
customerDados completos do cliente
marketplaceInformações do marketplace, se aplicável
statusStatus atual do pedido
statusesHistórico de status do pedido
shipping_addressEndereço de entrega
promocodeCupom de desconto aplicado
transactionsTransações financeiras vinculadas
commentsComentários internos ou visíveis
filesArquivos anexados ao pedido
discountsDescontos aplicados
sellerDados do vendedor (em contexto de marketplace)
labelsEtiquetas associadas ao pedido

Exemplo completo de requisição com filtros e includes

GET {alias}/orders?status_id[]=3&include=customer,items,status&q=cliente123