The OfferPriceRQ schema allows you to get the price breakdown for the selected flights in context of the number of passengers specified in AirShoppingRQ. This request must be made after AirShoppingRQ request.
Input
Origin and destination (departure airport, arrival airport)
Flight date, cabin type
Passenger details can also contain Name & FQTV details, if applicable.
Currency, the currency override allows to pass specific currency that you are allowed to sell on a specific origin other way the default currency will be applicable
Http Headers
Key | Value | Required |
---|---|---|
Content-Type | application/xml | Yes |
Accept | */* | Yes |
Authorization | Bearer {{access_token}} | Yes |
Content-Length | <calculated when request is sent> | Yes |
Host | <calculated when request is sent> | Yes |
User-Agent | PostmanRuntime/7.30.0 | Yes |
Accept-Encoding | gzip, deflate, br | Yes |
Connection | Keep-alive | Yes |
DeviceID | String | Yes |
Sequence
Endpoints
Test | Live |
---|---|
https://aks-cluster-test.ethiopianairlines.com | https://ndc.ethiopianairlines.com |
OfferPrice Request
<Document>
<Name>ETHIOPIAN AIRLINES NDC </Name>
<ReferenceVersion>1.0</ReferenceVersion>
</Document>
Request | Root node of the request schema |
---|---|
Document | |
Name | Document Name |
ReferenceVersion | Reference Version |
<Party><Sender><TravelAgencySender><Name>Ethiopianairlines TravelAgency</Name><IATA_Number>12121212</IATA_Number><AgencyID Owner="ET">A345345435</AgencyID></TravelAgencySender></Sender><Participants><Participant><AggregatorParticipant SequenceNumber="1"><Name>AAAIT PLC</Name><AggregatorID>88888888</AggregatorID></AggregatorParticipant></Participant></Participants><Recipient><ORA_Recipient><AirlineID>ET</AirlineID><Name>ETHIOPIAN AIRLINES</Name></ORA_Recipient></Recipient></Party>
Request | Root node of the request schema |
---|---|
Party | Aggregator and OTA information |
Sender | |
TravelAgencySender | Travel agency involved in the request |
Name | Travel agency’s official name |
IATA_Number | Travel agency’s IATA number |
AgencyID | Travel agency’s Agency ID |
Participants | List of aggregators involved in the request |
Participant | |
AggregatorParticipant | |
@SequenceNumber | Unique position in the list e.g. 1, 2, 3 |
Name | Aggregator’s official name |
AggregatorID | Aggregator’s ID |
Recipient | |
ORA_Recipient | Offer responsible airline information |
AirlineID | IATA Airline code e.g. ET |
Name | Ethiopian Airlines |
<Query><Offer OfferID="OFFER001" Owner="ET" ResponseID="{{ReponseId}}"><OfferItem OfferItemID="OFFERITEM-9577965498"><PassengerRefs>PX001</PassengerRefs></OfferItem></Offer></Query>
For multi-pax request, send the offer item ID of each passenger like below
<Query><Offer OfferID="OFFER001" Owner="ET" ResponseID="{{ReponseId}}"><OfferItem OfferItemID="OFFERITEM-6478847636"><PassengerRefs>PX001</PassengerRefs></OfferItem><OfferItem OfferItemID="OFFERITEM-2030111990"><PassengerRefs>PX002</PassengerRefs></OfferItem><OfferItem OfferItemID="OFFERITEM-2880184804"><PassengerRefs>PX003</PassengerRefs></OfferItem></Offer></Query>
Request | Root node of the request schema |
---|---|
CoreQuery | |
Offer | Specific to an OriginDestination |
@OfferID | Unique ID e.g. OFFER001 |
@Owner | ORA e.g. ET |
OfferItem | |
@OfferItemID | Selected offer item for an OriginDestination |
<Passenger PassengerID="PX001"><PTC>ADT</PTC><Individual><NameTitle>MR</NameTitle><GivenName>Jane</GivenName><Surname>Smith</Surname></Individual><LoyaltyProgramAccount><AccountNumber>1234525525</AccountNumber></LoyaltyProgramAccount></Passenger>
Request | Root node of the request schema |
---|---|
Passenger | |
@PassengerID | Unique passenger identifier e.g. PAX001 |
PTC | Passenger type e.g. ADT, CHD, INF |
LoyaltyProgramAccount | |
AccountNumber | Passenger loyalty number |
OfferPrice Response
<Document>
<Name>ETHIOPIAN AIRLINES NDC </Name>
<ReferenceVersion>1.0</ReferenceVersion>
</Document>
Request | Root node of the request schema |
---|---|
Document | |
Name | Document Name |
ReferenceVersion | Reference Version |
<ShoppingResponseID><ResponseID>LWJQNMJOZK2ZMSB</ResponseID></ShoppingResponseID>
Request | Root node of the request schema |
---|---|
Shopping Response | |
ResponseID | Response ID of the shopping request e.g. LWJQNMJOZK2ZMSB |
The priced offer now contains the breakdown for each passenger
<PricedOffer OfferID="PRICEDOFFER" Owner="ET">
<TimeLimits><OfferExpiration Timestamp="2023-04-17T13:44:08.4069585Z" /></TimeLimits><TotalPrice><SimpleCurrencyPrice Code="USD">890.80</SimpleCurrencyPrice></TotalPrice><OfferItem OfferItemID="OFFERITEM001"><TotalPriceDetail><TotalAmount><SimpleCurrencyPrice Code="USD">463.40</SimpleCurrencyPrice></TotalAmount><BaseAmount Code="USD">336.00</BaseAmount><Surcharges><Surcharge><Total Code="USD">0</Total></Surcharge></Surcharges><Taxes><Total Code="USD">127.40</Total></Taxes></TotalPriceDetail><Service ServiceID="SV001"><PassengerRefs>PX001</PassengerRefs><FlightRefs>FLT001</FlightRefs></Service></OfferItem><OfferItem OfferItemID="OFFERITEM002"><TotalPriceDetail><TotalAmount><SimpleCurrencyPrice Code="USD">379.40</SimpleCurrencyPrice></TotalAmount><BaseAmount Code="USD">252.00</BaseAmount><Surcharges><Surcharge><Total Code="USD">0</Total></Surcharge></Surcharges><Taxes><Total Code="USD">127.40</Total></Taxes></TotalPriceDetail><Service ServiceID="SV002"><PassengerRefs>PX002</PassengerRefs><FlightRefs>FLT001</FlightRefs></Service></OfferItem><OfferItem OfferItemID="OFFERITEM003"><TotalPriceDetail><TotalAmount><SimpleCurrencyPrice Code="USD">48.00</SimpleCurrencyPrice></TotalAmount><BaseAmount Code="USD">34.00</BaseAmount><Surcharges><Surcharge><Total Code="USD">0</Total></Surcharge></Surcharges><Taxes><Total Code="USD">14.00</Total></Taxes></TotalPriceDetail><Service ServiceID="SV003"><PassengerRefs>PX003</PassengerRefs><FlightRefs>FLT001</FlightRefs></Service></OfferItem></PricedOffer>
Request | Root node of the request schema |
---|---|
PricedOffer | Offers collection |
@OfferID | Unique offer price identification |
Offer | @Owner |
@OfferID | Unique offer identification |
@Owner | ORA |
TimeLimits | |
OfferExpiration | |
@Timestamp | Offer expiry time in ISO standard |
OfferItem | Specific brand on the flight |
@OfferItemID | |
TotalPriceDetail | |
TotalAmount | |
SimpleCurrencyPrice | Total price including taxes |
@Code | Currency code |
BaseAmount | Base fare value |
@Code | Currency code |
Surcharges | Surcharge information |
Surcharge | |
Total | Surcharge value |
@Code | Currency code |
Taxes | |
Total | Tax value |
@Code | Currency code |
Service | |
@ServiceID | Unique service identification |
PassengerRefs | Passengers entitled to service |
ServiceRef | Ref to Service Definition |
ServiceDefinitionRef | Flight associated to service |
<DataLists><PassengerList><Passenger PassengerID="PAX001"><PTC>ADT</PTC></Passenger></PassengerList><FlightSegmentList><FlightSegment SegmentKey="SEG_EBBADD_001"><Departure><AirportCode>EBB</AirportCode><Date>2023-03-20</Date><Time>02:45</Time></Departure><Arrival><AirportCode>ADD</AirportCode><Date>2023-03-20</Date><Time>04:55</Time><Terminal /></Arrival><MarketingCarrier><AirlineID>ET</AirlineID><FlightNumber>339</FlightNumber></MarketingCarrier><OperatingCarrier><AirlineID>ET</AirlineID><FlightNumber>339</FlightNumber></OperatingCarrier><Equipment><AircraftCode>738</AircraftCode></Equipment><ClassOfService><Code>M</Code><MarketingName>ECONOMY</MarketingName><FareBasisCode>MEEUG</FareBasisCode></ClassOfService><FlightDetail><FlightDistance><Value>754</Value><UOM>Miles</UOM></FlightDistance><FlightDuration><Value>PT2H10M</Value></FlightDuration></FlightDetail></FlightSegment></FlightSegmentList><FlightList><Flight FlightKey="FLT001"><SegmentReferences OnPoint="EBB" OffPoint="DSS">SEG_EBBADD_001 SEG_ADDDSS_002</SegmentReferences></Flight><Flight FlightKey="FLT002"><SegmentReferences OnPoint="DSS" OffPoint="EBB">SEG_DSSADD_003 SEG_ADDEBB_004</SegmentReferences></Flight></FlightList><OriginDestinationList><OriginDestination><DepartureCode>EBB</DepartureCode><ArrivalCode>DSS</ArrivalCode><FlightReferences>FLT001 FLT003 FLT005 FLT007 FLT009 FLT011 FLT013 FLT015 FLT017 FLT019 FLT021 FLT023 FLT025 FLT027 FLT029 FLT031 FLT033 FLT035 FLT037 FLT039 FLT041 FLT043 FLT045 FLT047 FLT049 FLT051 FLT053 FLT055 FLT057 FLT059 FLT061 FLT063 FLT065 FLT067 FLT069 FLT071 FLT073 FLT075 FLT077 FLT079 FLT081 FLT083 FLT085 FLT087 FLT089 FLT091 FLT093 FLT095 FLT097 FLT099 FLT101 FLT103 FLT105 FLT107 FLT109 FLT111 FLT113 FLT115 FLT117 FLT119 FLT121 FLT123 FLT125 FLT127 FLT129 FLT131 FLT133 FLT135 FLT137 FLT139 FLT141 FLT143</FlightReferences></OriginDestination><ServiceDefinitionList><ServiceDefinition ServiceDefinitionID="SD_ES" Owner="ET"><Name>ES</Name><Descriptions><Description><Text>ECONOMY SEMI FLEX</Text></Description></Descriptions></ServiceDefinition></DataLists>
Request | Root node of the request schema |
---|---|
DataLists | |
PassengerList | |
Passenger | |
@PassengerID | Unique passenger identifier e.g. PAX001 |
PTC | Passenger type e.g. ADT, CHD |
FlightSegmentList | |
FlightSegment | Flight segment information |
@SegmentKey | Unique segment identification |
Departure | |
AirportCode | Departure airport e.g. ADD |
Date | Departure date. Format YYYY-MM-DD |
Time | Departure time. Format HH:MM |
Terminal | Total price including taxes |
Name | Departure Airport Name |
Arrival | |
AirportCode | Arrival airport e.g. LOS |
Date | Arrival date. Format YYYY-MM-DD |
Time | Arrival time. Format HH:MM |
Terminal | |
Name | Arrival Airport name |
MarketingCarrier | Airline selling the ticket |
AirlineID | IATA airline code |
FlightNumber | Flight number |
OperatingCarrier | Airline operating the flight |
AirlineID | IATA airline code |
FlightNumber | Flight Number |
Equipment | |
AircraftCode | Type of aircraft |
ClassOfService | |
Code | |
MarketingName | Default segment brand |
FareBasisCode | |
FlightDetail | |
FlightDistance | |
Value | Flight distance value |
UOM | Unit Of Measurement |
FlightDuration | |
Value | PT4H10M implies 4 hours and 10 minutes |
FlightList | List of flights |
Flight | Single flight with one or more segments |
@FlightKey | Unique flight identification |
SegmentReferences | Segments associated with flight |
OnPoint | Origin city |
OffPoint | Destination city |
OriginDestinationList | List of flight origin and destination |
OriginDestination | |
DepartureCode | Departure city |
@UOM | Unit of measurement |
ArrivalCode | Arrival city |
@UOM | Unit of measurement |
FlightReferences | Flights associated to this origin destination |
ServiceDefinitionList | |
@ServiceDefinitionID | Unique Service Def ID |
Name | Brand name of service e.g. EP |
Descriptions | List of description text |
Description | e.g. ECONOMY PROMO |
Baggage allowance breakdown per passenger is now available. use the refs to distingush the passenger
ADT - Adult, CNN - Child, INF - Infant
<BagDisclosureList>
<BagDisclosure refs="ADT"><BagRule>BAG ALLOWANCE -ADDDXB-02P/ET/EACH PIECE UP TO 50 POUNDS/23</BagRule></BagDisclosure><BagDisclosure refs="ADT"><BagRule>KILOGRAMS</BagRule></BagDisclosure><BagDisclosure refs="ADT"><BagRule>CARRY ON ALLOWANCE</BagRule></BagDisclosure><BagDisclosure refs="ADT"><BagRule>ADDDXB-01P/ET</BagRule></BagDisclosure><BagDisclosure refs="ADT"><BagRule>01/UP TO 15 POUNDS/7 KILOGRAMS AND UP TO 45 LINEAR INCHES/115 L</BagRule></BagDisclosure><BagDisclosure refs="ADT"><BagRule>INEAR CENTIMETERS</BagRule></BagDisclosure><BagDisclosure refs="ADT"><BagRule>CARRY ON CHARGES</BagRule></BagDisclosure><BagDisclosure refs="ADT"><BagRule>ADDDXB-ET</BagRule></BagDisclosure><BagDisclosure refs="ADT"><BagRule>A HAND BAG EXCES CHARGE PER KG-USD14.00 PER KILO</BagRule></BagDisclosure><BagDisclosure refs="ADT"><BagRule>ADDITIONAL ALLOWANCES AND/OR DISCOUNTS MAY APPLY DEPENDING ON</BagRule></BagDisclosure><BagDisclosure refs="ADT"><BagRule>FLYER-SPECIFIC FACTORS /E.G. FREQUENT FLYER STATUS/MILITARY/</BagRule></BagDisclosure><BagDisclosure refs="ADT"><BagRule>CREDIT CARD FORM OF PAYMENT/EARLY PURCHASE OVER INTERNET,ETC./</BagRule></BagDisclosure><BagDisclosure refs="CNN"><BagRule>BAG ALLOWANCE -ADDDXB-02P/ET/EACH PIECE UP TO 50 POUNDS/23</BagRule></BagDisclosure><BagDisclosure refs="CNN"><BagRule>KILOGRAMS</BagRule></BagDisclosure><BagDisclosure refs="CNN"><BagRule>CARRY ON ALLOWANCE</BagRule></BagDisclosure><BagDisclosure refs="CNN"><BagRule>ADDDXB-01P/ET</BagRule></BagDisclosure><BagDisclosure refs="CNN"><BagRule>01/UP TO 15 POUNDS/7 KILOGRAMS AND UP TO 45 LINEAR INCHES/115 L</BagRule></BagDisclosure><BagDisclosure refs="CNN"><BagRule>INEAR CENTIMETERS</BagRule></BagDisclosure><BagDisclosure refs="CNN"><BagRule>CARRY ON CHARGES</BagRule></BagDisclosure><BagDisclosure refs="CNN"><BagRule>ADDDXB-ET</BagRule></BagDisclosure><BagDisclosure refs="CNN"><BagRule>A HAND BAG EXCES CHARGE PER KG-USD14.00 PER KILO</BagRule></BagDisclosure><BagDisclosure refs="CNN"><BagRule>ADDITIONAL ALLOWANCES AND/OR DISCOUNTS MAY APPLY DEPENDING ON</BagRule></BagDisclosure><BagDisclosure refs="CNN"><BagRule>FLYER-SPECIFIC FACTORS /E.G. FREQUENT FLYER STATUS/MILITARY/</BagRule></BagDisclosure><BagDisclosure refs="CNN"><BagRule>CREDIT CARD FORM OF PAYMENT/EARLY PURCHASE OVER INTERNET,ETC./</BagRule></BagDisclosure><BagDisclosure refs="INF"><BagRule>BAG ALLOWANCE -ADDDXB-01P/ET/EACH PIECE UP TO 50 POUNDS/23</BagRule></BagDisclosure><BagDisclosure refs="INF"><BagRule>KILOGRAMS</BagRule></BagDisclosure><BagDisclosure refs="INF"><BagRule>2NDCHECKED BAG FEE-ADDDXB-USD0.00/ET/UP TO 50 POUNDS/23 KILOGRA</BagRule></BagDisclosure><BagDisclosure refs="INF"><BagRule>MS AND UP TO 55 LINEAR INCHES/140 LINEAR CENTIMETERS</BagRule></BagDisclosure><BagDisclosure refs="INF"><BagRule>CARRY ON ALLOWANCE</BagRule></BagDisclosure><BagDisclosure refs="INF"><BagRule>ADDDXB-01P/ET</BagRule></BagDisclosure><BagDisclosure refs="INF"><BagRule>01/UP TO 15 POUNDS/7 KILOGRAMS AND UP TO 45 LINEAR INCHES/115 L</BagRule></BagDisclosure><BagDisclosure refs="INF"><BagRule>INEAR CENTIMETERS</BagRule></BagDisclosure><BagDisclosure refs="INF"><BagRule>CARRY ON CHARGES</BagRule></BagDisclosure><BagDisclosure refs="INF"><BagRule>ADDDXB-ET</BagRule></BagDisclosure><BagDisclosure refs="INF"><BagRule>A HAND BAG EXCES CHARGE PER KG-USD14.00 PER KILO</BagRule></BagDisclosure><BagDisclosure refs="INF"><BagRule>ADDITIONAL ALLOWANCES AND/OR DISCOUNTS MAY APPLY DEPENDING ON</BagRule></BagDisclosure><BagDisclosure refs="INF"><BagRule>FLYER-SPECIFIC FACTORS /E.G. FREQUENT FLYER STATUS/MILITARY/</BagRule></BagDisclosure><BagDisclosure refs="INF"><BagRule>CREDIT CARD FORM OF PAYMENT/EARLY PURCHASE OVER INTERNET,ETC./</BagRule></BagDisclosure></BagDisclosureList>
XML Sample
Request and Response | Sample Offerprice XML |
---|---|
Offerprice Request | Click to download |
Offerprice Response | Click to download |
Multi pax Offerprice Request | Click to download |
Multi pax Offerprice Response | Click to download |
Erorrs Response Description
Offer Price error responses
Erorr Code | Error Code Text |
---|---|
400 | Page not found |
200 | Success response |
0 | Error |