This is an after-booking service. You need the OrderID and GDS Booking Reference to retrieve it.Once you have provided the OrderID and GDS Booking Reference as parameters to the AirDocRetrieve endpoint, the API will attempt to retrieve the ticket document details.
If the retrieval is successful, the API will return the ticket document details, which may include information such as the passenger’s name, flight details, fare information, and other relevant details.
It’s important to note that the AirDocRetrieve endpoint is a read-only service and cannot be used to make changes to the ticket document or booking .
Schema
Document
-
Name: Provide the name for the request. This is a String value.
-
ReferenceVersion: Provide the version number. This is a Numeric value.
Party
-
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 for the request. This is a String value.
-
Contacts: This is an Array.
- EmailContact: Provide the email contact for the request. This is a String value.
-
Query
-
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.
Request URL
curl --location --request POST 'https://uat-apigateway.voyzantonline.com/AirDocRetreive' \
--header 'Authorization: <YOUR_ACCESS_TOKEN>' \
--header 'x-api-key: <your key here>' \
--header 'Content-Type: application/json'\
Request Body Sample
{
"AirDocRetreiveRQ": {
"Document": {
"Name": "Voyzant Portal",
"ReferenceVersion": "1.0"
},
"Party": {
"Sender": {
"TravelAgencySender": {
"Name": "Voyzant Agency",
"IATA_Number": "1111111111",
"AgencyID": "1111111111",
"Contacts": {
"Contact": [
{
"emailcontact": "test@email.com"
}
]
}
}
}
},
"Query": {
"OrderID": "8MA8Y5MH",
"GdsBookingReference": [
"24IE8H"
]
}
}
}
Response Sample
{
"OrderViewRS": {
"Document": {
"Name": "API GATEWAY",
"ReferenceVersion": "1.2"
},
"Party": {
"Sender": {
"TravelAgencySender": {
"Name": "Voyzant Agency",
"IATA_Number": "",
"AgencyID": "Voyzant Agency",
"Contacts": {
"Contact": [
{
"EmailContact": "pst@voyzant.com"
}
]
}
}
}
},
"ShoppingResponseId": "1679569666281961234",
"Success": {},
"Order": [
{
"OrderID": "8MA8Y5MH",
"GdsBookingReference": "24IE8H",
"NeedToTicket": "N",
"OfferID": "3296198711679569691860213810",
"Owner": "LH",
"OwnerName": "Deutsche Lufthansa",
"IsBrandedFare": "Y",
"BrandedFareOptions": [],
"CabinOptions": [],
"IsAdditionalCabinType": "N",
"Eticket": "",
"TimeLimits": {
"OfferExpirationDateTime": "2023-03-23T13:13:40"
},
"BookingCurrencyCode": "CAD",
"EquivCurrencyCode": "CAD",
"HstPercentage": "",
"RewardSettings": {
"RewardAvailable": "N",
"PointTypes": [],
"PointValues": {}
},
"BookingFeeInfo": {
"FeeType": "",
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"TotalPrice": {
"BookingCurrencyPrice": 1311.3,
"EquivCurrencyPrice": 1311.3
},
"BasePrice": {
"BookingCurrencyPrice": 728,
"EquivCurrencyPrice": 728
},
"TaxPrice": {
"BookingCurrencyPrice": 583.3,
"EquivCurrencyPrice": 583.3
},
"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": "true",
"PassengerType": "ADT",
"PassengerQuantity": 1,
"TotalPriceDetail": {
"TotalAmount": {
"BookingCurrencyPrice": 1311.3,
"EquivCurrencyPrice": 1311.3
}
},
"Service": [
{
"ServiceID": "SV1",
"PassengerRefs": "ADT1",
"FlightRefs": "Flight1"
}
],
"FareDetail": {
"PassengerRefs": "ADT1",
"Price": {
"TotalAmount": {
"BookingCurrencyPrice": 1311.3,
"EquivCurrencyPrice": 1311.3
},
"BaseAmount": {
"BookingCurrencyPrice": 728,
"EquivCurrencyPrice": 728
},
"TaxAmount": {
"BookingCurrencyPrice": 583.3,
"EquivCurrencyPrice": 583.3
},
"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": "YQ",
"BookingCurrencyPrice": 422.8,
"EquivCurrencyPrice": 422.8
},
{
"TaxCode": "YR",
"BookingCurrencyPrice": 25.5,
"EquivCurrencyPrice": 25.5
},
{
"TaxCode": "IN",
"BookingCurrencyPrice": 5.9,
"EquivCurrencyPrice": 5.9
},
{
"TaxCode": "K3",
"BookingCurrencyPrice": 58.8,
"EquivCurrencyPrice": 58.8
},
{
"TaxCode": "P2",
"BookingCurrencyPrice": 19.5,
"EquivCurrencyPrice": 19.5
},
{
"TaxCode": "DE",
"BookingCurrencyPrice": 14.6,
"EquivCurrencyPrice": 14.6
},
{
"TaxCode": "RA",
"BookingCurrencyPrice": 34.3,
"EquivCurrencyPrice": 34.3
},
{
"TaxCode": "ZR",
"BookingCurrencyPrice": 1.9,
"EquivCurrencyPrice": 1.9
}
]
}
},
"FareComponent": [
{
"PriceClassRef": "PCR_1",
"SegmentRefs": "Segment1 Segment2",
"FareBasis": {
"FareBasisCode": {
"Refs": "FG_1 FG_1",
"Code": "WNCOWAA WNCOWAA"
},
"RBD": "W W",
"CabinType": "Y Y",
"SeatLeft": "9 9"
}
}
]
}
],
"BaggageAllowance": [
{
"SegmentRefs": "Segment1 Segment2",
"PassengerRefs": "ADT1",
"BaggageAllowanceRef": "Bag1"
}
],
"SplitPaymentInfo": [
{
"AirItineraryId": "3296198711679569691860213810",
"MultipleFop": "N",
"MaxCardsPerPax": 0,
"MaxCardsPerPaxInMFOP": 0
}
],
"BookingToEquivExRate": 1,
"FopRef": "FOP_1341_0_1987_0_ALL_PUB"
}
],
"DataLists": {
"PassengerList": {
"Passengers": [
{
"attributes": {
"PassengerID": "ADT1"
},
"PassengerID": "ADT1",
"PTC": "ADT",
"BirthDate": "2000-07-21",
"NameTitle": "Mr",
"FirstName": "downey",
"MiddleName": "",
"LastName": "Robert",
"Gender": "Male",
"TravelDocument": {
"DocumentNumber": "9658745",
"ExpiryDate": "2024-01-01",
"IssuingCountry": "CA",
"DocumentType": "P"
},
"Preference": {
"WheelChairPreference": {
"Reason": ""
},
"SeatPreference": "any"
},
"LoyaltyProgramAccount": [],
"ContactInfoRef": "CTC1"
}
]
},
"DisclosureList": {
"Disclosures": []
},
"contactEmail": [
"kathir@gmail.com"
],
"contactNumber": [
"9854785465"
],
"ContactAddress": [
"kovil Street"
],
"FareList": {
"FareGroup": [
{
"FareGroupRef": "FG_1",
"FareCode": "70J",
"FareBasisCode": "WNCOWAA"
}
]
},
"FlightSegmentList": {
"FlightSegment": [
{
"SegmentKey": "Segment1",
"Departure": {
"AirportCode": "MAA",
"Date": "2023-04-22",
"Time": "01:50:00",
"AirportName": "Chennai International Airport",
"Terminal": {
"Name": "4"
}
},
"Arrival": {
"AirportCode": "FRA",
"Date": "2023-04-22",
"Time": "08:25:00",
"AirportName": "Frankfurt am Main International Airport",
"Terminal": {
"Name": "1"
}
},
"MarketingCarrier": {
"AirlineID": "LH",
"Name": "Deutsche Lufthansa",
"FlightNumber": "759"
},
"OperatingCarrier": {
"AirlineID": "LH",
"Name": "Deutsche Lufthansa",
"FlightNumber": "759"
},
"Equipment": {
"AircraftCode": "Airbus A340-300",
"Name": "Airbus A340-300"
},
"Code": {
"MarriageGroup": ""
},
"FlightDetail": {
"FlightDuration": {
"Value": "10 Hrs 5 Min"
},
"Stops": {
"Value": 0
},
"InterMediate": [],
"AirMilesFlown": "0"
},
"BrandId": ""
},
{
"SegmentKey": "Segment2",
"Departure": {
"AirportCode": "FRA",
"Date": "2023-04-22",
"Time": "14:10:00",
"AirportName": "Frankfurt am Main International Airport",
"Terminal": {
"Name": "1"
}
},
"Arrival": {
"AirportCode": "DXB",
"Date": "2023-04-22",
"Time": "22:35:00",
"AirportName": "Dubai International Airport",
"Terminal": {
"Name": "1"
}
},
"MarketingCarrier": {
"AirlineID": "LH",
"Name": "Deutsche Lufthansa",
"FlightNumber": "630"
},
"OperatingCarrier": {
"AirlineID": "LH",
"Name": "Deutsche Lufthansa",
"FlightNumber": "630"
},
"Equipment": {
"AircraftCode": "",
"Name": ""
},
"Code": {
"MarriageGroup": ""
},
"FlightDetail": {
"FlightDuration": {
"Value": "6 Hrs 25 Min"
},
"Stops": {
"Value": 0
},
"InterMediate": [],
"AirMilesFlown": "0"
},
"BrandId": "ECOFLEX"
}
]
},
"FlightList": {
"Flight": [
{
"FlightKey": "Flight1",
"Journey": {
"Time": "22 H 15 M",
"Stops": 1
},
"SegmentReferences": "Segment1 Segment2"
}
]
},
"OriginDestinationList": {
"OriginDestination": [
{
"OriginDestinationKey": "OD1",
"DepartureCode": "MAA",
"ArrivalCode": "DXB",
"FlightReferences": "Flight1"
}
]
},
"PriceClassList": {
"PriceClass": [
{
"PriceClassID": "PCR_1",
"Name": "Economy flex",
"Code": "Economy flex",
"Descriptions": {
"Description": []
}
}
]
},
"BaggageAllowanceList": {
"BaggageAllowance": [
{
"BaggageAllowanceID": "Bag1",
"BaggageCategory": "Checked",
"AllowanceDescription": {
"ApplicableParty": "Traveler",
"Description": "CHECKED ALLOWANCE"
},
"PieceAllowance": {
"ApplicableParty": "Traveler",
"TotalQuantity": "1",
"Unit": "Pieces"
}
}
]
},
"FopList": [
{
"CC": {
"Allowed": "Y",
"Types": {
"AX": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"MC": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"VI": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"JC": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"DC": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"DUS": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"MA": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"DS": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"TP": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
}
}
},
"DC": {
"Allowed": "Y",
"Types": {
"MC": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"VI": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"RU": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
}
}
},
"CASH": {
"Allowed": "N",
"Types": {}
},
"CHEQUE": {
"Allowed": "Y",
"Types": {}
},
"ACH": {
"Allowed": "Y",
"Types": {}
},
"PG": {
"Allowed": "N",
"Types": {}
},
"FopKey": "FOP_1341_0_1987_0_ALL_PUB"
}
]
},
"TicketDocInfos": {
"TicketDocInfo": [
{
"TicketDocument": {
"TicketDocNbr": "2201116586159",
"Type": "TKT"
},
"PassengerReference": "ADT1",
"GdsBookingReference": "24IE8H"
}
]
},
"MetaData": {}
}
}