Sign in

v1

latestOpenAPI 3.0.02026-07-2420104111.7 KB
Pedidos

Cancelar pedido

Cancelamento de pedido. Depois do pedido realizado o recurso de desbloqueio de assento não é mais uma opção, para seguir com a intenção de desfazer a operação de reserva você precisa cancelar o pedido.

patch/partners/api/v4/orders/{id}

Path parameters

idstring required
Example:7KYZYM9X

ID do pedido a ser cancelado

Request body

order_status'CANCEL' required

Status do pedido para cancelamento

reason'USER_REQUEST' required

Motivo do cancelamento do pedido

refundOption'ORIGINAL_PAYMENT_METHOD'

Opção de reembolso do pedido cancelado. Se não for informado, o padrão será ORIGINAL_PAYMENT_METHOD.

itemsstring[]

Lista de itens do pedido a serem cancelados. Se não for informado, todos os itens do pedido serão cancelados.

Example request

{
  "order_status": "CANCEL",
  "reason": "USER_REQUEST",
  "refundOption": "ORIGINAL_PAYMENT_METHOD",
  "items": [
    123456,
    789012
  ]
}

Response

Pedido cancelado com sucesso

successboolean

Indica se o cancelamento foi bem-sucedido

messagestring

Mensagem de confirmação

Example response

{
  "success": true,
  "message": "Pedido cancelado com sucesso"
}