Check the Hotel Release Notes for updates across all Hotel APIs.

Cancel Hotel Reservation API Reference

Put

book/reservations/{AggregatorLocatorCode}/canceloffer?supplierLocator={SupplierLocatorCode}

For {AggregatorLocatorCode} send the locator code returned at booking or in Reservation Retrieve in Receipt/Confirmation/Locator/value.

Hotel bookings return multiple locator codes. Send the value from the instance of Receipt with Confirmation/Locator/locatorType=PNR Locator. See Locator Codes for details.

Use this base path if you have not yet received or not migrated to the new credentials from Travelport:

Pre-production https://api.pp.travelport.com/11/hotel/ | Production https://api.travelport.com/11/hotel/

Use this base path after you have migrated to the new credentials from Travelport (using .net instead of .com):

Pre-production https://api.pp.travelport.net/11/hotel/ | Production https://api.travelport.net/11/hotel/

Related Content: JSON Hotel APIs Guide, Hotel Reservation Retrieve API Reference

The Cancel Hotel Reservation API cancels an existing hotel reservation.


Request

As part of the request requirements, also see Authentication and Common Hotel API Headers.

Query Parameters

Parameter Description Required/Optional

SupplierLocatorCode

Send the supplier locator code returned at booking or in Reservation Retrieve in Receipt/Confirmation/Locator/value.

Hotel bookings return multiple locator codes. For the supplier locator code, send the value from the instance of Receipt with Confirmation/Locator/locatorType=Confirmation Number and sourceContext=Supplier. See Locator Codes for details.

Required

Request Body

This API does not send a request payload.

Example Request

This API does not send a request payload.


Response

The Reservation Cancel response returns the same type of data using the same structure as the Create Reservation response. See the Create Reservation Reference Payload API Reference for documentation.

See the example below for all differences in data for a canceled reservation versus an active reservation.

Example Response

For additional examples, download the developer toolkits and see Using Postman and Developer Toolkits.

The Reservation Cancel response returns the same type of data using the same structure as the Create Reservation response. Using the same structure, the differences for a canceled reservation are as follows:

  • In the instance of Receipt for the supplier, Confirmation/Locator/value returns the supplier cancellation number, and locatorType is Cancellation Number.

  • Also in the instance of Receipt for the supplier, OfferStatus/code is HK and Status is Cancelled.

  • In the instances of Receipt for both the supplier and Travelport, Confirmation/Locator/creationDate returns the date the reservation was canceled instead of the date it was created.

Note that for readability all objects except Receipt were truncated [...]. All truncated objects return the same reservation data from the original booking as would a Reservation Retrieve.