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.
In the context of schedule changes, the parameter ScheduleChangeIndicator is set to “true.” This indicates that there have been schedule changes within the PNR. These changes could involve alterations to the flight timings, departure or arrival dates, or any other schedule-related updates. By using this indicator, users will receive information about the new segments resulting from the schedule changes. If interested in accepting these new segments,proceed with the necessary steps.
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://uat-apigateway.voyzantonline.com/AirOrderRetreive' \
--header 'Authorization: <YOUR_ACCESS_TOKEN>' \
--header 'x-api-key: <your key here>' \
--header 'Content-Type: application/json'\
Request Body Sample
{
"OrderRetreiveRQ": {
"Document": {
"Name": "
Voyzant API GATEWAY",
"referenceversion": "1.0"
},
"party": {
"sender": {
"travelagencysender": {
"name": "Voyzant Agency",
"iata_number": "",
"agencyid": "",
"contacts": {
"contact": [
{
"emailcontact": "pst@voyzant.com"
}
]
}
}
}
},
"Query": {
"OrderID": "60ZPNZTI",
"GdsBookingReference": [
"OUZMYO"
]
}
}
}
Response Sample
{
"OrderRetrieveRS": {
"Document": {
"Name": "API GATEWAY",
"ReferenceVersion": "1.0"
},
"Party": {
"Sender": {
"TravelAgencySender": {
"Name": "Voyzant Agency",
"IATA_Number": "",
"AgencyID": "Voyzant Agency",
"Contacts": {
"Contact": [
{
"EmailContact": "pst@voyzant.com"
}
]
}
}
}
},
"ShoppingResponseId": "1679558717852165006",
"Success": {},
"Order": [
{
"PNR": "4ZT3DN",
"Status": "Success",
"BookingStatus": "BOOKED",
"PaymentStatus": "PAID",
"TicketStatus": "NOT TICKETED",
"AirSegment": {},
"FareInfo": {},
"PaxSeats": {},
"Passenger": {},
"TicketDetails": [],
"PaxSSR": {},
"CustomerInfo": {},
"ContactInfo": {},
"PCC": "",
"HomePCC": "",
"AAA_PCC": "",
"ReceivedFrom": "",
"CreationAgent": "",
"FareType": "PRI",
"CabinType": "Y",
"Flights": [
{
"FlightTime": "",
"Segments": [
{
"AirSegmentLine": 1,
"ConnectionIndicator": "",
"Baggage": {
"Weight": 0,
"Unit": "kg"
},
"Meal": "",
"CabinType": "Y",
"FareBasisCode": "NLX79NBL/AU330",
"AirMilesFlown": 0,
"IntermediatePointInfo": [],
"ResBookDesigCode": "N",
"MarriageGroup": "O",
"StopQuantity": "0",
"AirEquipmentType": "772",
"DepartureAirport": "YYZ",
"DepartureDateTime": "2023-04-17T23:15:00",
"ArrivalAirport": "CDG",
"ArrivalDateTime": "2023-04-18T12:35:00",
"TravelTime": "7 H 20 M",
"FlightNumber": "357",
"MarketingAirline": "AF",
"OperatingAirline": "AF",
"OperatingAirlineFlightNumber": "357",
"SegmentStatus": "HK",
"SegmentNumber": "1",
"Segmentpnr": "4ZT3DN",
"FareBasisGroup": 0
}
]
}
],
"PassengerData": {
"Passenger": [
{
"attributes": {
"PassengerID": "ADT1"
},
"PTC": "ADT",
"BirthDate": "21JUL2000",
"NameTitle": "MR",
"FirstName": "DOWNEY",
"LastName": "ROBERT",
"Gender": "M",
"PaxReference": "2",
"Passport": {
"Number": "9658745",
"IssuingCountry": "CA",
"Nationality": "CA",
"BirthDate": "21JUL2000",
"Expiry": "01JAN1924"
}
}
]
},
"FareCurrency": "CAD",
"ValidatingCarrier": "AF",
"ADT": 1,
"CHD": 0,
"INF": 0,
"ContactAddress": [
"KATHIR",
"KOVIL STREET",
"CHENNAI",
"AX 600028",
"CANADA"
],
"ContactEmail": [
"KATHIR@GMAIL.COM"
],
"ContactNumber": [
"9854785465"
],
"DKNumber": "6379770581",
"PQCount": 1,
"IsManualFare": 0,
"RetentionSegment": [
{
"elementManagementItinerary": {
"reference": {
"qualifier": "ST",
"number": "2"
},
"segmentName": "RU",
"lineNumber": "3"
},
"travelProduct": {
"product": {
"depDate": "101023"
},
"boardpointDetail": {
"cityCode": "YYZ"
},
"companyDetail": {
"identification": "1A"
}
},
"itineraryMessageAction": {
"business": {
"function": "32"
}
},
"relatedProduct": {
"quantity": "1",
"status": "HK"
},
"itineraryFreetext": {
"freetextDetail": {
"subjectQualifier": "3"
},
"longFreetext": "*RETENTION"
},
"markerRailTour": ""
}
],
"FOPDetails": {
"Mode": "CARD",
"CardType": "CC",
"CardCode": "MC",
"CardHolderName": "PRIYA",
"CardNumber": "5299920210000277",
"ExpiryMonth": "05",
"ExpiryYear": "2024",
"ChequeNumber": ""
},
"HstPercentage": 0,
"LastTicketDate": "",
"Refundable": "Y",
"ItinFareInfo": [
{
"ApiTotalFare": 677.96,
"ApiBaseFare": 250,
"ApiTaxFare": 427.96,
"ApiPaxType": "ADT",
"PaxType": "ADT",
"PaxQuantity": 1,
"TaxDetails": [
{
"TaxCode": "CA",
"TaxAmount": 25.91
},
{
"TaxCode": "YQ",
"TaxAmount": 25
},
{
"TaxCode": "YR",
"TaxAmount": 337.5
},
{
"TaxCode": "RC",
"TaxAmount": 4.55
},
{
"TaxCode": "SQ",
"TaxAmount": 35
}
],
"Baggage": {
"Weight": 0,
"Unit": "Kg"
}
}
],
"PaxSeatInfo": [],
"CCBillingInfo": {
"CardHolderName": "",
"AddressLine1": "",
"AddressLine2": "",
"City": "",
"State": "",
"Country": "",
"PostalCode": ""
},
"FareQuoteData": {},
"Ctcm": "9856325698",
"SegmentTattoNumber": [
1
],
"connectionExits": "N",
"Ctce": "MOSRIS@GMAIL.COM",
"cardVisible": true,
"ImportPnrVersion2Allowed": "Y",
"PassportRequired": "N",
"SalutationRequired": "N",
"MultipleFop": "N",
"NameUpdateAllowed": "N",
"DobUpdateAllowed": "Y",
"EmailUpdateAllowed": "Y",
"PhoneUpdateAllowed": "Y",
"DkNumberUpdateAllowed": "Y",
"SeatMapUpdateAllowed": "Y",
"AncillariesUpdateAllowed": "Y",
"ItineraryId": "3296198721679558734648373563"
}
]
}
}