Skip to main content

Cancel

POST 

/v2.0/orders/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​

Body

    externalRequestId stringnullable

    Your id for this call, up to 128 printable characters. Returned as is in the response, success or error, and kept in our logs: quote it when contacting support, even if the response never reached you. Use a new value for each call.

    timestamp stringnullable

    When you sent this request, by your clock: ISO 8601 with a timezone offset, e.g. 2026-11-13T14:32:05.120-03:00. Kept in our logs.

    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​

Schema
    requestId stringnullable

    Our id for this call, also in the X-Request-Id header. Quote it when contacting support.

    externalRequestId stringnullable

    The externalRequestId of the request, as sent. Absent when it wasn't sent.

    timestamp stringnullable

    When we answered, by our clock: ISO 8601 in UTC, e.g. 2026-11-13T17:32:05.874Z.

    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.

  • ]
Loading...