curl --request POST \
--url https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"order_id": "PEDIDO_12345",
"display_id": "001",
"created_at": "2025-01-15T14:30:00-03:00",
"observation": "Observação geral sobre o pedido",
"order_type": "delivery",
"customer": {
"phone": "11998989898",
"name": "João Silva",
"email": "joao@email.com",
"document_number": "12345678909"
},
"totals": {
"order_amount": 106,
"delivery_fee": 10,
"additional_fee": 2,
"discounts": 5
},
"delivery_address": {
"state": "CE",
"city": "Fortaleza",
"neighborhood": "Meireles",
"street": "Av. da Abolição",
"number": "2456",
"complement": "Apto 000",
"reference": "Casa de portão verde",
"postal_code": "60125160",
"coordinates": {
"latitude": -3.7263942,
"longitude": -38.4981303
}
},
"items": [
{
"item_id": "PIZZA_001",
"external_code": "SKU_PIZZA_001",
"name": "Pizza Margherita",
"quantity": 2,
"unit_price": 35,
"total_price": 90,
"observation": "Sem cebola",
"options": [
{
"option_id": "OPT_001",
"external_code": "SKU_EXTRA_QUEIJO",
"name": "Extra queijo",
"quantity": 2,
"unit_price": 5
}
]
},
{
"item_id": "BEBIDA_001",
"name": "Coca-Cola 350ml",
"quantity": 2,
"unit_price": 4.5,
"total_price": 9
}
],
"payments": [
{
"total": 56,
"payment_method_id": 102,
"change_for": 100
},
{
"total": 50,
"payment_method_id": 103
}
]
}
'import requests
url = "https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders"
payload = {
"order_id": "PEDIDO_12345",
"display_id": "001",
"created_at": "2025-01-15T14:30:00-03:00",
"observation": "Observação geral sobre o pedido",
"order_type": "delivery",
"customer": {
"phone": "11998989898",
"name": "João Silva",
"email": "joao@email.com",
"document_number": "12345678909"
},
"totals": {
"order_amount": 106,
"delivery_fee": 10,
"additional_fee": 2,
"discounts": 5
},
"delivery_address": {
"state": "CE",
"city": "Fortaleza",
"neighborhood": "Meireles",
"street": "Av. da Abolição",
"number": "2456",
"complement": "Apto 000",
"reference": "Casa de portão verde",
"postal_code": "60125160",
"coordinates": {
"latitude": -3.7263942,
"longitude": -38.4981303
}
},
"items": [
{
"item_id": "PIZZA_001",
"external_code": "SKU_PIZZA_001",
"name": "Pizza Margherita",
"quantity": 2,
"unit_price": 35,
"total_price": 90,
"observation": "Sem cebola",
"options": [
{
"option_id": "OPT_001",
"external_code": "SKU_EXTRA_QUEIJO",
"name": "Extra queijo",
"quantity": 2,
"unit_price": 5
}
]
},
{
"item_id": "BEBIDA_001",
"name": "Coca-Cola 350ml",
"quantity": 2,
"unit_price": 4.5,
"total_price": 9
}
],
"payments": [
{
"total": 56,
"payment_method_id": 102,
"change_for": 100
},
{
"total": 50,
"payment_method_id": 103
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
order_id: 'PEDIDO_12345',
display_id: '001',
created_at: '2025-01-15T14:30:00-03:00',
observation: 'Observação geral sobre o pedido',
order_type: 'delivery',
customer: {
phone: '11998989898',
name: 'João Silva',
email: 'joao@email.com',
document_number: '12345678909'
},
totals: {order_amount: 106, delivery_fee: 10, additional_fee: 2, discounts: 5},
delivery_address: {
state: 'CE',
city: 'Fortaleza',
neighborhood: 'Meireles',
street: 'Av. da Abolição',
number: '2456',
complement: 'Apto 000',
reference: 'Casa de portão verde',
postal_code: '60125160',
coordinates: {latitude: -3.7263942, longitude: -38.4981303}
},
items: [
{
item_id: 'PIZZA_001',
external_code: 'SKU_PIZZA_001',
name: 'Pizza Margherita',
quantity: 2,
unit_price: 35,
total_price: 90,
observation: 'Sem cebola',
options: [
{
option_id: 'OPT_001',
external_code: 'SKU_EXTRA_QUEIJO',
name: 'Extra queijo',
quantity: 2,
unit_price: 5
}
]
},
{
item_id: 'BEBIDA_001',
name: 'Coca-Cola 350ml',
quantity: 2,
unit_price: 4.5,
total_price: 9
}
],
payments: [
{total: 56, payment_method_id: 102, change_for: 100},
{total: 50, payment_method_id: 103}
]
})
};
fetch('https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'order_id' => 'PEDIDO_12345',
'display_id' => '001',
'created_at' => '2025-01-15T14:30:00-03:00',
'observation' => 'Observação geral sobre o pedido',
'order_type' => 'delivery',
'customer' => [
'phone' => '11998989898',
'name' => 'João Silva',
'email' => 'joao@email.com',
'document_number' => '12345678909'
],
'totals' => [
'order_amount' => 106,
'delivery_fee' => 10,
'additional_fee' => 2,
'discounts' => 5
],
'delivery_address' => [
'state' => 'CE',
'city' => 'Fortaleza',
'neighborhood' => 'Meireles',
'street' => 'Av. da Abolição',
'number' => '2456',
'complement' => 'Apto 000',
'reference' => 'Casa de portão verde',
'postal_code' => '60125160',
'coordinates' => [
'latitude' => -3.7263942,
'longitude' => -38.4981303
]
],
'items' => [
[
'item_id' => 'PIZZA_001',
'external_code' => 'SKU_PIZZA_001',
'name' => 'Pizza Margherita',
'quantity' => 2,
'unit_price' => 35,
'total_price' => 90,
'observation' => 'Sem cebola',
'options' => [
[
'option_id' => 'OPT_001',
'external_code' => 'SKU_EXTRA_QUEIJO',
'name' => 'Extra queijo',
'quantity' => 2,
'unit_price' => 5
]
]
],
[
'item_id' => 'BEBIDA_001',
'name' => 'Coca-Cola 350ml',
'quantity' => 2,
'unit_price' => 4.5,
'total_price' => 9
]
],
'payments' => [
[
'total' => 56,
'payment_method_id' => 102,
'change_for' => 100
],
[
'total' => 50,
'payment_method_id' => 103
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders"
payload := strings.NewReader("{\n \"order_id\": \"PEDIDO_12345\",\n \"display_id\": \"001\",\n \"created_at\": \"2025-01-15T14:30:00-03:00\",\n \"observation\": \"Observação geral sobre o pedido\",\n \"order_type\": \"delivery\",\n \"customer\": {\n \"phone\": \"11998989898\",\n \"name\": \"João Silva\",\n \"email\": \"joao@email.com\",\n \"document_number\": \"12345678909\"\n },\n \"totals\": {\n \"order_amount\": 106,\n \"delivery_fee\": 10,\n \"additional_fee\": 2,\n \"discounts\": 5\n },\n \"delivery_address\": {\n \"state\": \"CE\",\n \"city\": \"Fortaleza\",\n \"neighborhood\": \"Meireles\",\n \"street\": \"Av. da Abolição\",\n \"number\": \"2456\",\n \"complement\": \"Apto 000\",\n \"reference\": \"Casa de portão verde\",\n \"postal_code\": \"60125160\",\n \"coordinates\": {\n \"latitude\": -3.7263942,\n \"longitude\": -38.4981303\n }\n },\n \"items\": [\n {\n \"item_id\": \"PIZZA_001\",\n \"external_code\": \"SKU_PIZZA_001\",\n \"name\": \"Pizza Margherita\",\n \"quantity\": 2,\n \"unit_price\": 35,\n \"total_price\": 90,\n \"observation\": \"Sem cebola\",\n \"options\": [\n {\n \"option_id\": \"OPT_001\",\n \"external_code\": \"SKU_EXTRA_QUEIJO\",\n \"name\": \"Extra queijo\",\n \"quantity\": 2,\n \"unit_price\": 5\n }\n ]\n },\n {\n \"item_id\": \"BEBIDA_001\",\n \"name\": \"Coca-Cola 350ml\",\n \"quantity\": 2,\n \"unit_price\": 4.5,\n \"total_price\": 9\n }\n ],\n \"payments\": [\n {\n \"total\": 56,\n \"payment_method_id\": 102,\n \"change_for\": 100\n },\n {\n \"total\": 50,\n \"payment_method_id\": 103\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"order_id\": \"PEDIDO_12345\",\n \"display_id\": \"001\",\n \"created_at\": \"2025-01-15T14:30:00-03:00\",\n \"observation\": \"Observação geral sobre o pedido\",\n \"order_type\": \"delivery\",\n \"customer\": {\n \"phone\": \"11998989898\",\n \"name\": \"João Silva\",\n \"email\": \"joao@email.com\",\n \"document_number\": \"12345678909\"\n },\n \"totals\": {\n \"order_amount\": 106,\n \"delivery_fee\": 10,\n \"additional_fee\": 2,\n \"discounts\": 5\n },\n \"delivery_address\": {\n \"state\": \"CE\",\n \"city\": \"Fortaleza\",\n \"neighborhood\": \"Meireles\",\n \"street\": \"Av. da Abolição\",\n \"number\": \"2456\",\n \"complement\": \"Apto 000\",\n \"reference\": \"Casa de portão verde\",\n \"postal_code\": \"60125160\",\n \"coordinates\": {\n \"latitude\": -3.7263942,\n \"longitude\": -38.4981303\n }\n },\n \"items\": [\n {\n \"item_id\": \"PIZZA_001\",\n \"external_code\": \"SKU_PIZZA_001\",\n \"name\": \"Pizza Margherita\",\n \"quantity\": 2,\n \"unit_price\": 35,\n \"total_price\": 90,\n \"observation\": \"Sem cebola\",\n \"options\": [\n {\n \"option_id\": \"OPT_001\",\n \"external_code\": \"SKU_EXTRA_QUEIJO\",\n \"name\": \"Extra queijo\",\n \"quantity\": 2,\n \"unit_price\": 5\n }\n ]\n },\n {\n \"item_id\": \"BEBIDA_001\",\n \"name\": \"Coca-Cola 350ml\",\n \"quantity\": 2,\n \"unit_price\": 4.5,\n \"total_price\": 9\n }\n ],\n \"payments\": [\n {\n \"total\": 56,\n \"payment_method_id\": 102,\n \"change_for\": 100\n },\n {\n \"total\": 50,\n \"payment_method_id\": 103\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"order_id\": \"PEDIDO_12345\",\n \"display_id\": \"001\",\n \"created_at\": \"2025-01-15T14:30:00-03:00\",\n \"observation\": \"Observação geral sobre o pedido\",\n \"order_type\": \"delivery\",\n \"customer\": {\n \"phone\": \"11998989898\",\n \"name\": \"João Silva\",\n \"email\": \"joao@email.com\",\n \"document_number\": \"12345678909\"\n },\n \"totals\": {\n \"order_amount\": 106,\n \"delivery_fee\": 10,\n \"additional_fee\": 2,\n \"discounts\": 5\n },\n \"delivery_address\": {\n \"state\": \"CE\",\n \"city\": \"Fortaleza\",\n \"neighborhood\": \"Meireles\",\n \"street\": \"Av. da Abolição\",\n \"number\": \"2456\",\n \"complement\": \"Apto 000\",\n \"reference\": \"Casa de portão verde\",\n \"postal_code\": \"60125160\",\n \"coordinates\": {\n \"latitude\": -3.7263942,\n \"longitude\": -38.4981303\n }\n },\n \"items\": [\n {\n \"item_id\": \"PIZZA_001\",\n \"external_code\": \"SKU_PIZZA_001\",\n \"name\": \"Pizza Margherita\",\n \"quantity\": 2,\n \"unit_price\": 35,\n \"total_price\": 90,\n \"observation\": \"Sem cebola\",\n \"options\": [\n {\n \"option_id\": \"OPT_001\",\n \"external_code\": \"SKU_EXTRA_QUEIJO\",\n \"name\": \"Extra queijo\",\n \"quantity\": 2,\n \"unit_price\": 5\n }\n ]\n },\n {\n \"item_id\": \"BEBIDA_001\",\n \"name\": \"Coca-Cola 350ml\",\n \"quantity\": 2,\n \"unit_price\": 4.5,\n \"total_price\": 9\n }\n ],\n \"payments\": [\n {\n \"total\": 56,\n \"payment_method_id\": 102,\n \"change_for\": 100\n },\n {\n \"total\": 50,\n \"payment_method_id\": 103\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 1001,
"status": "waiting_confirmation",
"order_type": "delivery",
"order_timing": "immediate",
"sales_channel": "integration",
"created_at": "2025-01-15T14:30:00-03:00",
"updated_at": "2025-01-15T14:30:00-03:00"
}{
"code": 123,
"message": "<string>"
}{
"errors": [
"Order already exists",
"Customer phone must have a valid format",
"Totals order_amount (87.0) does not match calculation: items(99.0) + delivery(10.0) + additional(2.0) - discounts(5.0) = 106.0",
"Payments[0] payment_method not found or inactive for this company",
"Delivery address state CW does not exist"
]
}This response has no body data.Criar pedido
Cria um novo pedido associado à empresa autenticada.
Autenticação: Este endpoint requer dupla autenticação via headers X-API-KEY e X-PARTNER-KEY.
Os pedidos criados via API iniciam sempre no status waiting_confirmation, com order_timing igual a immediate e sales_channel igual a integration. Atualmente não aceitamos pedidos agendados via API.
O ID retornado é o identificador único do pedido no sistema e deve ser utilizado nos endpoints de detalhes do pedido e mudanças de status.
Para obter os item_id e option_id disponíveis, utilize o endpoint GET /api/partner/v1/catalog. Para obter os payment_method_id e brand_id, utilize o endpoint GET /api/partner/v1/merchant/payment_methods.
Regras de validação
Totais: order_amount deve corresponder exatamente a sum(items.total_price) + delivery_fee + additional_fee - discounts.
Itens: total_price de cada item deve corresponder a (unit_price + sum(options.quantity × options.unit_price)) × quantity.
Pagamentos: a soma de todos os valores total deve ser exatamente igual ao order_amount. O payment_method_id e o brand_id (quando informado) devem estar ativos no estabelecimento.
curl --request POST \
--url https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"order_id": "PEDIDO_12345",
"display_id": "001",
"created_at": "2025-01-15T14:30:00-03:00",
"observation": "Observação geral sobre o pedido",
"order_type": "delivery",
"customer": {
"phone": "11998989898",
"name": "João Silva",
"email": "joao@email.com",
"document_number": "12345678909"
},
"totals": {
"order_amount": 106,
"delivery_fee": 10,
"additional_fee": 2,
"discounts": 5
},
"delivery_address": {
"state": "CE",
"city": "Fortaleza",
"neighborhood": "Meireles",
"street": "Av. da Abolição",
"number": "2456",
"complement": "Apto 000",
"reference": "Casa de portão verde",
"postal_code": "60125160",
"coordinates": {
"latitude": -3.7263942,
"longitude": -38.4981303
}
},
"items": [
{
"item_id": "PIZZA_001",
"external_code": "SKU_PIZZA_001",
"name": "Pizza Margherita",
"quantity": 2,
"unit_price": 35,
"total_price": 90,
"observation": "Sem cebola",
"options": [
{
"option_id": "OPT_001",
"external_code": "SKU_EXTRA_QUEIJO",
"name": "Extra queijo",
"quantity": 2,
"unit_price": 5
}
]
},
{
"item_id": "BEBIDA_001",
"name": "Coca-Cola 350ml",
"quantity": 2,
"unit_price": 4.5,
"total_price": 9
}
],
"payments": [
{
"total": 56,
"payment_method_id": 102,
"change_for": 100
},
{
"total": 50,
"payment_method_id": 103
}
]
}
'import requests
url = "https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders"
payload = {
"order_id": "PEDIDO_12345",
"display_id": "001",
"created_at": "2025-01-15T14:30:00-03:00",
"observation": "Observação geral sobre o pedido",
"order_type": "delivery",
"customer": {
"phone": "11998989898",
"name": "João Silva",
"email": "joao@email.com",
"document_number": "12345678909"
},
"totals": {
"order_amount": 106,
"delivery_fee": 10,
"additional_fee": 2,
"discounts": 5
},
"delivery_address": {
"state": "CE",
"city": "Fortaleza",
"neighborhood": "Meireles",
"street": "Av. da Abolição",
"number": "2456",
"complement": "Apto 000",
"reference": "Casa de portão verde",
"postal_code": "60125160",
"coordinates": {
"latitude": -3.7263942,
"longitude": -38.4981303
}
},
"items": [
{
"item_id": "PIZZA_001",
"external_code": "SKU_PIZZA_001",
"name": "Pizza Margherita",
"quantity": 2,
"unit_price": 35,
"total_price": 90,
"observation": "Sem cebola",
"options": [
{
"option_id": "OPT_001",
"external_code": "SKU_EXTRA_QUEIJO",
"name": "Extra queijo",
"quantity": 2,
"unit_price": 5
}
]
},
{
"item_id": "BEBIDA_001",
"name": "Coca-Cola 350ml",
"quantity": 2,
"unit_price": 4.5,
"total_price": 9
}
],
"payments": [
{
"total": 56,
"payment_method_id": 102,
"change_for": 100
},
{
"total": 50,
"payment_method_id": 103
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
order_id: 'PEDIDO_12345',
display_id: '001',
created_at: '2025-01-15T14:30:00-03:00',
observation: 'Observação geral sobre o pedido',
order_type: 'delivery',
customer: {
phone: '11998989898',
name: 'João Silva',
email: 'joao@email.com',
document_number: '12345678909'
},
totals: {order_amount: 106, delivery_fee: 10, additional_fee: 2, discounts: 5},
delivery_address: {
state: 'CE',
city: 'Fortaleza',
neighborhood: 'Meireles',
street: 'Av. da Abolição',
number: '2456',
complement: 'Apto 000',
reference: 'Casa de portão verde',
postal_code: '60125160',
coordinates: {latitude: -3.7263942, longitude: -38.4981303}
},
items: [
{
item_id: 'PIZZA_001',
external_code: 'SKU_PIZZA_001',
name: 'Pizza Margherita',
quantity: 2,
unit_price: 35,
total_price: 90,
observation: 'Sem cebola',
options: [
{
option_id: 'OPT_001',
external_code: 'SKU_EXTRA_QUEIJO',
name: 'Extra queijo',
quantity: 2,
unit_price: 5
}
]
},
{
item_id: 'BEBIDA_001',
name: 'Coca-Cola 350ml',
quantity: 2,
unit_price: 4.5,
total_price: 9
}
],
payments: [
{total: 56, payment_method_id: 102, change_for: 100},
{total: 50, payment_method_id: 103}
]
})
};
fetch('https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'order_id' => 'PEDIDO_12345',
'display_id' => '001',
'created_at' => '2025-01-15T14:30:00-03:00',
'observation' => 'Observação geral sobre o pedido',
'order_type' => 'delivery',
'customer' => [
'phone' => '11998989898',
'name' => 'João Silva',
'email' => 'joao@email.com',
'document_number' => '12345678909'
],
'totals' => [
'order_amount' => 106,
'delivery_fee' => 10,
'additional_fee' => 2,
'discounts' => 5
],
'delivery_address' => [
'state' => 'CE',
'city' => 'Fortaleza',
'neighborhood' => 'Meireles',
'street' => 'Av. da Abolição',
'number' => '2456',
'complement' => 'Apto 000',
'reference' => 'Casa de portão verde',
'postal_code' => '60125160',
'coordinates' => [
'latitude' => -3.7263942,
'longitude' => -38.4981303
]
],
'items' => [
[
'item_id' => 'PIZZA_001',
'external_code' => 'SKU_PIZZA_001',
'name' => 'Pizza Margherita',
'quantity' => 2,
'unit_price' => 35,
'total_price' => 90,
'observation' => 'Sem cebola',
'options' => [
[
'option_id' => 'OPT_001',
'external_code' => 'SKU_EXTRA_QUEIJO',
'name' => 'Extra queijo',
'quantity' => 2,
'unit_price' => 5
]
]
],
[
'item_id' => 'BEBIDA_001',
'name' => 'Coca-Cola 350ml',
'quantity' => 2,
'unit_price' => 4.5,
'total_price' => 9
]
],
'payments' => [
[
'total' => 56,
'payment_method_id' => 102,
'change_for' => 100
],
[
'total' => 50,
'payment_method_id' => 103
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders"
payload := strings.NewReader("{\n \"order_id\": \"PEDIDO_12345\",\n \"display_id\": \"001\",\n \"created_at\": \"2025-01-15T14:30:00-03:00\",\n \"observation\": \"Observação geral sobre o pedido\",\n \"order_type\": \"delivery\",\n \"customer\": {\n \"phone\": \"11998989898\",\n \"name\": \"João Silva\",\n \"email\": \"joao@email.com\",\n \"document_number\": \"12345678909\"\n },\n \"totals\": {\n \"order_amount\": 106,\n \"delivery_fee\": 10,\n \"additional_fee\": 2,\n \"discounts\": 5\n },\n \"delivery_address\": {\n \"state\": \"CE\",\n \"city\": \"Fortaleza\",\n \"neighborhood\": \"Meireles\",\n \"street\": \"Av. da Abolição\",\n \"number\": \"2456\",\n \"complement\": \"Apto 000\",\n \"reference\": \"Casa de portão verde\",\n \"postal_code\": \"60125160\",\n \"coordinates\": {\n \"latitude\": -3.7263942,\n \"longitude\": -38.4981303\n }\n },\n \"items\": [\n {\n \"item_id\": \"PIZZA_001\",\n \"external_code\": \"SKU_PIZZA_001\",\n \"name\": \"Pizza Margherita\",\n \"quantity\": 2,\n \"unit_price\": 35,\n \"total_price\": 90,\n \"observation\": \"Sem cebola\",\n \"options\": [\n {\n \"option_id\": \"OPT_001\",\n \"external_code\": \"SKU_EXTRA_QUEIJO\",\n \"name\": \"Extra queijo\",\n \"quantity\": 2,\n \"unit_price\": 5\n }\n ]\n },\n {\n \"item_id\": \"BEBIDA_001\",\n \"name\": \"Coca-Cola 350ml\",\n \"quantity\": 2,\n \"unit_price\": 4.5,\n \"total_price\": 9\n }\n ],\n \"payments\": [\n {\n \"total\": 56,\n \"payment_method_id\": 102,\n \"change_for\": 100\n },\n {\n \"total\": 50,\n \"payment_method_id\": 103\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"order_id\": \"PEDIDO_12345\",\n \"display_id\": \"001\",\n \"created_at\": \"2025-01-15T14:30:00-03:00\",\n \"observation\": \"Observação geral sobre o pedido\",\n \"order_type\": \"delivery\",\n \"customer\": {\n \"phone\": \"11998989898\",\n \"name\": \"João Silva\",\n \"email\": \"joao@email.com\",\n \"document_number\": \"12345678909\"\n },\n \"totals\": {\n \"order_amount\": 106,\n \"delivery_fee\": 10,\n \"additional_fee\": 2,\n \"discounts\": 5\n },\n \"delivery_address\": {\n \"state\": \"CE\",\n \"city\": \"Fortaleza\",\n \"neighborhood\": \"Meireles\",\n \"street\": \"Av. da Abolição\",\n \"number\": \"2456\",\n \"complement\": \"Apto 000\",\n \"reference\": \"Casa de portão verde\",\n \"postal_code\": \"60125160\",\n \"coordinates\": {\n \"latitude\": -3.7263942,\n \"longitude\": -38.4981303\n }\n },\n \"items\": [\n {\n \"item_id\": \"PIZZA_001\",\n \"external_code\": \"SKU_PIZZA_001\",\n \"name\": \"Pizza Margherita\",\n \"quantity\": 2,\n \"unit_price\": 35,\n \"total_price\": 90,\n \"observation\": \"Sem cebola\",\n \"options\": [\n {\n \"option_id\": \"OPT_001\",\n \"external_code\": \"SKU_EXTRA_QUEIJO\",\n \"name\": \"Extra queijo\",\n \"quantity\": 2,\n \"unit_price\": 5\n }\n ]\n },\n {\n \"item_id\": \"BEBIDA_001\",\n \"name\": \"Coca-Cola 350ml\",\n \"quantity\": 2,\n \"unit_price\": 4.5,\n \"total_price\": 9\n }\n ],\n \"payments\": [\n {\n \"total\": 56,\n \"payment_method_id\": 102,\n \"change_for\": 100\n },\n {\n \"total\": 50,\n \"payment_method_id\": 103\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"order_id\": \"PEDIDO_12345\",\n \"display_id\": \"001\",\n \"created_at\": \"2025-01-15T14:30:00-03:00\",\n \"observation\": \"Observação geral sobre o pedido\",\n \"order_type\": \"delivery\",\n \"customer\": {\n \"phone\": \"11998989898\",\n \"name\": \"João Silva\",\n \"email\": \"joao@email.com\",\n \"document_number\": \"12345678909\"\n },\n \"totals\": {\n \"order_amount\": 106,\n \"delivery_fee\": 10,\n \"additional_fee\": 2,\n \"discounts\": 5\n },\n \"delivery_address\": {\n \"state\": \"CE\",\n \"city\": \"Fortaleza\",\n \"neighborhood\": \"Meireles\",\n \"street\": \"Av. da Abolição\",\n \"number\": \"2456\",\n \"complement\": \"Apto 000\",\n \"reference\": \"Casa de portão verde\",\n \"postal_code\": \"60125160\",\n \"coordinates\": {\n \"latitude\": -3.7263942,\n \"longitude\": -38.4981303\n }\n },\n \"items\": [\n {\n \"item_id\": \"PIZZA_001\",\n \"external_code\": \"SKU_PIZZA_001\",\n \"name\": \"Pizza Margherita\",\n \"quantity\": 2,\n \"unit_price\": 35,\n \"total_price\": 90,\n \"observation\": \"Sem cebola\",\n \"options\": [\n {\n \"option_id\": \"OPT_001\",\n \"external_code\": \"SKU_EXTRA_QUEIJO\",\n \"name\": \"Extra queijo\",\n \"quantity\": 2,\n \"unit_price\": 5\n }\n ]\n },\n {\n \"item_id\": \"BEBIDA_001\",\n \"name\": \"Coca-Cola 350ml\",\n \"quantity\": 2,\n \"unit_price\": 4.5,\n \"total_price\": 9\n }\n ],\n \"payments\": [\n {\n \"total\": 56,\n \"payment_method_id\": 102,\n \"change_for\": 100\n },\n {\n \"total\": 50,\n \"payment_method_id\": 103\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 1001,
"status": "waiting_confirmation",
"order_type": "delivery",
"order_timing": "immediate",
"sales_channel": "integration",
"created_at": "2025-01-15T14:30:00-03:00",
"updated_at": "2025-01-15T14:30:00-03:00"
}{
"code": 123,
"message": "<string>"
}{
"errors": [
"Order already exists",
"Customer phone must have a valid format",
"Totals order_amount (87.0) does not match calculation: items(99.0) + delivery(10.0) + additional(2.0) - discounts(5.0) = 106.0",
"Payments[0] payment_method not found or inactive for this company",
"Delivery address state CW does not exist"
]
}This response has no body data.Autorizações
Access token OAuth 2.0 de app instalado na CW App Store. Escopo: orders.
Corpo
Identificador único do pedido na plataforma integradora. Deve ser único.
Identificador visível para o cliente (ex: número sequencial).
Tipo do pedido.
delivery, takeout, onsite Valores totais do pedido.
O order_amount deve corresponder exatamente ao cálculo: order_amount = sum(items.total_price) + delivery_fee + additional_fee - discounts
Show child attributes
Show child attributes
Lista de itens do pedido. Mínimo 1, máximo 50 itens.
1 - 50 elementsShow child attributes
Show child attributes
Formas de pagamento. Máximo 5 pagamentos. A soma dos total deve ser igual ao order_amount.
5Show child attributes
Show child attributes
Dados do cliente. Obrigatório para delivery.
Show child attributes
Show child attributes
Endereço de entrega. Obrigatório para order_type: delivery.
Show child attributes
Show child attributes
Data/hora da criação do pedido (ISO 8601). Não pode ser futura.
Observações gerais do pedido.
Resposta
Pedido criado com sucesso.
Resposta retornada após a criação bem-sucedida de um pedido via API.
ID único do pedido no sistema. Utilizado nos endpoints de detalhes do pedido e mudanças de status.
Status atual do pedido. Pedidos criados via API iniciam sempre em waiting_confirmation.
waiting_confirmation Tipo do pedido.
delivery, takeout, onsite Momento de entrega do pedido. Atualmente sempre immediate para pedidos criados via API.
immediate Canal de venda. Sempre integration para pedidos criados via API.
integration Data/hora de criação (ISO 8601).
Data/hora da última atualização (ISO 8601).
Esta página foi útil?
