AirOrderCreateV2 endpoint can be used to create a new airline reservation by specifying various parameters, such as Offer ID, Shopping Response ID, Offer Response ID, Seat Response ID, Itinerary ID, and a few more parameters.
In the context of airline reservations, a PNR (Passenger Name Record) is a unique identifier used to manage a traveller’s reservation and it contains all the information related to a particular reservation, such as the passenger’s name, flight itinerary, seat assignments, and pricing information.
Once the user specifies the necessary parameters and submits the AirOrderCreateV2 request, the system will create a new PNR to manage the reservation.
In addition to this, we can use Multiple Forms Of Payment (MFOP) with card, check, or payment gateway to order the booking confirmation for the same or different passenger types.
We also provide 3DS support for credit and debit card transactions, which acts as a additional layer of security and to reduce the risk of unauthorized charges during online transactions. The api continues to provide response without these parameters.
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 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.
-
The Shopping Response ID is a unique identifier that is generated when a customer performs a search for flights and receives a list of available options.
This is the required field and the value will be Numeric.
The airline booking system generates an OfferResponseID to identify the specific offer. This ID is unique to that particular offer so that it is important to provide the correct numeric value to ensure that the system can identify the correct offer
This is the required field, and the value will be Numeric.
-
Tracking: Valid values are
YandN. This is a String value. -
PassengerMetadata:
-
SpecialServiceRequest: This is an Array.
-
PassengerID: This is the Passenger ID. This is a String value.
-
Origin: This is the Origin. This is a String value.
-
Destination: This is the Destination. This is a String value.
-
DepartureDateTime: This is the Departure date and time. This is a String value.
-
MarketingFlightNumber: This is the Marketing flight number. This is a Numeric value.
-
MarketingCarrier: This is the Marketing carrier. This is a String value.
-
SsrType: This is the Ssr type. This is a String value.
-
SsrCode: This is the Ssr code. This is a String value.
-
FreeText: This is the Free text. This is a String value.
-
-
-
OfferID: When a customer performs a search for flights, the airline generates a list of available offers that meet the customer’s search criteria. Each offer within that list is assigned a unique OfferID.It is important to provide the correct numeric value to ensure that the system can identify the correct offer.This is the required field, and the value will be Numeric.
-
ServiceList: This is an Array and optional field.
-
OptinalServiceId: Provide the optional service ID. This is a String value.
-
PassengerID: Provide the passenger ID. This is a String value.
-
-
Seat: This is an Array and optional field.
-
SeatId: Provide the seat ID. This is a String value.
-
PassengerID: Provide the passenger ID. This is a String value.
-
Book and Hold. If the value selected is Hold then payment has to be confirmed before confirming the order.
-
SecurePayment: This is a required field. This object is needed if 3D-Secure payment is required. (New Proposed Object for 3DS).
-
WebpushURL: This is a required field. Provide a custom endpoint URL, the response for the AirOrderCreateV2 will be supplied to this endpoint.
-
SecurePaymentVersion2: This is a required field. This object is needed if 3D-Secure payment is required.
-
DeviceDetails: This is a required field. Supply the device details in this object.
-
Method:
- challengeWindowSize: Provide the browser window size. This is a String value.
- browserUserAgent: Provide the browser being used. This is a String value.
- browserJavaEnabled: Provide whether Java is enabled in the browser or not. This is a String value. The value is either true or false.
- browserScreenHeight: Provide the screen height of the browser window. This is a String value.
- browserScreenWidth: Provide the screen width of the browser window. This is a String value.
- browserLanguage: Provide the language currently being used in the browser. This is a String value.
- ipAddress: Provide the IP address of the client system. This is a String value.
-
-
-
Payment:
This is an Array
-
Type: This is a required field. Provide the payment type. Valid values are
CardandCheque. -
Amount: This is a required field. Provide the amount. This is a Numeric value.
-
Method:
- CardCode: Provide the card code. This is a String value.
For Card Type CC possible Card Codes are AX, DC, DI, DUS, JC, MA, MC, VI.
For Card Type DC possible Card Codes are MC, RU, and VI.
-
CardNumber: Provide the card number. This is a String value.
-
SeriesCode: Provide the card number. This is a String value.
-
CardHolderName: Provide the card holder’s name. This is a String value.
-
EffectiveExpireDate: Provide the Effective date and Expiration date. This is a String value.
-
Payer:
- ContactInfoRefs:
-
Passenger: This is an Array.
Note: This is a required field. The passenger list must have at least one adult. Infant object count should be less than or equal to adult count. Total pax should be less than or eqaul to 9.
-
PassengerID: Provide the passenger ID for the request. This is a String value.
-
PTC: Valid values are
ADT,CHD, andINF. This is a String value. -
OnflyMarkup: This is an optional field. This is a String value.
-
OnflyDiscount: This is an optional field. This is a String value.
-
OnFlyPenalty: This is an optional field. This is a String value.
-
BirthDate: Provide the birth date. This is a Numeric value.
-
NameTitle: Provide the title for the given name. This is a String value. Valid values are,
- ADT/Male:
Mr - ADT/Female:
MrsandMs - CHD/Male:
Mstr - CHD/Female:
Miss - INF/Male:
Mstr - INF/Female:
Miss
- ADT/Male:
-
FirstName: Provide the first name. This is a String value.
-
MiddleName: Provide the middle name. This is a String value.
-
LastName: Provide the last name. This is a String value. .
-
Gender: Provide the gender of the passenger. Valid values are
MaleandFemale. This is a String value. -
TravelDocument: This is an Array. Provide the details of travel document. This is an optional field.
-
DocumentNumber: This is the document number of your passport. This is a String value.
-
DocumentType: This is the document type of your passport (P). This is a String value.
-
IssueDate: This is the Issue date of your passport. This is a Date value.
-
ExpiryDate: This is the Expiry date of your passport. This is a Date value. The selected date must be greater than six months after the last travel date.
-
IssuingCountry: This is the Issuing country of your passport. This is a String value.
-
-
ContactInfoRef: Provide the contact information details.
-
Nationality: Nationality of the Passenger. This is a String value (e.g., IN, CA) 2-Letter Country Code. This is an required field.
-
This is an Array. This is a required field. Provide all the contact information here.
-
ContactID: Provide the contact ID.
-
AgencyName: Provide the agency name.
-
EmailAddress: Provide the email address.
-
Phone:
-
CountryCode: Provide the country code.
-
AreaCode: Provide the area code.
-
PhoneNumber: Provide the phone number.
-
-
Mobile:
-
CountryCode: Provide the country code.
-
MobileNumber: Provide the mobile number.
-
-
Address:
- Street: This is an Array. Provide the street details.
- CityName: Provide the city name.
- StateProv: Provide the state or province name.
- PostalCode: Provide the postal code.
- CountryCode: Provide the country code.
-
PassengerContact: Provide the contact details.
-
EmailAddress: Provide your email ID. This is a String value.
-
Phone:
-
CountryCode: Provide the country code. This is a String value.
-
AreaCode: Provide the area code. This is a String value.
-
PhoneNumber: Provide the phone number. This is a Numeric value.
-
-
Request URL
curl --location --request POST 'https://uat-apigateway.voyzantonline.com/AirOrderCreateV2' \
--header 'Authorization: <YOUR_ACCESS_TOKEN>' \
--header 'x-api-key: <your key here>' \
--header 'Content-Type: application/json'\
--header 'Accept-Encoding: gzip, deflate, br'\
Request Body Sample
{
"OrderCreateRQ": {
"Document": {
"Name": "Voyzant Portal",
"ReferenceVersion": "1.0"
},
"Party": {
"Sender": {
"TravelAgencySender": {
"Name": "Voyzant Agency",
"IATA_Number": "",
"AgencyID": "",
"Contacts": {
"Contact": [
{
"EmailContact": "test@email.com"
}
]
}
}
}
},
"ShoppingResponseId": "1679558717852165006",
"OfferResponseId": "1679558776693866670",
"SeatResponseId": "1679558814593769608",
"ServiceListResponseId": "1679558869528937117",
"MetaData": {
"Tracking": "Y",
"PassengerMetadata": {
"SpecialServiceRequest": []
}
},
"Query": {
"Order": {
"Offer": [
{
"OfferID": "3296198721679558734648373563"
}
],
"ServiceList": [
{
"OptinalServiceId": "1679558870399731899",
"PassengerID": "ADT1"
}
],
"Seat": [
{
"SeatId": "1679558815462573976",
"PassengerID": "ADT1"
}
]
}
},
"BookingType": "BOOK",
"PromoCode": "",
"PromoDiscount": 0,
"threeDs_required": "false",
"PartnerCode": "",
"PartnerClickID": "",
"BookingReqId": "DA7798F6",
"Platform": "",
"SiteBrand": "",
"LowCostCarrierType": true,
"BookingSource": "",
"Payments": {
"SecurePayment": {
"WebpushURL": ""https://caller_domain/../api_endpoint"",
"SecurePaymentVersion2": {
"DeviceDetails": {
"challengeWindowSize": "03",
"browserUserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.132 Safari/537.36",
"browserJavaEnabled": "true",
"browserScreenHeight": "1000",
"browserScreenWidth": "1920",
"browserLanguage": "en-GB",
"ipAddress": "11.22.333.444"
}
}
},
"Payment": [
{
"Type": "CARD",
"Amount": 298.2,
"Method": {
"PaymentCard": {
"CardType": "CC",
"CardCode": "MC",
"CardNumber": "5299920210000277",
"SeriesCode": "411",
"CardHolderName": "Priya",
"EffectiveExpireDate": {
"Effective": "",
"Expiration": "2024-05"
}
}
},
"Payer": {
"ContactInfoRefs": "CTC1"
}
}
]
},
"DataLists": {
"PassengerList": {
"Passenger": [
{
"PassengerID": "ADT1",
"PTC": "ADT",
"OnflyMarkup": "0.00",
"OnflyDiscount": "0.00",
"BirthDate": "2000-07-21",
"NameTitle": "Mr",
"FirstName": "downey",
"MiddleName": "",
"LastName": "Robert",
"Gender": "Male",
"TravelDocument": [
{
"DocumentNumber": "9658745",
"DocumentType": "P",
"IssueDate": "2015-01-01",
"ExpiryDate": "2024-01-01",
"IssuingCountry": "CA"
}
],
"ContactInfoRef": "CTC1",
"Nationality": "CA"
}
]
},
"ContactList": {
"ContactInformation": [
{
"ContactID": "CTC1",
"AgencyName": "kathir",
"EmailAddress": "kathir@gmail.com",
"Phone": {
"ContryCode": "+91",
"AreaCode": "",
"PhoneNumber": "9854785465"
},
"Mobile": {
"ContryCode": "+91",
"MobileNumber": "9854785465"
},
"Address": {
"Street": [
"kovil Street",
null
],
"CityName": "chennai",
"StateProv": "AX",
"PostalCode": "600028",
"CountryCode": "CA"
},
"PassengerContact": {
"EmailAddress": "mosris@gmail.com",
"Phone": {
"ContryCode": "",
"AreaCode": "",
"PhoneNumber": "9856325698"
}
}
}
]
}
}
}
}
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": "1679558717852165006",
"Success": {},
"Payments": {
"Payment": [
{
"Type": "CARD",
"Amount": 996.26,
"Method": {
"PaymentCard": {
"CardType": "CC",
"CardCode": "MC",
"CardNumber": "5299920210000277",
"SeriesCode": "411",
"CardHolderName": "Priya",
"EffectiveExpireDate": {
"Effective": "",
"Expiration": "2024-05"
}
}
},
"Payer": {
"ContactInfoRefs": "CTC1"
}
}
]
},
"Order": [
{
"OrderID": "OZ8E5OX9",
"GdsBookingReference": "4ZT3DN",
"OrderStatus": "SUCCESS",
"NeedToTicket": "N",
"OptionalServiceStatus": "SUCCESS",
"SeatSelectionStatus": "FAILED",
"OfferID": "3296198721679558734648373563",
"Owner": "AF",
"OwnerName": "Air France",
"IsBrandedFare": "N",
"BrandedFareOptions": [],
"CabinOptions": [],
"IsAdditionalCabinType": "N",
"Eticket": "false",
"TimeLimits": {
"OfferExpirationDateTime": "2023-03-23T10:11:45",
"PaymentExpirationDateTime": "2023-03-27 03:00:00"
},
"BookingCurrencyCode": "CAD",
"EquivCurrencyCode": "CAD",
"HstPercentage": "",
"RewardSettings": {
"RewardAvailable": "N",
"PointTypes": [],
"PointValues": {}
},
"BookingFeeInfo": {
"FeeType": "",
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"TotalPrice": {
"BookingCurrencyPrice": 841.96,
"EquivCurrencyPrice": 841.96
},
"BasePrice": {
"BookingCurrencyPrice": 414,
"EquivCurrencyPrice": 414
},
"TaxPrice": {
"BookingCurrencyPrice": 427.96,
"EquivCurrencyPrice": 427.96
},
"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": 841.96,
"EquivCurrencyPrice": 841.96
}
},
"Service": [
{
"ServiceID": "SV1",
"PassengerRefs": "ADT1",
"FlightRefs": "Flight1"
}
],
"FareDetail": {
"PassengerRefs": "ADT1",
"Price": {
"TotalAmount": {
"BookingCurrencyPrice": 841.96,
"EquivCurrencyPrice": 841.96
},
"BaseAmount": {
"BookingCurrencyPrice": 414,
"EquivCurrencyPrice": 414
},
"TaxAmount": {
"BookingCurrencyPrice": 427.96,
"EquivCurrencyPrice": 427.96
},
"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": 25,
"EquivCurrencyPrice": 25
},
{
"TaxCode": "YR",
"BookingCurrencyPrice": 337.5,
"EquivCurrencyPrice": 337.5
},
{
"TaxCode": "CA",
"BookingCurrencyPrice": 25.91,
"EquivCurrencyPrice": 25.91
},
{
"TaxCode": "RC",
"BookingCurrencyPrice": 4.55,
"EquivCurrencyPrice": 4.55
},
{
"TaxCode": "SQ",
"BookingCurrencyPrice": 35,
"EquivCurrencyPrice": 35
}
]
}
},
"FareComponent": [
{
"PriceClassRef": "PCR_1",
"SegmentRefs": "Segment1",
"FareBasis": {
"FareBasisCode": {
"Refs": "FG_1",
"Code": "NLX79NBL/AU330"
},
"RBD": "N",
"CabinType": "Y",
"SeatLeft": "9"
}
}
]
},
{
"OfferItemID": "SRV-OfferItem-1",
"Service": {
"PassengerRefs": "ADT1",
"SegmentRefs": "Segment1"
},
"Price": {
"Base": {
"BookingCurrencyPrice": "96.00",
"EquivCurrencyPrice": "96.00"
},
"Tax": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Total": {
"BookingCurrencyPrice": "96.00",
"EquivCurrencyPrice": "96.00"
}
},
"ServiceDefinitionRef": "SRV-1"
},
{
"OfferItemID": "SRV-OfferItem-2",
"Service": {
"PassengerRefs": "ADT1",
"SegmentRefs": "Segment1"
},
"Price": {
"Base": {
"BookingCurrencyPrice": "264.00",
"EquivCurrencyPrice": "264.00"
},
"Tax": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Total": {
"BookingCurrencyPrice": "264.00",
"EquivCurrencyPrice": "264.00"
}
},
"ServiceDefinitionRef": "SRV-2"
},
{
"OfferItemID": "SRV-OfferItem-3",
"Service": {
"PassengerRefs": "ADT1",
"SegmentRefs": "Segment1"
},
"Price": {
"Base": {
"BookingCurrencyPrice": "264.00",
"EquivCurrencyPrice": "264.00"
},
"Tax": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Total": {
"BookingCurrencyPrice": "264.00",
"EquivCurrencyPrice": "264.00"
}
},
"ServiceDefinitionRef": "SRV-3"
},
{
"OfferItemID": "SRV-OfferItem-4",
"Service": {
"PassengerRefs": "ADT1",
"SegmentRefs": "Segment1"
},
"Price": {
"Base": {
"BookingCurrencyPrice": "175.00",
"EquivCurrencyPrice": "175.00"
},
"Tax": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Total": {
"BookingCurrencyPrice": "175.00",
"EquivCurrencyPrice": "175.00"
}
},
"ServiceDefinitionRef": "SRV-4"
}
],
"BaggageAllowance": [
{
"SegmentRefs": "Segment1",
"PassengerRefs": "ADT1",
"BaggageAllowanceRef": "Bag1"
}
],
"SplitPaymentInfo": [
{
"AirItineraryId": "3296198721679558734648373563",
"MultipleFop": "N",
"MaxCardsPerPax": 0,
"MaxCardsPerPaxInMFOP": 0
}
],
"BookingToEquivExRate": 1,
"FopRef": "FOP_1341_0_1987_0_ALL_PRI"
}
],
"DataLists": {
"PassengerList": {
"Passengers": [
{
"PassengerID": "ADT1",
"PTC": "ADT",
"OnflyMarkup": "0.00",
"OnflyDiscount": "0.00",
"BirthDate": "2000-07-21",
"NameTitle": "Mr",
"FirstName": "downey",
"MiddleName": "",
"LastName": "Robert",
"Gender": "Male",
"TravelDocument": [
{
"DocumentNumber": "9658745",
"DocumentType": "P",
"IssueDate": "2015-01-01",
"ExpiryDate": "2024-01-01",
"IssuingCountry": "CA"
}
],
"ContactInfoRef": "CTC1",
"attributes": {
"PassengerID": "ADT1"
},
"PassengerRefID": "ADT1"
"Nationality": "CA"
}
]
},
"DisclosureList": {
"Disclosures": []
},
"FareList": {
"FareGroup": [
{
"FareGroupRef": "FG_1",
"FareCode": "749",
"FareBasisCode": "NLX79NBL/AU330"
}
]
},
"FlightSegmentList": {
"FlightSegment": [
{
"SegmentKey": "Segment1",
"Departure": {
"AirportCode": "YYZ",
"Date": "2023-04-17",
"Time": "23:15:00",
"AirportName": "Lester B. Pearson International Airport",
"Terminal": {
"Name": "3"
}
},
"Arrival": {
"AirportCode": "CDG",
"Date": "2023-04-18",
"Time": "12:35:00",
"AirportName": "Charles de Gaulle International Airport",
"Terminal": {
"Name": "2E"
}
},
"MarketingCarrier": {
"AirlineID": "AF",
"Name": "Air France",
"FlightNumber": "357"
},
"OperatingCarrier": {
"AirlineID": "AF",
"Name": "Air France",
"FlightNumber": "357"
},
"Equipment": {
"AircraftCode": "772",
"Name": "Boeing 777-200 pax"
},
"Code": {
"MarriageGroup": "O"
},
"FlightDetail": {
"FlightDuration": {
"Value": "7 H 20 M"
},
"Stops": {
"Value": 0
},
"InterMediate": [],
"AirMilesFlown": 0
},
"BrandId": ""
}
]
},
"FlightList": {
"Flight": [
{
"FlightKey": "Flight1",
"Journey": {
"Time": "7 H 20 M",
"Stops": 0
},
"SegmentReferences": "Segment1"
}
]
},
"OriginDestinationList": {
"OriginDestination": [
{
"OriginDestinationKey": "OD1",
"DepartureCode": "YYZ",
"ArrivalCode": "CDG",
"FlightReferences": "Flight1"
}
]
},
"PriceClassList": {
"PriceClass": [
{
"PriceClassID": "PCR_1",
"Name": "",
"Code": "",
"Descriptions": {
"Description": []
}
}
]
},
"BaggageAllowanceList": {
"BaggageAllowance": [
{
"BaggageAllowanceID": "Bag1",
"BaggageCategory": "Checked",
"AllowanceDescription": {
"ApplicableParty": "Traveler",
"Description": "CHECKED ALLOWANCE"
},
"PieceAllowance": {
"ApplicableParty": "Traveler",
"TotalQuantity": "1",
"Unit": "Pieces"
}
}
]
},
"ServiceDefinitionList": {
"ServiceDefinition": [
{
"ServiceDefinitionID": "SRV-1",
"ServiceType": "BAG",
"ServiceCode": "ABAG1",
"ServiceName": "1ST ADDITIONAL BAG"
},
{
"ServiceDefinitionID": "SRV-2",
"ServiceType": "BAG",
"ServiceCode": "BBAG2",
"ServiceName": "2ND ADDITIONAL BAG"
},
{
"ServiceDefinitionID": "SRV-3",
"ServiceType": "BAG",
"ServiceCode": "CBAG3",
"ServiceName": "ADDITIONAL LUGGAGE"
},
{
"ServiceDefinitionID": "SRV-4",
"ServiceType": "BAG",
"ServiceCode": "BIKE4",
"ServiceName": "BICYCLE"
}
]
},
"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_PRI"
}
]
},
"MetaData": {}
}
}
Reprice Response
When the order creation attempt fails during booking (for example, the selected booking class is no longer available at the confirmed price), the Reprice flow is automatically triggered. The response returns the original OrderViewRS error alongside an AllPricedOfferRS envelope that lists alternative priced offers the traveller can rebook against.
Note: This response is only returned when the reprice flow is successfully triggered after a booking failure. If the order is created successfully, only the standard OrderViewRS block with the confirmed order is returned.
Reprice Response Schema
Echoes the original OrderCreate result. When reprice is triggered, this block always carries the booking failure that caused the reprice.
-
Document:
- Name: Name of the responding system. This is a String value.
- ReferenceVersion: Response schema version. This is a String value.
-
Party.Sender.TravelAgencySender: Agency details echoed from the request.
- Name, IATA_Number, AgencyID: String values.
- Contacts.Contact[].EmailContact: String value.
-
ShoppingResponseId: The shopping session ID that produced the original offer. This is a String value.
-
OfferResponseId: The priced offer response ID against which the order was attempted. Empty string when the failure occurs before an offer response is bound. This is a String value.
-
Errors.Error: The booking failure that triggered the reprice flow.
- ShortText: Short label for the error (for example, Order View Error). This is a String value.
- Code: Numeric error code (for example, 109). This is a Numeric value.
- Value: Human-readable description of the failure. This is a String value.
Container for the reprice results. It groups the alternatives into three mutually exclusive buckets so the client can decide which fallback to offer the traveller before retrying AirOrderCreateV2.
-
ShoppingResponseId: The shopping session ID that the reprice was performed against. This is a String value.
-
SameFlightOptions: A repriced offer for the same itinerary and same booking class as originally selected, at a revised total price. Empty object ({}) when this fallback is not available.
-
DifferentBookingClassOptions: An Array of repriced offers for the same itinerary in a different booking class (RBD). Empty array when this fallback is not available.
-
DifferentFlightOptions: Repriced offers on alternate itineraries (different flights, different dates, or different carriers). See OffersGroup below.
-
Warnings: An Array of advisory messages. Each entry indicates a bucket that came back empty — for example, “Same Flight Option Not availbale” or “DifferentBookingClass Options Not availbale”.
Each entry in OffersGroup is a complete OfferPriceRS payload for one alternate priced offer. Clients should treat each entry as an independently bookable option — retry AirOrderCreateV2 with the chosen OfferID and its ShoppingResponseId.
-
OfferPriceRS.Success: Empty object confirming the alternate offer priced cleanly.
-
OfferPriceRS.PricedOffer: An Array. Each priced offer contains:
- OfferID: Unique identifier for the alternate offer. Use this when placing the order. This is a String value.
- Owner / OwnerName: Airline code and name that owns the offer.
- IsBrandedFare: Y or N. Whether the offer is a branded fare.
- InstantTicket: Y or N. Whether the offer supports instant ticketing.
- Eticket: true or false. E-ticket eligibility.
- AllowHold: Y or N. Whether the offer can be held without payment.
- TimeLimits:
- OfferExpirationDateTime: ISO datetime — offer must be booked before this. This is a String value.
- PaymentExpirationDateTime: Deadline for payment. This is a String value.
- PassportRequired: Y or N.
- BookingCurrencyCode / EquivCurrencyCode: ISO 4217 currency codes.
- BookingFeeInfo: Booking fee applied to the offer.
- FeeType: For example, AIF. This is a String value.
- BookingCurrencyPrice / EquivCurrencyPrice: Numeric values.
- TotalPrice, BasePrice, TaxPrice: Aggregate pricing across all passengers. Each has BookingCurrencyPrice and EquivCurrencyPrice.
- Commission: Agency and YQ commission blocks.
- PortalCharges: Markup, Surcharge, Discount — portal-side adjustments.
- Penalty:
- ChangeFee.Before / ChangeFee.After: Change fee before and after departure.
- CancelationFee.Before / CancelationFee.After: Cancellation fee before and after departure.
- OfferItem: An Array, one entry per passenger type.
- OfferItemID: Unique item ID (for example, OFFERITEMID1). This is a String value.
- Refundable: true or false. This is a Boolean value.
- PassengerType: ADT, CHD, or INF. This is a String value.
- PassengerQuantity: Number of passengers of this type. This is a Numeric value.
- TotalPriceDetail.TotalAmount: Per-passenger-type total.
- Service: Links the offer item to passengers and flight segments (PassengerRefs, FlightRefs).
- FareDetail: Full price breakdown — TotalAmount, BaseAmount, TaxAmount, Commission, BookingFee, PortalCharges, and Taxes[] (each with TaxCode, BookingCurrencyPrice, EquivCurrencyPrice).
- FareComponent: Segment-level fare basis — PriceClassRef, SegmentRefs, FareBasis (FareBasisCode, RBD, CabinType, SeatLeft).
- BaggageAllowance: An Array mapping passengers to segments and baggage allowance references.
- SplitPaymentInfo: Payment split configuration for the itinerary.
- BookingToEquivExRate: Exchange rate between booking and equivalent currencies. This is a Numeric value.
- FopRef: Reference key into DataLists.FopList for allowed forms of payment. This is a String value.
- RescheduleAllowed, PaxWiseVoidAllowed, PostSeatAllowed, PostAncillaryAllowed: Y or N flags describing post-booking capabilities.
-
OfferPriceRS.DataLists: Reference data for the alternate offer. Contains AirShoppingRS with:
- PassengerList.Passengers[]: Passenger IDs, PTC, name, birth date, gender, and ContactInfoRef.
- FareList.FareGroup[]: FareGroupRef, FareCode, FareBasisCode.
- FlightSegmentList.FlightSegment[]: Departure/Arrival airports and times, Marketing and Operating carrier, Equipment, MarriageGroup, and FlightDetail (duration, stops).
- FlightList.Flight[]: FlightKey, Journey.Time, Journey.Stops, SegmentReferences.
- OriginDestinationList.OriginDestination[]: OriginDestinationKey, DepartureCode, ArrivalCode, FlightReferences.
- PriceClassList.PriceClass[]: Branded fare / price class metadata.
- BaggageAllowanceList.BaggageAllowance[]: BaggageAllowanceID, BaggageCategory, AllowanceDescription, PieceAllowance.
- FopList[]: Allowed forms of payment (CC, DC, CASH, CHEQUE, ACH, PG, VCC) with per-type surcharge/fee structures, keyed by FopKey.
Reprice Response Sample
{
"OrderViewRS": {
"Document": {
"Name": "Voyzant Portal",
"ReferenceVersion": "1.0"
},
"Party": {
"Sender": {
"TravelAgencySender": {
"Name": "Voyzant Agency",
"IATA_Number": "1111111111",
"AgencyID": "Voyzant Agency",
"Contacts": {
"Contact": [
{ "EmailContact": "pst@voyzant.com" }
]
}
}
}
},
"ShoppingResponseId": "1783346319740454268",
"OfferResponseId": "",
"Errors": {
"Error": {
"ShortText": "Order View Error",
"Code": 109,
"Value": "Unable to confirm availability for the selected booking class at this moment"
}
}
},
"AllPricedOfferRS": {
"ShoppingResponseId": "1783346319740454268",
"SameFlightOptions": {},
"DifferentBookingClassOptions": [],
"DifferentFlightOptions": {
"OffersGroup": [
{
"OfferPriceRS": {
"Success": {},
"OfferResponseId": "1783346419676169296",
"PricedOffer": [
{
"OfferID": "3973247511783346333584571633",
"Owner": "QR",
"OwnerName": "Qatar Airways",
"AllowHold": "Y",
"TimeLimits": {
"OfferExpirationDateTime": "2026-07-06T21:30:25",
"PaymentExpirationDateTime": "2026-07-7 07:00:00"
},
"BookingCurrencyCode": "CAD",
"TotalPrice": { "BookingCurrencyPrice": 2302.18, "EquivCurrencyPrice": 2302.18 },
"BasePrice": { "BookingCurrencyPrice": 1423.38, "EquivCurrencyPrice": 1423.38 },
"TaxPrice": { "BookingCurrencyPrice": 878.8, "EquivCurrencyPrice": 878.8 }
}
]
}
}
]
},
"Warnings": [
{ "Message": "Same Flight Option Not availbale" },
{ "Message": "DifferentBookingClass Options Not availbale" }
]
}
}
Client integration tip: Inspect Warnings[] first to know which buckets are empty, then iterate DifferentFlightOptions.OffersGroup[] to surface the alternate itineraries. Use each PricedOffer.OfferID (and its ShoppingResponseId) when retrying AirOrderCreateV2 to book the fallback.