SUsuntransfers
Booking

Cancels a Booking.

Changed on

Requests to this endpoint that fail may be retried after a few minutes. See more in the Responses section. If the issue persists, the fallback integration mechanism will be used (A.K.A. the email or FTP delivered XML file).

delete/v1/bookings/{bookingReference}

Request

Path parameters

bookingReferencestring required

Request body

cancellationAuthor'Customer' | 'Supplier' | 'Suntransfers' required

Identifies who is requesting the cancellation.

notesstring nullable

Additional notes about the cancellation.

Response

200 OK: The Booking has been cancelled. Signals that the cancellation has happened synchronously. That means that the Booking is already cancelled in the supplier's system.

bookingReferencestring required

The Suntransfers Booking reference identifier. This is currently a string starting with 'SUNTR_' followed by alphanumeric characters.

supplierReferencesSupplierReference[] nullable

The Supplier's internal Transfer references or IDs.

Changes

  • v171a9b447a868Revision changes
    • info

      the / request property's minLength was decreased from 1 to 0

  • v1c61c4e075ff8Revision changes
    • warning

      removed the request property ///

    • info

      added the new optional request property ///