Skip to main content
GET
Ranking de vendas por item

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. Use datetime ISO 8601 com offset para created_at ou YYYY-MM-DD para scheduled_date.

Exemplo:

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

end_date
string
obrigatório

Fim do período. O intervalo 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.

Opções disponíveis:
created_at,
scheduled_date
filters
object

Filtros do pedido no formato plano filters[campo_operador]. Para entregadores, use driver_id_in ou driver_id_not_in com IDs públicos positivos. Não coloque filtros do catálogo dentro deste objeto. Para listas, use filters[driver_id_in][]=12&filters[driver_id_in][]=15 ou filters[driver_id_not_in][]=12. Os filtros afetam também os totais; não alteram a dimensão do ranking.

category_id
integer

ID público da categoria.

Intervalo obrigatório: x >= 1
search_text
string

Busca parcial sem diferenciação entre maiúsculas e minúsculas.

page
integer
padrão:1

Número da página.

Intervalo obrigatório: x >= 1
per_page
integer
padrão:20

Quantidade de registros por página.

Intervalo obrigatório: 1 <= x <= 100
order_by
enum<string>
padrão:total_revenue

Métrica ou nome usado para ordenar o ranking.

Opções disponíveis:
total_revenue,
total_quantity,
average_price,
name
order
enum<string>

Direção da ordenação. O padrão é desc, ou asc quando order_by=name.

Opções disponíveis:
asc,
desc

Resposta

Ranking de itens retornado com sucesso.

data
Venda por item · object[]
obrigatório
meta
Paginação do ranking · object
obrigatório
totals
Totais do ranking · object
obrigatório
Última modificação em 23 de setembro de 2026