Skip to main content
POST
Criar pedido

Autorizações

Authorization
string
header
obrigatório

Access token OAuth 2.0 de app instalado na CW App Store. Escopo: orders.

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

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
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
customer
Cliente · object | null

Dados do cliente. Obrigatório para delivery.

delivery_address
Endereço de entrega · object

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

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.

id
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 30 de junho de 2026