Skip to main content
GET
Resumo de pedidos agrupado

Autorizações

Authorization
string
header
obrigatório

Access token OAuth 2.0 de app instalado na CW App Store. Escopo principal: orders. A gestão do entregador também exige drivers.

Parâmetros de consulta

start_date
string
obrigatório

Início do período. Com date_field=created_at, use datetime ISO 8601 com offset. Com date_field=scheduled_date (agendamento, campo schedule), use YYYY-MM-DD.

Exemplo:

"2025-06-01T00:00:00-03:00"

end_date
string
obrigatório

Fim do período. O intervalo em relação a start_date não pode ultrapassar 6 meses.

Exemplo:

"2025-06-30T23:59:59-03:00"

date_field
enum<string>
padrão:created_at

Data do pedido usada no recorte. created_at é a data de criação. scheduled_date é a data de agendamento (schedule).

Opções disponíveis:
created_at,
scheduled_date
group_by
enum<string>
obrigatório

Dimensão usada para agrupar as métricas. Envie um único valor.

Opções disponíveis:
hour,
day,
day_of_week,
week,
month,
order_type,
order_timing,
sales_channel,
customer_origin,
payment_method_id,
driver_id,
status
filters
object

Filtros no formato filters[campo_operador]. Mesmas regras de GET /orders/summary.

Resposta

Métricas agrupadas retornadas com sucesso.

Métricas de pedidos agrupadas por uma dimensão.

group_by
string
obrigatório

Dimensão usada no agrupamento.

groups
OrdersSummaryGroup · object[]
obrigatório

Grupos retornados para a dimensão informada.

Última modificação em 23 de setembro de 2026