Pedidos por status

Quantos pedidos a loja tem em cada status, de todos os tempos.

Use para montar um funil ou um gráfico de pizza de pedidos por situação. A contagem não tem filtro de datas: considera todos os pedidos da loja. A rota /analytics/orders é um apelido da rota principal e devolve os mesmos dados dentro de outra chave.

Pedidos por status

GET/api/v1/admin/analytics/orders-by-statusAdmin

Contagem de pedidos por status

Exemplo de requisição (principal)

bash

curl "$BASE_URL/api/v1/admin/analytics/orders-by-status" \
  -H "Authorization: Bearer $TOKEN"

Resposta (principal)

200Contagem retornada

json

{
  "statuses": [
    { "status": "C", "code": "delivered", "name": "Entregue", "type": "complete", "count": 36900 },
    { "status": "O", "code": "pending", "name": "Pendente", "type": "initial", "count": 146 }
  ]
}

Campos da resposta

statusesarray

Um item por status que tem pelo menos um pedido, do mais frequente para o menos.

statuses[].statusstring

A letra guardada no pedido (O, P, C...). A letra é definida por loja.

statuses[].codestring

Código do status no cadastro da loja (pending, delivered...). Vazio se a letra não existe no cadastro.

statuses[].namestring

Nome de exibição em português.

statuses[].typestring

Fase do ciclo de vida: initial, processing, shipped, complete, cancelled, refunded, entre outras definidas pela loja.

statuses[].countinteger

Quantidade de pedidos nesse status, de todos os tempos.

Erros (principal)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem o privilégio exigido.	`{"error":"insufficient privileges","required":"view_reports"}`
403	O módulo está desligado na loja.	`{"error":"module_disabled","module":"analytics"}`
500	Falha ao consultar os dados.	`{"error":"failed to ..."}`

Apelido `orders`

GET/api/v1/admin/analytics/ordersAdmin

Apelido de pedidos por status

Exemplo de requisição (apelido)

bash

curl "$BASE_URL/api/v1/admin/analytics/orders" \
  -H "Authorization: Bearer $TOKEN"

Resposta (apelido)

200Contagem retornada

json

{
  "orders_by_status": [
    { "status": "C", "code": "delivered", "name": "Entregue", "type": "complete", "count": 36900 },
    { "status": "O", "code": "pending", "name": "Pendente", "type": "initial", "count": 146 }
  ]
}

Campos da resposta

orders_by_statusarray

Um item por status que tem pelo menos um pedido, do mais frequente para o menos.

orders_by_status[].statusstring

A letra guardada no pedido (O, P, C...). A letra é definida por loja.

orders_by_status[].codestring

Código do status no cadastro da loja (pending, delivered...). Vazio se a letra não existe no cadastro.

orders_by_status[].namestring

Nome de exibição em português.

orders_by_status[].typestring

Fase do ciclo de vida: initial, processing, shipped, complete, cancelled, refunded, entre outras definidas pela loja.

orders_by_status[].countinteger

Quantidade de pedidos nesse status, de todos os tempos.

Erros (apelido)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem o privilégio exigido.	`{"error":"insufficient privileges","required":"view_reports"}`
403	O módulo está desligado na loja.	`{"error":"module_disabled","module":"analytics"}`
500	Falha ao consultar os dados.	`{"error":"failed to ..."}`

Veja também

Pedidos por status

Quantos pedidos a loja tem em cada status, de todos os tempos.