Criar pedido

curl --request POST \
  --url https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --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
    }
  ]
}
'

{
  "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"
}

Criação de pedido

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.

POST

api

partner

orders

Criar pedido

curl --request POST \
  --url https://integracao.sandbox.cardapioweb.com/api/partner/v1/orders \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --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
    }
  ]
}
'

{
  "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"
}

Autorizações

X-API-KEY

string

header

obrigatório

Token específico do estabelecimento integrado. Disponível na seção de integrações do Portal do estabelecimento.

Corpo

application/json

order_id

string

obrigatório

Identificador único do pedido na plataforma integradora. Deve ser único.

display_id

string

obrigatório

Identificador visível para o cliente (ex: número sequencial).

order_type

enum<string>

obrigatório

Tipo do pedido.

Opções disponíveis:

delivery,

takeout,

onsite

totals

Totais · object

obrigatório

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

items

Item do pedido · object[]

obrigatório

Lista de itens do pedido. Mínimo 1, máximo 50 itens.

Required array length: 1 - 50 elements

Show child attributes

payments

Pagamento · object[]

obrigatório

Formas de pagamento. Máximo 5 pagamentos. A soma dos total deve ser igual ao order_amount.

Maximum array length: 5

Show child attributes

customer

Cliente · object

Dados do cliente. Obrigatório para delivery.

Show child attributes

delivery_address

Endereço de entrega · object

Endereço de entrega. Obrigatório para order_type: delivery.

Show child attributes

created_at

string<date-time>

Data/hora da criação do pedido (ISO 8601). Não pode ser futura.

observation

string

Observações gerais do pedido.

Resposta

Pedido criado com sucesso.

Resposta retornada após a criação bem-sucedida de um pedido via API.

integer

obrigatório

ID único do pedido no sistema. Utilizado nos endpoints de detalhes do pedido e mudanças de status.

status

enum<string>

obrigatório

Status atual do pedido. Pedidos criados via API iniciam sempre em waiting_confirmation.

Opções disponíveis:

waiting_confirmation

order_type

enum<string>

obrigatório

Tipo do pedido.

Opções disponíveis:

delivery,

takeout,

onsite

order_timing

enum<string>

obrigatório

Momento de entrega do pedido. Atualmente sempre immediate para pedidos criados via API.

Opções disponíveis:

immediate

sales_channel

enum<string>

obrigatório

Canal de venda. Sempre integration para pedidos criados via API.

Opções disponíveis:

integration

created_at

string<date-time>

obrigatório

Data/hora de criação (ISO 8601).

updated_at

string<date-time>

obrigatório

Data/hora da última atualização (ISO 8601).

Última modificação em 27 de junho de 2026

Criar pedido pré-preenchido

⌘I