Cancel

POST 
/v2/booking/cancel

Introduction

Cancels a previously created order, in full or in part. Pass itemIds to cancel only specific items within a multi-item order; omit it to cancel the entire order.

Request

application/json

Body

orderId stringrequired

ID of the order to cancel, as returned by orderId on the booking response.

itemIds string[]nullable

IDs of specific items to cancel, as returned by items[].id on the booking response. Omit to cancel the entire order.

Responses

200

application/json

Schema

Schema

orderId stringrequired

ID of the cancelled order.

status required

Possible values: [CANCELLED, FAILED]

'CANCELLED' if at least one item in the order was cancelled successfully, 'FAILED' otherwise.

items object[]
Per-item cancellation results.
Array [
id stringrequired
ID of the cancelled item.
success booleanrequired
Whether this item was successfully cancelled.
status stringrequired
Item status after the cancellation attempt.
]
errors object[]
Unexpected errors encountered during cancellation, if any.
Array [
code stringnullable
Error code.
message stringnullable
Error description.
]

Example (from schema)

{
  "orderId": "string",
  "items": [
    {
      "id": "string",
      "success": true,
      "status": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Loading...