curl --request GET \
--url https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/options \
--header 'Authorization: Bearer <token>'import requests
url = "https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/options"
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/options', 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/options",
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/options"
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/options")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/options")
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{
"data": [
{
"option_id": 142,
"name": "Bacon",
"external_code": "BACON",
"option_group_id": 44476,
"option_group_name": "Adicionais pagos",
"total_quantity": 6,
"total_revenue": 24,
"average_price": 4
}
],
"meta": {
"page": 1,
"per_page": 20,
"total": 1,
"total_pages": 1
},
"totals": {
"total_quantity": 6,
"total_revenue": 24
}
}{
"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.Ranking de vendas por opção
Retorna as opções vendidas no período, com quantidade, faturamento e preço médio. Para calcular a quantidade, a API multiplica a quantidade do item pela quantidade da opção. A resposta inclui os totais de todo o conjunto filtrado, independentemente da página atual.
Use item_id e option_group_id para limitar o resultado. Use search_text para buscar pelo nome ou código externo resolvido da opção. A busca considera o cadastro atual e o histórico gravado no pedido.
Autenticação: OAuth 2.0 com escopo orders. Não aceita API Key.
Rate limit: 5 requisições por minuto para este endpoint.
Período e filtros de pedidos
start_date, end_date, date_field e filters seguem as mesmas regras do resumo de pedidos. Os filtros aceitam order_type, order_timing, sales_channel, status, payment_method_id, driver_id, customer_origin, created_at_time, total e delivery_fee, combinados com os operadores permitidos no resumo.
Pedidos cancelados entram no ranking por padrão. Use filters[status_not_in]=canceled para removê-los. Itens cancelados dentro de um pedido nunca entram no cálculo.
Filtro por entregador
Use filters[driver_id_in][]=12 para incluir os pedidos do entregador 12 ou filters[driver_id_not_in][]=12 para excluí-los. Para informar vários IDs, repita o parâmetro com []. Envie apenas IDs inteiros positivos; valores inválidos retornam 400.
GET /api/partner/v1/orders/summary/options?start_date=2026-09-01T00:00:00-03:00&end_date=2026-09-10T23:59:59-03:00&filters[driver_id_in][]=12
O filtro restringe os pedidos usados nas linhas do ranking e em totals. A consulta considera apenas pedidos do seu estabelecimento. A inclusão de um entregador de outro estabelecimento retorna uma lista vazia.
O resultado continua agrupado por opção. Não envie group_by=driver_id neste endpoint. Para agrupar pedidos por entregador, use GET /orders/summary/grouped.
curl --request GET \
--url https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/options \
--header 'Authorization: Bearer <token>'import requests
url = "https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/options"
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/options', 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/options",
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/options"
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/options")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders/summary/options")
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{
"data": [
{
"option_id": 142,
"name": "Bacon",
"external_code": "BACON",
"option_group_id": 44476,
"option_group_name": "Adicionais pagos",
"total_quantity": 6,
"total_revenue": 24,
"average_price": 4
}
],
"meta": {
"page": 1,
"per_page": 20,
"total": 1,
"total_pages": 1
},
"totals": {
"total_quantity": 6,
"total_revenue": 24
}
}{
"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
Início do período. Use datetime ISO 8601 com offset para created_at ou YYYY-MM-DD para scheduled_date.
"2025-06-01T00:00:00-03:00"
Fim do período. O intervalo não pode ultrapassar 6 meses.
"2025-06-30T23:59:59-03:00"
Data do pedido usada no recorte.
created_at, scheduled_date 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.
Show child attributes
Show child attributes
ID público do item.
x >= 1ID público do option_group.
x >= 1Busca parcial sem diferenciação entre maiúsculas e minúsculas.
Número da página.
x >= 1Quantidade de registros por página.
1 <= x <= 100Métrica ou nome usado para ordenar o ranking.
total_revenue, total_quantity, average_price, name Direção da ordenação. O padrão é desc, ou asc quando order_by=name.
asc, desc Esta página foi útil?
