GDS Reservation Cancel API Reference

POST

receipt/reservations/{LocatorCode}/receipts

For {LocatorCode} send the locator code of the reservation to retrieve (returned in the workbench commit API call that ends a workbench session, finalizing all changes and requests in that session. Depending on the workbench transactions, the commit workbench request may create a reservation, issue a ticket or EMD, exchange tickets, or modify a reservation. in Confirmation/Locator/value).

Base path:

Pre-production https://api.pp.travelport.com/11/air/

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

Related Content: Booking Guide, Reservation Retrieve Guide

Canceling a GDS Global Distribution System. A GDS aggregates and distributes air, hotel, and car rental content such as schedules, fares, and upsells. In the JSON APIs, GDS content is distributed from Travelport. reservation requires a single cancel Cancel a ticket outside the void period without rebooking on another itinerary. Depending on the airline ticket policy, canceling a ticket may result in a full, partial, or no refund. request as detailed here. A reservation is a held booking A confirmed reservation with the carrier. A held booking is a reservation that has not yet been ticketed. The terms booking and reservation are interchangeable. that has not been ticketed.

To cancel an NDC New Distribution Capability, an XML standard for exchanging data that supports airlines in distributing their content directly to online travel agencies. See the NDC Guide. reservation, see the NDC Order Cancel API Reference.

Request

Also see Authorization and Common 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 In the JSON APIs, a unique identifier for specific, unique data, such as an entire response or an offer, product, or brand in a response. These identifiers must often be sent in subsequent requests to refer to a previous response, offer, product, etc. Usually returned in Identifier/value for the referenced object. Example format: 3cecf1be-0b21-4881-8f33-ae11c8d7b708. See the JSON APIs Guide..
Cancellation	Top level object for cancellation details. type: Cancellation status. Includes the Locator object.
Locator	Cancellation details of the canceled itinerary The entire trip on a booking, including all flights on all legs. Also called a journey. 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"
                    }
                }
            }
        ]
    }
}