The Order Create allows to request a specified offer to an order to be created and return the view of the hold inventory or order
Input
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 |
OrderCreate 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 |
Ethiopianairlines TravelAgency
12121212
A345345435
AAAIT PLC
88888888
ET
ETHIOPIAN AIRLINES
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 |
By default it associate an infant with the first adult passenger.
in this request you can also choose to which adult an infant should be associated.
just by passing infant reference on one of the adult passenger. e.g. <InfantRef>PAX002</InfantRef>
<Query><Order><Offer OfferID="PRICEDOFFER" Owner="ET" ResponseID="{{ReponseId}}"><OfferItem OfferItemID="OFFERITEM001"><PassengerRefs>PAX001</PassengerRefs></OfferItem></Offer></Order><Payments><Payment><Type>CA</Type><Method><Cash/></Method><Amount Code="ETB">41143</Amount><!-- Use when OTA paying--><Payer><ContactInfoRefs>CTC01</ContactInfoRefs></Payer></Payment></Payments><DataLists><PassengerList><Passenger PassengerID="PAX001"><PTC>ADT</PTC><Individual><Birthdate>1988-06-10</Birthdate><Gender>Female</Gender><NameTitle>MRS</NameTitle><GivenName>Jane</GivenName><Surname>Smith</Surname></Individual><LoyaltyProgramAccount><AccountNumber></AccountNumber></LoyaltyProgramAccount><IdentityDocument><IdentityDocumentNumber>543000123</IdentityDocumentNumber><IdentityDocumentType>F</IdentityDocumentType><IssuingCountryCode>US</IssuingCountryCode><CitizenshipCountryCode>US</CitizenshipCountryCode><IssueDate>2017-01-17</IssueDate><ExpiryDate>2022-01-16</ExpiryDate><Birthdate>1988-06-10</Birthdate><Birthplace>US</Birthplace></IdentityDocument><ContactInfoRef>CTC01</ContactInfoRef></Passenger><Passenger PassengerID="PAX002"><PTC>CHD</PTC><Individual><Birthdate>2010-06-10</Birthdate><Gender>Female</Gender><NameTitle>MRS</NameTitle><GivenName>fsfdsdf</GivenName><Surname>sdfsfds</Surname></Individual><LoyaltyProgramAccount><AccountNumber></AccountNumber></LoyaltyProgramAccount><IdentityDocument><IdentityDocumentNumber>543000123</IdentityDocumentNumber><IdentityDocumentType>F</IdentityDocumentType><IssuingCountryCode>US</IssuingCountryCode><CitizenshipCountryCode>US</CitizenshipCountryCode><IssueDate>2017-01-17</IssueDate><ExpiryDate>2022-01-16</ExpiryDate><Birthdate>1988-06-10</Birthdate><Birthplace>US</Birthplace></IdentityDocument><ContactInfoRef>CTC01</ContactInfoRef><InfantRef>PAX002</InfantRef></Passenger><Passenger PassengerID="PAX003"><PTC>INF</PTC><Individual><Birthdate>2022-06-10</Birthdate><Gender>Female</Gender><NameTitle>MRS</NameTitle><GivenName>bbmbmbm</GivenName><Surname>sdfsfds</Surname></Individual><LoyaltyProgramAccount><AccountNumber></AccountNumber></LoyaltyProgramAccount><IdentityDocument><IdentityDocumentNumber>543000123</IdentityDocumentNumber><IdentityDocumentType>F</IdentityDocumentType><IssuingCountryCode>US</IssuingCountryCode><CitizenshipCountryCode>US</CitizenshipCountryCode><IssueDate>2022-01-17</IssueDate><ExpiryDate>2022-01-16</ExpiryDate><Birthdate>1988-06-10</Birthdate><Birthplace>US</Birthplace></IdentityDocument><ContactInfoRef>CTC01</ContactInfoRef></Passenger></PassengerList><ContactList><ContactInformation ContactID="CTC01"><PostalAddress><Label>BUSINESS</Label><Street>100 APPLIEDLINE MAIN STREET</Street><Street>BOLE</Street><PostalCode>1000</PostalCode><CityName>ADDIS ABABA</CityName><CountrySubdivisionName>OROMIA</CountrySubdivisionName><CountryName>Mefsel</CountryName><CountryCode>ET</CountryCode></PostalAddress><ContactProvided><EmailAddress><Label>HOME</Label><EmailAddressValue>jane@mail.com</EmailAddressValue></EmailAddress><EmailAddress><Label>WORK</Label><EmailAddressValue>jane.Mefsel@work.com</EmailAddressValue></EmailAddress></ContactProvided><ContactProvided><Phone><Label>MOBILE</Label><CountryDialingCode>251</CountryDialingCode><PhoneNumber>0944123456</PhoneNumber></Phone></ContactProvided></ContactInformation></ContactList></DataLists></Query>
Request | Root node of the request schema |
---|---|
Query | |
Order | |
Offer | |
@OfferID | Unique ID e.g. OFFER001 |
@Owner | ORA e.g. ET |
OfferItem | Departure date |
@OfferItemID | |
PassengerRefs | Space separated passenger IDs with matching PassengerID in PassengerList e.g. PAX001 PAX002 PAX003 |
Payments | |
Payment | |
Type | CA for Cash |
DataLists | |
PassengerList | List of passengers |
Passenger | |
@PassengerID | Unique passenger identifier e.g. PAX001 |
PTC | Passenger type e.g. ADT, CHD, INF |
Individual | |
Birthdate | Format YYYY-MM-DD |
Gender | Male, Female |
NameTitle | MR, MRS, MS, MISS, MASTER, DR, PROF, AMB, SIR |
GivenName | First name |
MiddleName | Middle Name |
Surname | Last name or Family name |
LoyaltyProgramAccount | |
AccountNumber | e.g. Shebamiles number |
IdentityDocument | |
IdentityDocumentNumber | passport number |
IdentityDocumentType | F - Passport |
IssuingCountryCode | 2 letter country code of passport e.g. ET, GB |
CitizenshipCountryCode | 2 letter country code of nationality e.g. ET |
IssueDate | Format YYYY-MM-DD |
ExpireDate | Format YYYY-MM-DD |
Birthdate | Format YYYY-MM-DD |
Birthplace | 2 letter country code of birth e.g. ET |
ContactInfoRef | Reference to passenger contact information in ContactList |
ContactList | |
ContactInformation | |
@ContactID | Unique contact ID e.g. CONTACT001 |
ContactType | PRIMARY PAYMENT – used if passenger is paying |
PostalAddress | Address information |
Label | Type of address e.g. HOME, WORK |
Street | Street 1 0-9 a-z A-Z Maximum of 30 characters |
PostalCode | Postal or zip code |
CityName | e.g. Addis Ababa |
CountrySubdivisionName | State or Region e.g. Oromia, Texas |
CountryName | 2 letter country code of address e.g. ET |
ContactProvided | Collection of either emails or phone. Use separate nodes for emails and phones. |
EmailAddress | |
Label | HOME or WORK |
EmailAddressValue | e.g. john.doe@mail.com |
Phone | |
Label | MOBILE, WORK |
CountryDialingCode | Country code without + e.g. 251, 92 |
PhoneNumber | Number without country code |
Individual | Required when the Payment.Payer node is set |
GivenName | |
MiddleName | |
Surname |
OrderCreate 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 |
In this response the price breakdown is found per the OrderItemID order_PAXID value format
<OrderItems><OrderItem OrderItemID="NNMWYD_PX001"><PriceDetail><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></PriceDetail><Service ServiceID="NNMWYD_1"><PassengerRef>PX001</PassengerRef><SegmentRef>SEG_ADDDXB_001</SegmentRef></Service></OrderItem><OrderItem OrderItemID="NNMWYD_PX002"><PriceDetail><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></PriceDetail><Service ServiceID="NNMWYD_2"><PassengerRef>PX002</PassengerRef><SegmentRef>SEG_ADDDXB_001</SegmentRef></Service></OrderItem><OrderItem OrderItemID="NNMWYD_PX003"><PriceDetail><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></PriceDetail><Service ServiceID="NNMWYD_3"><PassengerRef>PX003</PassengerRef><SegmentRef>SEG_ADDDXB_001</SegmentRef></Service></OrderItem></OrderItems></Order>
Request | Root node of the request schema |
---|---|
Response | |
Order | |
@OrderID | PNR e.g. YTDFRA |
@Owner | ORA |
BookingReferences | |
BookingReference | |
ID | PNR e.g. YTDFRA |
AirlineID | ET |
@Name | Ethiopian Airlines |
TotalOrderPrice | Total ticket price including taxes |
SimpleCurrencyPrice | Total order price e.g. 107208 |
@Code | Currency code e.g. USD, GBP, EUR |
BaseAmount | Base fare value |
@Code | Currency code |
Taxes | |
Total | Tax value |
@Code | Currency code |
Service | Service per segment per passenger |
@ServiceID | Service per segment per passenger |
PassengerRef | Passenger entitled to service |
SegmentRef | Flight segment associated to service |
<DataLists><PassengerList><Passenger PassengerID="PAX001"><PTC>ADT</PTC><Individual><Birthdate>1988-06-10</Birthdate><Gender>Female</Gender><NameTitle>MRS</NameTitle><GivenName>Jane</GivenName><Surname>Smith</Surname></Individual><LoyaltyProgramAccount><AccountNumber /></LoyaltyProgramAccount><IdentityDocument><IdentityDocumentNumber>543000123</IdentityDocumentNumber><IdentityDocumentType>F</IdentityDocumentType><IssuingCountryCode>US</IssuingCountryCode><CitizenshipCountryCode>US</CitizenshipCountryCode><IssueDate>2017-01-17</IssueDate><ExpiryDate>2022-01-16</ExpiryDate><Birthdate>1988-06-10</Birthdate><Birthplace>US</Birthplace></IdentityDocument><ContactInfoRef>CTC01</ContactInfoRef></Passenger><Passenger PassengerID="PAX002"><PTC>ADT</PTC><Individual><Birthdate>2019-06-10</Birthdate><Gender>Female</Gender><NameTitle>MRS</NameTitle><GivenName>sawi</GivenName><Surname>sawale</Surname></Individual><LoyaltyProgramAccount><AccountNumber /></LoyaltyProgramAccount><IdentityDocument><IdentityDocumentNumber>543000123</IdentityDocumentNumber><IdentityDocumentType>F</IdentityDocumentType><IssuingCountryCode>US</IssuingCountryCode><CitizenshipCountryCode>US</CitizenshipCountryCode><IssueDate>2021-01-17</IssueDate><ExpiryDate>2022-01-16</ExpiryDate><Birthdate>2019-06-10</Birthdate><Birthplace>US</Birthplace></IdentityDocument><ContactInfoRef>CTC01</ContactInfoRef></Passenger></PassengerList><BagDisclosureList /><BaggageAllowanceList /><FlightSegmentList><FlightSegment SegmentKey="SEG_ADDIAD_001"><Departure><AirportCode>ADD</AirportCode><Date>2023-03-20</Date><Time>09:00</Time></Departure><Arrival><AirportCode>IAD</AirportCode><Date>2023-03-20</Date><Time>19:25</Time><Terminal><Name>2</Name></Terminal></Arrival><MarketingCarrier><AirlineID>ET</AirlineID><FlightNumber>516</FlightNumber></MarketingCarrier><OperatingCarrier><AirlineID>ET</AirlineID><FlightNumber>516</FlightNumber></OperatingCarrier><Equipment><AircraftCode>788</AircraftCode></Equipment><ClassOfService><Code>D</Code><MarketingName>BUSINESS</MarketingName><FareBasisCode>DEYJ0WET</FareBasisCode></ClassOfService><FlightDetail><FlightDistance><Value>7929</Value><UOM>Miles</UOM></FlightDistance><FlightDuration><Value>PT17H25M</Value></FlightDuration></FlightDetail></FlightSegment></FlightSegmentList><FlightList><Flight FlightKey="FLT001"><SegmentReferences>SEG_ADDIAD_001</SegmentReferences></Flight></FlightList><OriginDestinationList><OriginDestination><DepartureCode>ADD</DepartureCode><ArrivalCode>IAD</ArrivalCode><FlightReferences>FLT001</FlightReferences></OriginDestination></OriginDestinationList></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 Airshopping XML |
---|---|
OrderCreate Request | Click to download |
OrderCreate Response | Click to download |
Multi pax OrderCreate Request | Click to download |
Multi Pax OrderCreate Response | Click to download |
Erorrs Response Description
Order Create error responses
Erorr Code | Error Code Text |
---|---|
400 | Page not found |
200 | Success response |
0 | Error |