Reservation Cancel API Reference (GDS)

POST

receipt/reservations/{LocatorCode}/receipts

For {LocatorCode} send the locator code of the reservation to retrieve.

Base path:

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/air/

Production https://api.travelport.com/11/air/

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/air/

Production https://api.travelport.net/11/air/

Related Content: Booking Guide, Reservation Retrieve Guide

Canceling a GDS reservation requires a single cancel request as detailed here. A reservation is a held booking that has not been ticketed.

Alternately, you can use Cancel Workbench Items to cancel the booking, which requires a flow with workbench create and a workbench commit instead of a single call.

To cancel an NDC reservation, see the Cancel API Reference (NDC).

Request

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

Query Parameters

None.

Request Body

To cancel a reservation, send a POST request that includes the reservation to cancel to the endpoint above. There is no message payload.

Response

Show Response Body Table

Object	Description
ReceiptListResponse	Top level object for response. Includes ReceiptID object.
ReceiptID	Top level object for cancellation details. Key value pair: id: Internal identifier.
Identifier	Identifier details for this transaction. In this case, authority is always Travelport and value provides a system-generated internal idnetifier for the response. Key value pairs. authority: Source of information. value: Unique system-generated identifier.
Cancellation	Top level object for cancellation details. type: Cancellation status. Includes the Locator object.
Locator	Cancellation details of the canceled itinerary in the following key value pairs: type: Cancellation status. source: Provider on which the reservation was created; for GDS this value is 1G. sourceContext: For GDS always returns the value Travelport. value: The reservation locator code of the canceled reservation.

Example Request

There is no message payload.

Example Response

Show Example GDS reservation Cancel Response

{
    "ReceiptListResponse": {
        "ReceiptID": [
            {
                "@type": "ReceiptCancellation",
                "id": "receipt_1",
                "Identifier": {
                    "authority": "Travelport",
                    "value": "bae9f140-ff5e-4685-b72f-70a6ef9beedd"
                },
                "Cancellation": {
                    "@type": "CancellationHold",
                    "Locator": {
                        "locatorType": "Locator",
                        "source": "1G",
                        "sourceContext": "Travelport",
                        "value": "0GM4S1"
                    }
                }
            }
        ]
    }
}