{
"orders": [
{
"id": 7637457,
"status": "closed",
"order_type": "takeout",
"order_timing": "immediate",
"sales_channel": "portal",
"created_at": "2023-06-23T15:23:19.813-03:00",
"updated_at": "2023-06-23T15:43:16.539-03:00"
}
],
"pagination": {
"current_page": 123,
"total_pages": 123,
"total_orders": 123
}
}{
"code": 4000,
"message": "Parâmetros inválidos",
"details": "updated_since não é uma data válida"
}{
"code": 4010,
"message": "Token inválido"
}This response has no body data.Histórico de pedidos
Retorna os pedidos concluídos e cancelados do estabelecimento que foram criados dentro de um período especificado. O início desse período não pode retroceder mais de um ano, e a duração do período não pode exceder seis meses.
Esse endpoint possui paginação, onde os parâmetros ‘page’ e ‘per_page’ controlam a paginação, com um limite máximo de 100 pedidos por página.
Esse endpoint fornece informações básicas sobre os pedidos, para obter informações mais detalhadas sobre cada pedido individualmente, utilize o endpoint designado para isso. Lembre-se de considerar o limite de requisições (rate limit) ao consultar os detalhes dos pedidos.
O limite de requisições desse endpoint de histórico de pedidos é diferente dos demais, sendo limitado a 5 requisições por minuto.
Pedidos recebidos através de integrações como o iFood também são retornados nesse endpoint.
{
"orders": [
{
"id": 7637457,
"status": "closed",
"order_type": "takeout",
"order_timing": "immediate",
"sales_channel": "portal",
"created_at": "2023-06-23T15:23:19.813-03:00",
"updated_at": "2023-06-23T15:43:16.539-03:00"
}
],
"pagination": {
"current_page": 123,
"total_pages": 123,
"total_orders": 123
}
}{
"code": 4000,
"message": "Parâmetros inválidos",
"details": "updated_since não é uma data válida"
}{
"code": 4010,
"message": "Token inválido"
}This response has no body data.Autorizações
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
Data de início do período para filtrar os pedidos com base na data de criação, com a possibilidade de retroceder no máximo 3 anos a partir da data atual.
"2023-01-01T00:00:00-03:00"
Data de término do período para filtrar os pedidos com base na data de criação, assegurando que o intervalo não ultrapasse 6 meses.
"2023-06-30T23:59:59-03:00"
Retorna apenas os pedidos com os status especificados. Para filtrar mais de um status na mesma requisição faça: status[]=closed&status[]=canceled.
closed, canceled x >= 11 <= x <= 100Resposta
Retorna um array com os pedidos encontrados.
Para obter mais detalhes sobre a estrutura de um pedido, consulte nossa seção exclusiva sobre o assunto.
Esta página foi útil?