The AirOrderRetreive is a service that has to be used once a PNR has been created, this service offers functionality to search for and retrieve particular PNR data.
You need to provide the OrderID and GDS Booking Reference to retrieve the PNR details. Once you have provided them as parameters, our system will search for the GDS and its relevant PCC from which the booking has been made and it will attempt to retrieve the PNR data.
If the retrieval is successful, our system will return the PNR details, which may include information such as the passenger’s name, flight details, fare information, and other booking data. Also, this service is used to retrieve the current status of the PNR.
It’s important to note that this endpoint is a read-only service and cannot be used to make changes to the booking.
Note: GDS-Global Distribution System. Note: PCC-Pseudo City Code.
Schema
-
Name: Provide the name for the request. This is a String value.
-
ReferenceVersion: Provide the version number. This is a Numeric value.
-
Travel Agency Sender:
-
Name: Provide the name for the request. This is a String value.
-
IATA Number: Provide the IATA number for the request. This is a String value.
-
Agency ID: Provide the agency ID. This is a String value.
-
Contacts: This is an Array.
- EmailContact: Provide the email contact for the request. This is a String value.
-
-
OrderID: This is the unique identifier that is typically provided by the airline at the time of booking. This is the required field, and the value will be String.
-
GDSBookingReference: This is the code that is used by GDS to identify the booking. The GDS booking references are typically provided by the airlines at the time of booking. This is the required field, and the value will be the String.
It is multiple when it’s a one-way offer.
Request URL
curl --location --request POST 'https://newapi.tltid.com/AirOrderRetreive' \
--header 'Authorization: <YOUR_ACCESS_TOKEN>' \
Request Body Sample
{
"OrderRetreiveRQ": {
"Document": {
"Name": "Venkat B2B portal",
"referenceversion": "1.0"
},
"party": {
"sender": {
"travelagencysender": {
"name": "mrst",
"iata_number": "",
"agencyid": "",
"contacts": {
"contact": [
{
"emailcontact": "pst@claritytts.com"
}
]
}
}
}
},
"Query": {
"OrderID": "60ZPNZTI",
"GdsBookingReference": [
"OUZMYO"
]
}
}
}
Response Sample
{
"OrderViewRS": {
"Document": {
"Name": "API GATEWAY",
"ReferenceVersion": "1.2"
},
"Party": {
"Sender": {
"TravelAgencySender": {
"Name": "Lucky Travels",
"IATA_Number": "",
"AgencyID": "",
"Contacts": {
"Contact": [
{
"EmailContact": "pst@claritytts.com"
}
]
}
}
}
},
"ShoppingResponseId": "1678878409066630254",
"Success": {},
"Payments": {
"Payment": [
{
"Type": "CHECK",
"PassengerID": "ALL",
"Amount": 642.26,
"ChequeNumber": "323325"
}
]
},
"Order": [
{
"OrderID": "60ZPNZTI",
"GdsBookingReference": "OUZMYO",
"OrderStatus": "BOOKED",
"PaymentStatus": "PAID",
"TicketStatus": "NOT TICKETED",
"NeedToTicket": "N",
"OfferID": "137211721101678878414495216684",
"Owner": "WS",
"OwnerName": "Westjet",
"IsBrandedFare": "Y",
"BrandedFareOptions": [],
"CabinOptions": [],
"IsAdditionalCabinType": "N",
"Eticket": "",
"TimeLimits": {
"OfferExpirationDateTime": "2023-03-15T13:20:18"
},
"BookingCurrencyCode": "CAD",
"EquivCurrencyCode": "CAD",
"HstPercentage": "",
"RewardSettings": {
"RewardAvailable": "N",
"PointTypes": [],
"PointValues": {}
},
"BookingFeeInfo": {
"FeeType": "",
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"TotalPrice": {
"BookingCurrencyPrice": 232.35,
"EquivCurrencyPrice": 232.35
},
"BasePrice": {
"BookingCurrencyPrice": 195,
"EquivCurrencyPrice": 195
},
"TaxPrice": {
"BookingCurrencyPrice": 37.35,
"EquivCurrencyPrice": 37.35
},
"Commission": {
"AgencyCommission": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"AgencyYqCommission": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"PortalCharges": {
"Markup": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Surcharge": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Discount": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"AgentMarkupInfo": {
"OnflyMarkup": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"OnflyDiscount": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"OnflyHst": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"PromoDiscount": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0,
"PromoCode": ""
}
},
"Penalty": {
"ChangeFee": {
"Before": {
"BookingCurrencyPrice": "NA",
"EquivCurrencyPrice": "NA"
},
"After": {
"BookingCurrencyPrice": "NA",
"EquivCurrencyPrice": "NA"
}
},
"CancelationFee": {
"Before": {
"BookingCurrencyPrice": "NA",
"EquivCurrencyPrice": "NA"
},
"After": {
"BookingCurrencyPrice": "NA",
"EquivCurrencyPrice": "NA"
}
}
},
"PaxSeatInfo": [],
"OfferItem": [
{
"OfferItemID": "OFFERITEMID1",
"Refundable": "0",
"PassengerType": "ADT",
"PassengerQuantity": 1,
"TotalPriceDetail": {
"TotalAmount": {
"BookingCurrencyPrice": 232.35,
"EquivCurrencyPrice": 232.35
}
},
"Service": [
{
"ServiceID": "SV1",
"PassengerRefs": "ADT1",
"FlightRefs": "Flight1"
}
],
"FareDetail": {
"PassengerRefs": "ADT1",
"Price": {
"TotalAmount": {
"BookingCurrencyPrice": 232.35,
"EquivCurrencyPrice": 232.35
},
"BaseAmount": {
"BookingCurrencyPrice": 195,
"EquivCurrencyPrice": 195
},
"TaxAmount": {
"BookingCurrencyPrice": 37.35,
"EquivCurrencyPrice": 37.35
},
"Commission": {
"AgencyCommission": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"AgencyYqCommission": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"BookingFee": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"PortalCharges": {
"Markup": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Surcharge": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Discount": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"Taxes": [
{
"TaxCode": "RC",
"BookingCurrencyPrice": 15.23,
"EquivCurrencyPrice": 15.23
},
{
"TaxCode": "SQ",
"BookingCurrencyPrice": 15,
"EquivCurrencyPrice": 15
},
{
"TaxCode": "CA",
"BookingCurrencyPrice": 7.12,
"EquivCurrencyPrice": 7.12
}
]
}
},
"FareComponent": [
{
"PriceClassRef": "PCR_1",
"SegmentRefs": "Segment1 Segment2",
"FareBasis": {
"FareBasisCode": {
"Refs": "FG_1 FG_1",
"Code": "ACUD0ZBJ ACUD0ZBJ"
},
"RBD": "A A",
"CabinType": "Y Y",
"SeatLeft": "9 1"
}
}
]
}
],
"BaggageAllowance": [
{
"SegmentRefs": "Segment1 Segment2",
"PassengerRefs": "ADT1",
"BaggageAllowanceRef": "Bag1"
}
],
"SplitPaymentInfo": [
{
"AirItineraryId": "137211721101678878414495216684",
"MultipleFop": "N",
"MaxCardsPerPax": 0,
"MaxCardsPerPaxInMFOP": 0
}
],
"BookingToEquivExRate": 1,
"FopRef": "FOP_429_0_1172_0_ALL_PUB"
}
],
"DataLists": {
"PassengerList": {
"Passengers": [
{
"attributes": {
"PassengerID": "ADT1"
},
"PassengerID": "ADT1",
"PTC": "ADT",
"BirthDate": "1996-03-15",
"NameTitle": "Mr",
"FirstName": "LEBRON",
"MiddleName": "",
"LastName": "JAMES",
"Gender": "Male",
"TravelDocument": {
"DocumentNumber": "",
"ExpiryDate": "2001-01-01",
"IssuingCountry": "",
"DocumentType": "P"
},
"Preference": {
"WheelChairPreference": {
"Reason": ""
},
"SeatPreference": "any"
},
"LoyaltyProgramAccount": [],
"ContactInfoRef": "CTC1"
}
]
},
"DisclosureList": {
"Disclosures": []
},
"contactEmail": [
"kathir@gmail.com"
],
"contactNumber": [
"9854785465"
],
"ContactAddress": [
"testing address1"
],
"FareList": {
"FareGroup": [
{
"FareGroupRef": "FG_1",
"FareCode": "70J",
"FareBasisCode": "ACUD0ZBJ"
}
]
},
"FlightSegmentList": {
"FlightSegment": [
{
"SegmentKey": "Segment1",
"Departure": {
"AirportCode": "YKF",
"Date": "2023-05-19",
"Time": "16:25:00",
"AirportName": "Waterloo Airport",
"Terminal": {
"Name": ""
}
},
"Arrival": {
"AirportCode": "YYC",
"Date": "2023-05-19",
"Time": "18:30:00",
"AirportName": "Calgary International Airport",
"Terminal": {
"Name": ""
}
},
"MarketingCarrier": {
"AirlineID": "WS",
"Name": "Westjet",
"FlightNumber": "557"
},
"OperatingCarrier": {
"AirlineID": "WS",
"Name": "Westjet",
"FlightNumber": "557"
},
"Equipment": {
"AircraftCode": "73W",
"Name": "Boeing 737-700 (winglets) pax"
},
"Code": {
"MarriageGroup": ""
},
"FlightDetail": {
"FlightDuration": {
"Value": "4 Hrs 5 Min"
},
"Stops": {
"Value": 0
},
"InterMediate": [],
"AirMilesFlown": "1646"
},
"BrandId": "BASIC"
},
{
"SegmentKey": "Segment2",
"Departure": {
"AirportCode": "YYC",
"Date": "2023-05-19",
"Time": "20:00:00",
"AirportName": "Calgary International Airport",
"Terminal": {
"Name": ""
}
},
"Arrival": {
"AirportCode": "YVR",
"Date": "2023-05-19",
"Time": "20:32:00",
"AirportName": "Vancouver International Airport",
"Terminal": {
"Name": "M"
}
},
"MarketingCarrier": {
"AirlineID": "WS",
"Name": "Westjet",
"FlightNumber": "66"
},
"OperatingCarrier": {
"AirlineID": "WS",
"Name": "Westjet",
"FlightNumber": "66"
},
"Equipment": {
"AircraftCode": "7M8",
"Name": "7M8"
},
"Code": {
"MarriageGroup": ""
},
"FlightDetail": {
"FlightDuration": {
"Value": "1 Hrs 32 Min"
},
"Stops": {
"Value": 0
},
"InterMediate": [],
"AirMilesFlown": "428"
},
"BrandId": "BASIC"
}
]
},
"FlightList": {
"Flight": [
{
"FlightKey": "Flight1",
"Journey": {
"Time": "7 H 7 M",
"Stops": 1
},
"SegmentReferences": "Segment1 Segment2"
}
]
},
"OriginDestinationList": {
"OriginDestination": [
{
"OriginDestinationKey": "OD1",
"DepartureCode": "YKF",
"ArrivalCode": "YVR",
"FlightReferences": "Flight1"
}
]
},
"PriceClassList": {
"PriceClass": [
{
"PriceClassID": "PCR_1",
"Name": "Basic",
"Code": "Basic",
"Descriptions": {
"Description": []
}
}
]
},
"BaggageAllowanceList": {
"BaggageAllowance": [
{
"BaggageAllowanceID": "Bag1",
"BaggageCategory": "Checked",
"AllowanceDescription": {
"ApplicableParty": "Traveler",
"Description": "CHECKED ALLOWANCE"
},
"PieceAllowance": {
"ApplicableParty": "Traveler",
"TotalQuantity": "0",
"Unit": "kg"
}
}
]
},
"FopList": [
{
"CC": {
"Allowed": "Y",
"Types": {
"AX": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0,
"Charges": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"MC": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0,
"Charges": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"VI": {
"F": {
"BookingCurrencyPrice": "0",
"EquivCurrencyPrice": "0"
},
"P": 0,
"Charges": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
}
}
},
"DC": {
"Allowed": "Y",
"Types": {
"MC": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0,
"Charges": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"VI": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0,
"Charges": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
},
"RU": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0,
"Charges": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
}
}
},
"CASH": {
"Allowed": "N",
"Types": {}
},
"CHEQUE": {
"Allowed": "Y",
"Types": {}
},
"ACH": {
"Allowed": "Y",
"Types": {}
},
"PG": {
"Allowed": "N",
"Types": {}
},
"FopKey": "FOP_429_0_1172_0_ALL_PUB"
}
]
},
"MetaData": {}
}
}