BeeFoodDevelopers
Entrar ou criar acesso

Resumo agrupado

GET
Markdown (LLM)

As métricas do resumo, quebradas por uma dimensão.

Escopo:orders:read

Limite:15 requisições por minuto.

Parâmetros de query

groupBystring

Dimensão do agrupamento.

Enum

  • hourHora do pedido
  • dayDia do pedido
  • dayOfWeekDia da semana
  • weekSemana do pedido
"orderType"
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

groupBystring

Dimensão usada.

Enum

  • hourHora do pedido
  • dayDia do pedido
  • dayOfWeekDia da semana
  • weekSemana do pedido
"orderType"

Filtros

Os filtros usam o formato campo=operador:valor1,valor2 (in ou notIn). Regras e exemplos em Resumo de pedidos.