Resumo de pedidos

Totais, ticket médio e série de pedidos da loja num período. O endpoint exige o escopo orders:read.

Obter o resumo#

GET/v1/orders/summary

Retorna os números da loja na janela escolhida e na janela anterior, de mesma duração, para comparar.

Parâmetros de query

periodtoday | 7d | 30dopcionalPadrão: 7d: Janela do resumo. Os dias seguem o fuso America/Sao_Paulo: today começa à meia-noite de hoje, 7d e 30d contam hoje e os dias anteriores.

Campos da resposta

periodstring: O period usado.
fromstring: Início da janela (meia-noite em America/Sao_Paulo). ISO 8601 em UTC.
tostring: Fim da janela (o momento da requisição). ISO 8601 em UTC.
total_orders.currentinteger: Pedidos criados na janela.
total_orders.previousinteger: Pedidos criados na janela anterior, de mesma duração, para comparação.
in_progressinteger: Pedidos em andamento agora (não delivered, returned nem cancelled). Não depende da janela.
average_ticket.currentstring | null: Ticket médio da janela, sem pedidos cancelados. String decimal com 2 casas. null sem pedidos com valor.
average_ticket.previousstring | null: Ticket médio da janela anterior, com a mesma regra.
seriesarray: Pedidos por hora (today) ou por dia (7d, 30d), em ordem crescente. Intervalos sem pedidos voltam com count 0.
series.bucket_startstring: Início do intervalo. ISO 8601 em UTC.
series.countinteger: Pedidos criados no intervalo.
status_breakdownarray: Pedidos da janela por status. Sempre traz os 7 status, inclusive os com count 0.
status_breakdown.statusstring: pending, searching_driver, driver_assigned, picked_up, delivered, returned ou cancelled.
status_breakdown.countinteger: Pedidos da janela com esse status.

GET/v1/orders/summary?period=7d

curl "https://api.movvio.com.br/v1/orders/summary?period=7d" \
  -H "Authorization: Bearer mvk_live_xxx"

Resposta200 OK

{
  "period": "7d",
  "from": "2026-10-25T03:00:00.000Z",
  "to": "2026-10-31T15:00:00.000Z",
  "total_orders": { "current": 84, "previous": 71 },
  "in_progress": 6,
  "average_ticket": { "current": "112.40", "previous": null },
  "series": [{ "bucket_start": "2026-10-25T03:00:00.000Z", "count": 11 }],
  "status_breakdown": [{ "status": "pending", "count": 2 }]
}