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.

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

Either the ticket number or locator code is required.

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

Use Reservation Retrieve to retrieve details about a booking. If the booking has been ticketed, Reservation Retrieve returns booking, payment, and ticketing details.

The JSON Air APIs provide the following APIs to retrieve bookings and tickets:

  • To retrieve all booking details, use Reservation Retrieve. Returns all booking, payment, and ticketing information currently on a booking,

  • To retrieve a list of all ticket numbers on a reservation, use Ticket List.

  • To retrieve details for all tickets associated with a record locator (GDS only), or for a single ticket for NDC, use Ticket Retrieve.

  • To return a list of documents on a booking, including tickets, invoices, MCOs, and EMDs, use Document List.

  • To return histories of up to six documents on with a booking, including tickets, invoices, MCOs, and EMDs, use Document History.

Reservation Retrieve and Post-Commit Workbench return air, hotel, and/or car segments for any reservation that includes that content, called a multi-content booking. All segments must have been booked with the JSON Air APIs, JSON Hotel APIs, JSON Car APIs (release pending), or a Travelport+ terminal program. You can add either GDS or NDC air offers to a hotel and/or car booking, but not both. See the Multi-content Booking Guide (Air, Hotel, Car) for workflows and examples.

Request

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

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

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

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

fareRuleType

Enumeration for the type of fare rules requested. Supported values:

  • Structured (note that to return structured fare rules, brand pricing must have been requested in the AirPrice request with returnBrandedFaresInd=true)

  • LongText

  • ShortText

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

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:

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 using the Travelport JSON APIs or another program.

The basic ReservationResponse detailed here is returned for Reservation Retrieve and for these requests. Note that because the two requests do not support the query parameters available in Reservation Retrieve, they do not return all of the data in the table.

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. See Reservation Objects table immediately below for details.

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.

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, download the developer toolkits and see Using Postman and Developer Toolkits.

The following example shows a reservation retrieve for a one-way NDC held booking.

Reservation Retrieve - ticketed one-way GDS itinerary

The following example shows a ticketed one-way GDS itinerary.

For comparison purposes, note that the example booking shown here, with Travelport locator code BXPJVM, is also shown in the Commit Workbench API Reference examples for the commit response for both the initial booking workbench and the ticketing workbench, and in the Workbench Create for a in the Reservation Retrieve.

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.