curl --request GET \
--url https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/grouped \
--header 'Authorization: Bearer <token>'import requests
url = "https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/grouped"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/grouped', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/grouped",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/grouped"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/grouped")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/grouped")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"group_by": "order_type",
"groups": [
{
"key": "delivery",
"label": "Delivery",
"total_order_count": 1,
"total_revenue": 60,
"average_order_value": 60
},
{
"key": "takeout",
"label": "Retirada",
"total_order_count": 1,
"total_revenue": 40,
"average_order_value": 40
}
]
}{
"code": 4000,
"message": "Parâmetros inválidos.",
"details": "group_by é obrigatório."
}{
"code": 4010,
"message": "Token inválido"
}This response has no body data.Resumo de pedidos agrupado
Retorna as mesmas métricas do resumo de pedidos, quebradas por uma dimensão: quantidade de pedidos, soma dos valores totais e valor médio do pedido.
O parâmetro group_by é obrigatório. Período e filtros seguem as mesmas regras de GET /orders/summary.
group_by=hour não é permitido quando date_field=scheduled_date (agendamento, campo schedule).
Agrupamentos temporais usam o fuso horário do estabelecimento. Cada grupo traz key (identificador), label (rótulo de exibição) e as métricas. Ao agrupar por driver_id, key contém o ID público do entregador e label contém o nome. Pedidos sem entregador usam key: null e label: "Não informado".
Autenticação: OAuth 2.0 com escopo orders. Não aceita API Key.
Rate limit: 5 requisições por minuto.
Valores de group_by
Temporais: hour, day, day_of_week, week, month.
Categóricos, com os mesmos nomes do pedido: order_type, order_timing, sales_channel, customer_origin, payment_method_id, driver_id, status.
curl --request GET \
--url https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/grouped \
--header 'Authorization: Bearer <token>'import requests
url = "https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/grouped"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/grouped', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/grouped",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/grouped"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/grouped")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/grouped")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"group_by": "order_type",
"groups": [
{
"key": "delivery",
"label": "Delivery",
"total_order_count": 1,
"total_revenue": 60,
"average_order_value": 60
},
{
"key": "takeout",
"label": "Retirada",
"total_order_count": 1,
"total_revenue": 40,
"average_order_value": 40
}
]
}{
"code": 4000,
"message": "Parâmetros inválidos.",
"details": "group_by é obrigatório."
}{
"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
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.
"2025-06-01T00:00:00-03:00"
Fim do período. O intervalo em relação a start_date não pode ultrapassar 6 meses.
"2025-06-30T23:59:59-03:00"
Data do pedido usada no recorte. created_at é a data de criação. scheduled_date é a data de agendamento (schedule).
created_at, scheduled_date Dimensão usada para agrupar as métricas. Envie um único valor.
hour, day, day_of_week, week, month, order_type, order_timing, sales_channel, customer_origin, payment_method_id, driver_id, status Filtros no formato filters[campo_operador]. Mesmas regras de GET /orders/summary.
Esta página foi útil?
