Resumo de pedidos

GET

Markdown (LLM)

Retorna quantidade, faturamento e ticket médio dos pedidos do período, sem a lista.

Escopo:orders:read

Limite:15 requisições por minuto.

Parâmetros de query

saleDateFromstring (yyyy-mm-dd)

Início do período da data de venda. O intervalo entre saleDateFrom e saleDateTo não pode passar de 6 meses.

"2026-03-01"

saleDateTostring (yyyy-mm-dd)

Fim do período da data de venda. O intervalo entre saleDateFrom e saleDateTo não pode passar de 6 meses.

"2026-03-31"

orderTypestring

Tipo do pedido. Formato `in:v1,v2` ou `notIn:v1,v2`; sem operador vale `in`.

Enum

DELIVERYPedido delivery
PDVPedido lançado no PDV
TABLEMesa / presencial

"DELIVERY"

orderStatusstring

Status do pedido; sem filtro, entram OPEN, RECEIVED e CLOSED. Formato `in:v1,v2` ou `notIn:v1,v2`; sem operador vale `in`.

Enum

OPENAberto
RECEIVEDRecebido
GROUPEDAgrupado a outro pedido
CLOSEDFechado

"OPEN"

deliveryTypestring

Modalidade da entrega. Formato `in:v1,v2` ou `notIn:v1,v2`; sem operador vale `in`.

Enum

DELIVERYEntrega
TAKEOUTRetirada
DINE_INConsumo no local

"DELIVERY"

deliveryStatusstring

Status da entrega. Formato `in:v1,v2` ou `notIn:v1,v2`; sem operador vale `in`.

Enum

WAITINGAguardando
ACCEPTEDAceito
PREPARINGEm preparo
READYPronto

"WAITING"

salesChannelstring

Canal de venda. Formato `in:v1,v2` ou `notIn:v1,v2`; sem operador vale `in`.

Enum

IFOODiFood
99FOOD99Food
KEETAKeeta
AIQFOMEAiqfome

"IFOOD"

merchantIdstring

IDs de filial (inteiros maior ou igual a 1). Formato `in:v1,v2` ou `notIn:v1,v2`; sem operador vale `in`.

"in:10,11"

customerIdstring

IDs de cliente (inteiros maior ou igual a 1). Formato `in:v1,v2` ou `notIn:v1,v2`; sem operador vale `in`.

"notIn:77"

documentNumberstring

CPF/CNPJ; só os dígitos contam. Formato `in:v1,v2` ou `notIn:v1,v2`; sem operador vale `in`.

"in:12345678900"

emailstring

E-mail do cliente, sem diferenciar maiúsculas. Formato `in:v1,v2` ou `notIn:v1,v2`; sem operador vale `in`.

"in:ana@exemplo.com,bia@exemplo.com"

phonestring

Telefone do cliente; só dígitos, busca por trecho. Formato `in:v1,v2` ou `notIn:v1,v2`; sem operador vale `in`.

"in:11999990000"

couponCodestring

Código do cupom, sem diferenciar maiúsculas. Formato `in:v1,v2` ou `notIn:v1,v2`; sem operador vale `in`.

"notIn:BEMVINDO"

commandCodeinteger | integer[]

Filtra pelo código da comanda.

12

tableCodeinteger | integer[]

Filtra pelo código da mesa.

5

Parâmetros da resposta

orderCountinteger

Quantidade de pedidos.

2

totalRevenuenumber

Soma de orderAmount, 2 casas.

150

averageOrderValuenumber

Ticket médio; 0 sem pedidos.

75

Filtros

Todo filtro segue o formato campo=operador:valor1,valor2. Sem operador, vale in: orderStatus=OPEN,CANCELLED é o mesmo que orderStatus=in:OPEN,CANCELLED.

Operador	Significado	Exemplo
`in` (padrão)	o campo é um dos valores (OU)	`orderStatus=in:OPEN,CANCELLED`
`notIn`	o campo não é nenhum dos valores	`orderStatus=notIn:CLOSED,RECEIVED`

Campos: orderStatus, orderType, deliveryType, deliveryStatus, salesChannel, customerId, merchantId, documentNumber, email, phone e couponCode — todos aceitam in e notIn.

Regras

Cada campo aparece uma vez só; chave repetida responde 400. Por isso não dá para usar in e notIn no mesmo campo.
A vírgula sempre separa valores; não é possível filtrar um valor com vírgula.
O operador é o trecho antes do primeiro :. Para um valor com :, informe o operador: couponCode=in:PROMO:10.
Operador e enums não diferenciam maiúsculas (IN:open = in:OPEN).
Valor vazio (orderStatus= ou orderStatus=in:) equivale a não enviar o filtro.
Valores do mesmo campo combinam com OU; campos diferentes, com E.
notIn em customerId, documentNumber, email, phone e couponCode mantém pedidos sem cliente ou sem cupom.

Status do pedido

Sem orderStatus, entram só OPEN, RECEIVED e CLOSED.
orderStatus=in:… substitui o padrão; orderStatus=notIn:… parte de todos os status.
Pedidos GROUPED nunca entram.

Exemplos de filtros

GET /v1/orders/summary?saleDateFrom=2026-09-01&saleDateTo=2026-09-30&orderType=DELIVERY — in implícito: só pedidos de delivery.

GET /v1/orders/summary?saleDateFrom=2026-09-01&saleDateTo=2026-09-30&orderStatus=in:OPEN,CANCELLED — pedidos abertos ou cancelados.

GET /v1/orders/summary?saleDateFrom=2026-09-01&saleDateTo=2026-09-30&orderStatus=notIn:CANCELLED — todos os status menos cancelados.

GET /v1/orders/summary?saleDateFrom=2026-09-01&saleDateTo=2026-09-30&salesChannel=notIn:IFOOD,99FOOD — todos os canais menos iFood e 99Food.

GET /v1/orders/summary/grouped?saleDateFrom=2026-09-01&saleDateTo=2026-09-30&groupBy=salesChannel&orderType=in:DELIVERY&deliveryStatus=notIn:CANCELLED — delivery e não cancelado na entrega, agrupado por canal.

GET /v1/orders/summary/sectors?saleDateFrom=2026-09-01&saleDateTo=2026-09-30&merchantId=in:10,11&customerId=notIn:77 — filial 10 ou 11, e cliente diferente de 77.

Quero → Query

Quero	Query
Padrão (abertos, recebidos e fechados)	sem `orderStatus`
Só cancelados	`orderStatus=CANCELLED`
Abertos e cancelados	`orderStatus=in:OPEN,CANCELLED`
Tudo, inclusive cancelados	`orderStatus=in:OPEN,RECEIVED,CLOSED,CANCELLED`
Tudo menos cancelados	`orderStatus=notIn:CANCELLED`
Delivery, exceto iFood e 99Food	`orderType=DELIVERY&salesChannel=notIn:IFOOD,99FOOD`
Duas filiais	`merchantId=in:10,11`
Todas as filiais menos uma	`merchantId=notIn:12`
Pedidos sem o cupom X	`couponCode=notIn:BEMVINDO`