Reservation Retrieve API Reference

Get

book/reservation/reservations/{LocatorCode} 

or

book/reservation/reservations/?identifierType={ticketnumber} 

For {LocatorCode} send the locator code of the reservation to retrieve (returned in the workbench commit in Confirmation/Locator/value).

For {ticketnumber} send the ticket number of the reservation to retrieve.

Base path:

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

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

Related Content: Booking Guide, Traveler Modify Guide

Retrieve details about a held booking, or reservation. While a reservation refers to a held booking that has not been ticketed, the reservation code persists after ticketing to provide the booking records. Once a reservation has been ticketed, Reservation Retrieve returns both booking and ticketing details, with the ticket number in the Document/Number.

A Ticket Retrieve request can also be used to retrieve any ticketed itinerary.

Hotel and Car Content with Air Bookings

With the release of AirReservation 23.11.29, the existing Reservation Retrieve and Create Post-Commit Workbench responses were updated to return by default any hotel or car segments along with air for any reservation that includes hotel or car bookings. The hotel and/or car segments must have been booked with the JSON Hotel APIs or JSON Car APIs (full release pending), or a terminal program.

At this time the only support for this content is to retrieve it. Support for modifying and servicing these bookings is planned for future releases. For full details see the Booking Guide for Air, Hotel, & Car.

Request

The Reservation Retrieve supports the optional return of long fare rules. To request long fare rules, send the fareRuleRetrievalType header parameter with the value long.

Query Parameters

Parameter Description Required/Optional

unnamed parameter

Sends the record locator to retrieve reservation details.

Sends the ticket number to retrieve reservation details for a reservation or ticketed itinerary. The response is the same as for a reservation retrieve request sending the ticket number.

Example:

https://api.travelport.com/11/air/book/reservation/reservations/2BPSMS

Either ticket number or record locator is required

identifierType

AirReservation 23.11.26 and later.
GDS only; not supported for NDC.

Sends the ticket number to retrieve reservation details for a ticketed itinerary. The response is the same as for a reservation retrieve request sending the record locator.

Example:

https://api.travelport.com/11/air/book/reservation/reservations/?identifierType=0067744639158

Either ticket number or record locator is required

detailViewInd

The detail view returns document override, accounting, historical, and DOCI remarks, if those have been added to the reservation. Supported values:

  • true: Returns detail view.

  • false: Does not return detail view. Default.

Optional

viewBrandCompleteInfoInd

GDS only; not supported for NDC.

Request the return of brand attributes in the reservation retrieve.

Supported values:

  • true: Returns brand attributes in Offer/Product/PassengerFlight/FlightProduct/Brand.

  • false: Does not return brand attributes. Default.

Optional

viewBaggageDetailInd

 

GDS only; not supported for NDC.

Request the return of baggage dimension and fee details in the reservation retrieve.

Supported values:

  • true: Returns additional baggage details in TermsAndConditionsFull/BaggageAllowance.

  • false: Does not return baggage details. Default.

Optional

Request Body

No message payload.

Response

The information returned in the Reservation Retrieve response varies depending on the information that has been added to the reservation at the time of retrieve, whether the reservation has been ticketed, and whether the reservation was created outside of the Travelport JSON APIs.

The basic ReservationResponse detailed here is returned for Reservation Retrieve and several other requests, including:

  • Create post-commit workbench (response is same as for Reservation Retrieve plus a workbench identifier)

  • Commit workbench (largely similar but some objects may vary)

Multi-Content Bookings with Hotel and Car

Mutli-content bookings include air and hotel and/or car content. The booking details are generally the same as air-only bookings, with addition of an instance of Offer/Product with @type ProductHospitality for hotel content and/or @type ProductVehicle for car content. The tables below outline the Product objects for this type of content. Price details also differ from air prices and are listed below. See Booking Guide for Air, Hotel, & Car for details and examples.

Offer/Product and Price objects for hotel content

Each instance of Product returns details for one product on this offer. For multi-content bookings, the JSON APIs return a hotel booking in one instance of Offer/Product. The following table outlines objects in Product with @type ProductHospitality for hotel content.

Object Description

Price

Price of car offer.

Includes CurrencyCode and PriceBreakdown objects.

CurrencyCode

Currency code for this price.

decimalPlace: Number of decimal places in this currency.

codeAuthority: Currency code.

TotalPrice

Number. Total price of hotel segment.

Includes PriceBreakdown.

RateDistance

Rate costs by distance:

allowance: Number of distance units allowed in this rate.

distanceUnits: Units of the distance allowed, such as Miles or Kilometers.

ratePeriod: Duration in which the allowance can be used.

ApproximateRate

Vehicle rate.

BaseRate

Base vehicle rate before taxes and fees.

Offer/Product and Price objects for car content

Each instance of Product returns details for one product on this offer. For multi-content bookings, the JSON APIs return a car booking in one instance of Offer/Product. The following table outlines objects in Product with @type ProductVehicle for car content.

Example Request

No message payload.

Example Response

The objects and data returned in a reservation retrieve varies according to the information present in the reservation and whether the reservation has been ticketed. Several examples follow.

For Reservation Retrieve examples with air, car, and hotel content, see the Booking Guide for Air, Hotel, & Car Content.
For additional examples and scenarios, download the developer toolkits and see Using Postman and Developer Toolkits.
Reservation Retrieve - GDS One-way Held Booking for Two Travelers with Seats

The following example shows a reservation retrieve for a one-way GDS held booking with two travelers and free seats.

Reservation Retrieve - Ticketed Round-trip GDS Itinerary

The following example shows a ticketed round-trip GDS itinerary. Each instance of Product is one leg of the itinerary.

Reservation Retrieve - Ticketed NDC Itinerary

The following example shows a ticketed NDC itinerary with paid seats.