Cancelar um pedido

POST 
/v1/orders/:id/cancel

Cancela um pedido e o retorna. Duas regras se aplicam:

• Somente pedidos criados pela API podem ser cancelados. Um pedido feito na loja virtual, no POS ou em um food app deve ser cancelado onde foi feito, e este endpoint responde 422 order_not_modifiable para ele.
• Um pedido que ainda tenha pagamentos ativos não pode ser cancelado. Remova os pagamentos primeiro com DELETE /v1/orders/{id}/payments/{paymentId}.

Um pedido que já está cancelado não pode ser alterado, e um pedido finalizado não aceita nada além do cancelamento.

Escopo necessário: orders:write

Request

Responses

200

O pedido cancelado.

401

Não autenticado — a requisição não possui uma credencial, ou o token Bearer / API key é inválido, expirou ou foi revogado.

403

Escopo insuficiente — a credencial está autenticada, mas não possui um escopo exigido pelo endpoint.

404

Não encontrado — nenhum recurso corresponde ao id no caminho (ou ele pertence a outra empresa).

422

Falha de validação — o corpo da requisição falhou na validação do schema. errors[] lista todos os campos com problema.