Criar um pedido
POST/v1/orders
Cria um pedido e o retorna.
Envie service_type e, opcionalmente, client_id (um cliente existente da sua empresa). table_id só é aceito para pedidos TABLE; address_id e delivery_price apenas para pedidos DELIVERY.
Por padrão o pedido começa como INITIATED: um rascunho que o comerciante ainda não vê. Adicione os itens com POST /v1/orders/{id}/combos (e pagamentos ou descontos, se houver), depois confirme-o com PATCH /v1/orders/{id}/status e status: PENDING (ou PREPARING para pular a confirmação do comerciante). Confirmar atribui o número diário e torna o pedido visível ao comerciante. Rascunhos nunca são retornados por GET /v1/orders: guarde o id desta resposta e leia o rascunho com GET /v1/orders/{id}.
Envie status: PENDING para pular o rascunho e confirmar o pedido na criação.
Exige um cabeçalho Idempotency-Key; repetir a mesma chave com o mesmo corpo retorna o resultado original.
Escopo necessário: orders:write
Request
Responses
- 201
- 401
- 403
- 404
- 422
O pedido criado.
Não autenticado — a requisição não possui uma credencial, ou o token Bearer / API key é inválido, expirou ou foi revogado.
Escopo insuficiente — a credencial está autenticada, mas não possui um escopo exigido pelo endpoint.
Não encontrado — nenhum recurso corresponde ao id no caminho (ou ele pertence a outra empresa).
Falha de validação — o corpo da requisição falhou na validação do schema. errors[] lista todos os campos com problema.