Como buscar estatísticas consolidadas de pedidos

Este tutorial apresenta o uso do endpoint de estatísticas resumidas de pedidos, permitindo que você busque informações importantes para o acompanhamento de metas, como valores totais, ticket médio, pedidos faturados e muito mais. 

1- Visão Geral do Endpoint 

O endpoint http://api.uoou.com.br/api/v1/orders/stats/summary é utilizado para retornar informações consolidadas dos pedidos com base em filtros aplicados. Ele é ideal para monitorar métricas de desempenho em tempo real. 

 Obs.: Para autenticar sua requisição inclua no Headers os token e channelCode do canal.
Documentação Oficial 

2- Informações Retornadas pelo Endpoint 

Ao consultar o endpoint, as seguintes informações serão retornadas: 

• Estatísticas Gerais: 
  • Soma da quantidade total de pedidos. 
  • Soma do valor total de pedidos. 
  • Ticket médio (valor médio por pedido). 
  • Maior valor de pedido. 
  • Menor valor de pedido.

Ou

• Estatísticas dos Pedidos Uoou (E-commerce): 
  • Soma total da quantidade de pedidos Uoou. 
  • Soma total do valor de pedidos Uoou. 
  • Ticket médio dos pedidos Uoou. 
  • Maior valor de pedido Uoou. 
  • Menor valor de pedido Uoou. 

Ou

• Estatísticas dos Marketplaces: 
  • Soma total da quantidade de pedidos dos marketplaces. 
  • Soma total do valor de pedidos dos marketplaces. 
  • Ticket médio dos pedidos dos marketplaces. 
  • Maior valor de pedido dos marketplaces. 
  • Menor valor de pedido dos marketplaces. 

3- Como Aplicar Filtros no Endpoint 

Os filtros permitem personalizar a busca e segmentar os dados de forma detalhada, que podem ser utilizados através de parâmetros da requisição. 

Filtros Disponíveis: 

• Filtro por período
  • Data de início=>     criteria[completedAtFrom]=2023-10-01 
  • Data de fim=>     criteria[completedAtTo]=2023-10-31 
• Status do pedido: 
  • Pedidos pendentes=>     criteria[saleReportState][]=pending 
  • Pedidos pagos=>     criteria[saleReportState][]=paid 
  • Pedidos cancelados=>     criteria[saleReportState][]=cancelled 
• Origem dos pedidos: 
  • Uoou (E-commerce)=>     criteria[origin][]=1 
  • Marketplace=>     criteria[origin][]=2 

4- Exemplo de Requisição 

Aqui está um exemplo de como realizar uma requisição ao endpoint utilizando os filtros mencionados. 

Requisição:

GET http://api.uoou.com.br/api/v1/orders/stats/summary?criteria[completedAtFrom]=2023-10-01&criteria[completedAtTo]=2023-10-31&criteria[saleReportState][]=paid&criteria[origin][]=1 

Exemplo de resposta:

Exemplo de Consultar a soma total de pedidos Uoou + Marketplaces: 

Basta não informar o filtro de origem 

Requisição:

GET: http://api.uoou.com.br/api/v1/orders/stats/summary?criteria[completedAtFrom]=2023-10-01&criteria[completedAtTo]=2023-10-31 

Exemplo de resposta:

Este filtro se iguala aos filtros da tela de pedido no painel administrativo. 

Exemplo de como Consultar Pedidos Uoou + Marketplace apenas pedidos Pagos do período: 

Utilizar o parâmetro criteria[saleReportState][]=paid 

GET: http://api.uoou.com.br/api/v1/orders/stats/summary?criteria[completedAtFrom]=2023-10-01&criteria[completedAtTo]=2023-10-31&criteria[saleReportState][]=paid

Exemplo de resposta:

Igual a esse filtro: 

Exemplo de como Consultar apenas Pedidos feitas na Uoou - Origem E-commerce: 

Utilizar o parâmetro de criteria[origin][]=1 (1 = E-commerce) 

GET: http://api.uoou.com.br/api/v1/orders/stats/summary?criteria[completedAtFrom]=2023-10-01&criteria[completedAtTo]=2023-10-31&criteria[origin][]=1 

Exemplo de resposta:

Igual esse filtro 

Exemplo de como Consultar apenas Pedidos feitas na Uoou - Origem Marketplace: 

Utilizar o parâmetro de criteria[origin][]=2 (2 = Marketplace) 

GET: http://api.uoou.com.br/api/v1/orders/stats/summary?criteria[completedAtFrom]=2023-10-01&criteria[completedAtTo]=2023-10-31&criteria[origin][]=2

Exemplo de resposta:

Igual ao filtro: 

Para saber o valor pago dos pedidos de Marketplace ou da Uoou basta adicionar o parâmetro criteria[saleReportState][]=paid

GET: http://api.uoou.com.br/api/v1/orders/stats/summary?criteria[completedAtFrom]=2023-10-01&criteria[completedAtTo]=2023-10-31&criteria[origin][]=2&criteria[saleReportState][]=paid 

Exemplo de resposta:

Para mais informações sobre outro endpoints úteis acesse nossa documentação oficial.