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.

Either the ticket number or locator code is required.

Base path:

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

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

Related Content: Reservation Retrieve Guide, Booking Guide, Booking Guide for Air, Hotel, & Car Content, Ticketing 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 object.

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

AirReservation 23.11.29 updated the Reservation Retrieve and Create Post-Commit Workbench responses to return hotel and/or car segments along with air for any reservation that includes hotel or car bookings. Segments must have been booked with the JSON Hotel APIs or JSON Car APIs (full release pending), or a terminal program. 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

variable

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

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

AirReservation 23.11.26 and later. GDS only; not supported for NDC.
Either ticket number or record locator is required

detailViewInd

The detail view returns any document override, accounting, historical, and DOCI remarks added to the booking, and any custom rules added to a booking. Supported values:

  • true: Returns detail view.

  • false: Does not return detail view. Default.

Optional

viewBrandCompleteInfoInd

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.

GDS only; not supported for NDC.

Optional

viewBaggageDetailInd

 

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.

GDS only; not supported for NDC.
Optional

fareRuleType

Enumeration for the type of fare rules requested. If brand pricing was requested in a preceding AirPrice request (returnBrandedFaresInd=true), you can send fareRuleType with the value Structured to return structured fare rules; e.g., ?fareRuleType=Structured

AirReservation 24.11.44 and later.

Optional

fareRuleCategories

Enumeration. When requesting structured fare rules with the fareRuleType query parameter, you can also send the optional fareRuleCategories query parameter to specify the category of structured fare rules to return.

Supported values:

  • AdvanceReservationTicketing

  • MinimumStay

  • MaximumStay

  • Stopovers

  • Penalties

  • VoluntaryRefunds

  • VoluntaryChanges

AirReservation 24.11.44 and later.
If you request structured fare rules but do not specify a fare rule category, all rules in the above categories are returned.
For NDC, structured fare rules are supported only for Penalties.

 

Optional

includeFlightAmenitiesInd

Request the return of additional flight amenities, provided by ATPCO as RouteHappy data.

Supported values:

AirReservation 24.11.46.2 and later.

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 for these requests:

See these links for details on each request. Because these requests do not support the query parameters above, some of the data detailed below is not returned in those responses.

ReservationResponse objects

Object

Description

ReservationResponse

Top level object for response.

Includes Reservation and Result objects. May include ReferenceList.

Reservation

Top-level object for reservation details.

Depending on the information in the reservation, may include Identifier, Offer, Traveler, Receipt, ReservationComment, PrimaryContact, CustomAuxiliarySegment, and ReservationDisplaySequence objects.

Key value pairs:

notificationDate: For held bookings, date by which the booking must be ticketed or the offer expires. HH:MM format (e.g., "notificationDate": "2023-07-11",). AirReservation 23.11.29 and later. GDS only; not supported for NDC.

Result

Returns any error or warning message. See Error Messaging for details.

ReferenceList

Returned only when flight amenities were requested with the includeFlightAmenitiesInd query parameter.

Includes ReferenceListAmenity; see table below.

Reservation objects

The Reservation objects returns details on the booking itself.

Offer object - Air

Offer object - Hotel

Multi-content bookings include air and hotel and/or car content. 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. See Booking Guide for Air, Hotel, & Car for details and examples.

Just as with air, an instance of Offer is returned for each hotel booking on the reservation. Offer/Product is returned with @type ProductHospitality for hotel content. The table below outlines the Offer objects for hotel content. Price details also differ from air prices and are listed below.

Offer object - Car

Multi-content bookings include air and hotel and/or car content. 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. See Booking Guide for Air, Hotel, & Car for details and examples.

Just as with air, an instance of Offer is returned for each car booking on the reservation. Offer/Product is returned with @type ProductVehicle for car content. The table below details the Offer objects for car content. Price details also differ from air prices and are listed below.

Traveler object

Form of Payment object

Payment object

Receipt object

SpecialService object

ReservationComment object

PrimaryContact object

ReferenceList objects

Reservation Retrieve returns the ReferenceList object only if flight amenity details were requested with the includeFlightAmenitiesInd query parameter. Amenities are detailed in ReferenceList\ReferenceListAmenity per below.

 

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 with seats

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

 

Reservation Retrieve with flight amenity data

The following example shows RouteHappy flight amenity data returned when flight amenities are requested with the includeFlightAmenitiesInd query parameter.