PNR Retrieve API Reference
This topic provides the endpoint and objects for the request payload and response for a PNR Retrieve.
In this topic:
PNR Retrieve
Query Parameters
None.
POST Request
Send the POST request to the following resource:
POST book/reservation/reservations/(PNR)
Base path:
Pre-production https://api.pp.travelport.com/9/air/
Production https://api.travelport.com/9/air/
Payload
None.
Response
The information returned in the PNR Retrieve response varies depending on has been added to the PNR at the time of retrieve and whether the PNR has been ticketed.
The ReservationResponse object detailed here is returned for PNR Retrieve and for several other requests, including workbench commits and a post-commit create workbench request.
Note that a cancelled PNR can be retrieved, but the response does not return any offer-related objects. See Cancelling a PNR.
Object |
Description |
---|---|
ReservationResponse |
Top level object for response. May include Offer, Traveler, FormOfPayment, Payment, Receipt, and ReservationComment objects. |
Offer |
Array. Each instance returns details about one offer on the PNR. An offer could be the flight/s, seats, or a paid ancillary. See table below. |
FormOfPayment |
|
Traveler |
Array. One instance for each unique traveler on the PNR. See table below. |
Receipt |
Array. One instance for each receipt confirmation. See table below. |
Object |
Description |
---|---|
Offer |
Array. Each instance returns details about one offer on the PNR. An offer could be the flight/s, seats, or a paid ancillary. Key value pair:
Includes Identifier, Product, Price, TermsAndConditionsFull. |
Product |
Array. Each instance returns details for one product on this offer. See Product table below. |
Price |
Total price and price breakdown for this offer. See Price table below. |
TermsAndConditionsFull |
Terms and conditions for this offer. See TermsAndConditionsFull table below. |
ReferenceList |
May be returned to consolidate common details across flights, such as terms and conditions or flight details. See the Search API Reference for ReferenceList details. |
Object | Description |
---|---|
ReservationResponse |
Top level object for response. Includes Reservation object. |
Reservation |
Top level object for reservation details. Includes Identifier, Offer, Traveler, and Receipt objects. |
Identifier |
Key value pairs:
|
Offer |
Key value pair:
Includes Identifier, Product, Price, TermsAndConditionsFull. If a seat or seats were selected, a second instance of Offer is returned. This instance returns seats details in the following:
|
Identifier Product Price TermsAndConditionsFull |
These objects are the same as in the AirPrice response; see the table in the AirPrice API Reference for full descriptions. The indicator boundFlightsInd for bound/married segments, when true, is returned in the PNR retrieve response for releases
|
Traveler |
All traveler information sent in the reservation request is returned here. Depending on the information sent in the request, the objects returned may include PersonName, Address, Telephone, Email, CustomerLoyalty, and TravelDocument. See the Add Traveler table above for details. All email addresses are associated with the first traveler on the PNR.
|
TravelerProduct |
Returned if a seat or seats were selected. Includes OfferRef to note the seat offer reference. |
Receipt |
One or more instances of a receipt confirmation. Each instance represents the status of one PNR. For example, if a reservation has one PNR from the provider and another PNR from the carrier, two Receipt objects are returned. If an itinerary has been ticketed, ticket details are returned in an additional instance of Receipt of/type ReceiptPayment, with the ticket number in the Document/Number object. Receipt instances of/type ReceiptConfirmation include the Identifier and Confirmation objects per below. |
Receipt/Identifier
|
Key value pairs:
|
Confirmation |
Includes Locator and OfferStatus objects. |
Locator |
PNR locator details. Key value pairs:
|
OfferStatus |
Contains the StatusAir object. |
StatusAir |
Returns confirmation status for each flight on the itinerary. Key value pairs:
|
FormOfPayment |
Returned if FormOfPayment (FOP) has been added. Always returned if the itinerary has been ticketed. Includes Identifier object and either PaymentCard or Cash object depending on the form of payment used. See the Ticket Issue API Reference for details. |
Payment |
Payment details if Payment has been added. Always returned if the itinerary has been ticketed. |
ReservationComment |
If general, back office, or OSI remarks were added during the reservation workflow, those comments are returned in ReservationComment, for GDS only. Comments from carriers may also be returned in ReservationComment per the example below. Comments from the carrier are identified by a value of Supplier in ReservationComment/commentSource, and for ticketless carriers the value Ticketless is returned in Comment/name. Remarks are not returned for other providers or for NDC itineraries. Key value pair:
Includes Comment object.
|
Comment |
Key value pairs:
|
ReferenceList |
May be returned to consolidate common details across flights, such as terms and conditions or baggage allowances. |