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:

id: Internal short identifier for the offer.

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:

  • authority: Returns the value Travelport.
  • value: Internal transaction identifier for that offer.

Offer

Key value pair:

  • id: Internal identifier for the offer.

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:
  • id: Attribute with the seat offer ID.
  • Product: Object with seat details in the following objects:
    • Ancillary: Includes FlightRef, which returns a flight identifier.
    • SeatAssignment: The number of the selected seat for the flight in FlightRef.

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 20.9.2 and later. This indicator is returned in the search APIs and AirPrice and is documented in the AirPrice API Reference. This indicator is not returned when false.

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:

  • authority: Returns the value Travelport.
  • value: Internal transaction identifier.

Confirmation

Includes Locator and OfferStatus objects.

Locator

PNR locator details.

Key value pairs:

  • source: Provider on which the PNR was created.
  • sourceContext: The PCC used for booking. Returned only in the provider's receipt confirmation, not returned in the carrier's receipt confirmation.
  • value: The PNR locator code.

OfferStatus

Contains the StatusAir object.

StatusAir

Returns confirmation status for each flight on the itinerary.

Key value pairs:

  • flightRefs: List of flight IDs to which this status applies.
  • code: IATA standard 2-byte status code for the reservation, e.g., HK or XX.
  • value: The accompanying enumeration for the status code, e.g., Confirmed or Cancelled

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:

  • commentSource: Source of the comment.

Includes Comment object.

  "ReservationComment": [
    {
    "@type": "ReservationComment",
    "commentSource": "Supplier",
    "shareWithSupplier": [
        "NK"
    ],
    "Comment": [
        {
        "name": "Ticketless",
        "value": "VIXXXXXXXXXXXX5550/D0422/RAMA SARAVANA"
        },
        {
        "name": "Ticketless",
        "value": "ADTK1GTONK ON/BEFORE 20JUN 1023Z OTHERWISE WILL BE XLD"
        },
        {
        "name": "Ticketless",
        "value": "MOST FARES EXCL GOV FARES REQUIRE TKT WITHIN 24 HRS"
        },
        ]
      }
    ],

Comment

Key value pairs:

  • name: Name assigned to the comment.
  • value: Text of the comment.

ReferenceList

May be returned to consolidate common details across flights, such as terms and conditions or baggage allowances.