Update Travel Documents
Input
Order ID / PNR
Traveler Information
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 |
Update Travel Doc - OrderChange 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><OrderID Owner="ET">{{OrderId}}</OrderID><PassengerServicing><Previous PassengerID="PAX002"><Individual><GivenName>Jane MRS</GivenName><Surname>Smith</Surname></Individual><IdentityDocument><!--Passport (DOCS)details--><IdentityDocumentNumber>012345678</IdentityDocumentNumber><IdentityDocumentType>PT</IdentityDocumentType><IssuingCountryCode>ET</IssuingCountryCode><CitizenshipCountryCode>ET</CitizenshipCountryCode><ResidenceCountryCode>IND</ResidenceCountryCode><ExpiryDate>2022-05-06</ExpiryDate><BirthDate>1985-08-05</BirthDate><BirthdateSpecified>true</BirthdateSpecified><Gender>Male</Gender><Visa><!--Green Card OR Visa Details--><VisaNumber>121212121</VisaNumber><VisaType>GC</VisaType></Visa></IdentityDocument><ActionType>Delete</ActionType></Previous><New PassengerID="PAX002"><Individual><GivenName>Jane MRS</GivenName><Surname>Smith</Surname></Individual><IdentityDocument><!--Passport (DOCS)details--><IdentityDocumentNumber>012345678</IdentityDocumentNumber><IdentityDocumentType>P</IdentityDocumentType><IssuingCountryCode>ET</IssuingCountryCode><CitizenshipCountryCode>ET</CitizenshipCountryCode><ExpiryDate>2025-05-06</ExpiryDate><BirthDate>1994-08-05</BirthDate><BirthdateSpecified>true</BirthdateSpecified><Gender>Female</Gender><Visa><!--Green Card OR Visa Details--><VisaNumber>121212121</VisaNumber><VisaType>GC</VisaType></Visa></IdentityDocument><IdentityDocument><!--Passenger's Redress Number--><IdentityDocumentNumber>XYZ123456</IdentityDocumentNumber><IdentityDocumentType>AEA</IdentityDocumentType></IdentityDocument><ActionType>Add</ActionType></New></PassengerServicing></Query>
Request | Root node of the request schema |
---|---|
Query |
|
OrderID | PNR |
@owner | e.g. Z9 |
PassengerServicing | |
Previous | old passenger data |
@PassengerID | |
Individual |
|
GivenName | first name |
surname | last name |
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 |
<DataLists><PassengerList><Passenger PassengerID="Pax01"><PTC>ADT</PTC><Individual><GivenName>Jane</GivenName><Surname>Smith</Surname></Individual><LoyaltyProgramAccount><AccountNumber>1234525525</AccountNumber></LoyaltyProgramAccount></Passenger><Passenger PassengerID="Pax02"><PTC>ADT</PTC><Individual><GivenName>Tade</GivenName><Surname>Smith</Surname></Individual><LoyaltyProgramAccount><AccountNumber>1234525525</AccountNumber></LoyaltyProgramAccount></Passenger></PassengerList></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, INF |
LoyaltyProgramAccount | |
AccountNumber | Passenger loyalty number |
OrderView 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 |
<Order OrderID="PRBIPV" Owner="ET"><BookingReferences><BookingReference><ID>PRBIPV</ID><AirlineID Name="ETHIOPIAN AIRLINES">ET</AirlineID></BookingReference></BookingReferences><TotalOrderPrice><SimpleCurrencyPrice Code="USD">7256.14</SimpleCurrencyPrice></TotalOrderPrice><Payments><Payment><Type>CA</Type><Status /><Amount><SimpleCurrencyPrice Code="USD">7256.14</SimpleCurrencyPrice></Amount><Method><CashMethod /></Method></Payment></Payments><OrderItems><OrderItem OrderItemID="ORDERITEM001" Owner="ET"><PriceDetail><TotalAmount><SimpleCurrencyPrice Code="USD">7256.14</SimpleCurrencyPrice></TotalAmount><BaseAmount Code="USD">6546.00</BaseAmount><Surcharges><Surcharge><Total Code="USD">0</Total></Surcharge></Surcharges><Taxes><Total Code="USD">710.14</Total></Taxes></PriceDetail><Service ServiceID="SV_1_001"><PassengerRef>PAX001 PAX002</PassengerRef><ServiceRef>SV_CX</ServiceRef><SegmentRef>SEG_ADDIAD_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 |
<TicketDocInfos><TicketDocInfo><TicketDocument><TicketDocNbr>0712134759422</TicketDocNbr><Type>T</Type><NumberofBooklets>2</NumberofBooklets><ReportingType>Airline</ReportingType></TicketDocument><PassengerReference>PAX001</PassengerReference></TicketDocInfo><TicketDocInfo><TicketDocument><TicketDocNbr>0712134759423</TicketDocNbr><Type>T</Type><NumberofBooklets>2</NumberofBooklets><ReportingType>Airline</ReportingType></TicketDocument><PassengerReference>PAX002</PassengerReference></TicketDocInfo></TicketDocInfos>
Request | Root node of the request schema |
---|---|
TicketDocInfos |
|
TicketDocInfo | |
TicketDocument | |
TicketDocNbr | Ticket number - 0712134759422 |
Type | e.g. T |
NumberofBooklets | e.g. 2 |
ReportingType | Airline |
PassengerReference | e.g. PAX001 |
<DataLists><PassengerList><Passenger PassengerID="PAX001"><PTC>ADT</PTC><Individual><Birthdate>1988-06-10</Birthdate><Gender>Female</Gender><GivenName>JANE MRS</GivenName><Surname>SMITH</Surname></Individual><IdentityDocument><IdentityDocumentNumber>543000123</IdentityDocumentNumber><IdentityDocumentType>F</IdentityDocumentType><IssuingCountryCode>US</IssuingCountryCode><CitizenshipCountryCode>US</CitizenshipCountryCode><ExpiryDate>2022-01-16</ExpiryDate><Birthdate>1988-06-10</Birthdate><Birthplace>US</Birthplace></IdentityDocument><ContactInfoRef>CONTACT_PAX_1</ContactInfoRef></Passenger><Passenger PassengerID="PAX002"><PTC>ADT</PTC><Individual><Birthdate>2019-06-10</Birthdate><Gender>Female</Gender><GivenName>SAWI MRS</GivenName><Surname>SAWALE</Surname></Individual><IdentityDocument><IdentityDocumentNumber>543000123</IdentityDocumentNumber><IdentityDocumentType>F</IdentityDocumentType><IssuingCountryCode>US</IssuingCountryCode><CitizenshipCountryCode>US</CitizenshipCountryCode><ExpiryDate>2022-01-16</ExpiryDate><Birthdate>2019-06-10</Birthdate><Birthplace>US</Birthplace></IdentityDocument><ContactInfoRef>CONTACT_PAX_2</ContactInfoRef></Passenger></PassengerList><ContactList><ContactInformation ContactID="CONTACT_PAX_1"><ContactProvided><Phone><Label>HOME</Label><CountryDialingCode>IAD</CountryDialingCode><PhoneNumber>944123456</PhoneNumber></Phone></ContactProvided><ContactProvided><EmailAddress><EmailAddressValue>JANE@MAIL.COM</EmailAddressValue></EmailAddress></ContactProvided></ContactInformation><ContactInformation ContactID="CONTACT_PAX_2"><ContactProvided><Phone><Label>HOME</Label><CountryDialingCode>IAD</CountryDialingCode><PhoneNumber>944123456</PhoneNumber></Phone></ContactProvided><ContactProvided><EmailAddress><EmailAddressValue>JANE@MAIL.COM</EmailAddressValue></EmailAddress></ContactProvided></ContactInformation></ContactList><FlightSegmentList><FlightSegment SegmentKey="SEG_ADDIAD_001"><Departure><AirportCode>ADD</AirportCode><Date>2023-03-20</Date><Time>09:00</Time><Terminal /></Departure><Arrival><AirportCode>IAD</AirportCode><Date>2023-03-20</Date><Time>19:25</Time><Terminal /></Arrival><MarketingCarrier><AirlineID>ET</AirlineID><FlightNumber>0516</FlightNumber></MarketingCarrier><OperatingCarrier><AirlineID>ET</AirlineID><FlightNumber>0516</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>PT16H10M</Value></FlightDuration></FlightDetail></FlightSegment></FlightSegmentList><FlightList><Flight FlightKey="FLT001"><SegmentReferences OnPoint="ADD" OffPoint="WAS">SEG_ADDIAD_001</SegmentReferences></Flight></FlightList><OriginDestinationList><OriginDestination><DepartureCode UOM="Miles">ADD</DepartureCode><ArrivalCode UOM="Miles">WAS</ArrivalCode><FlightReferences>FLT001</FlightReferences></OriginDestination></OriginDestinationList><InstructionsList><Instruction ListKey="RULE_ADD_WAS"><FreeFormTextInstruction><Remark>NOTE - THE FOLLOWING TEXT IS INFORMATIONAL AND NOT</Remark></FreeFormTextInstruction></Instruction></InstructionsList><ServiceDefinitionList><ServiceDefinition ServiceDefinitionID="SV_CX" Owner="ET"><Name>CX</Name><Descriptions><Description><Text>CLOUD 9 RESTRICTED</Text></Description></Descriptions></ServiceDefinition></ServiceDefinitionList><SeatDefinitionList /></DataLists>
Request | Root node of the request schema |
---|---|
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 |
XML Sample
Request and Response | Update traveldoc xml |
---|---|
Order chnage Request | Click to download |
Orderview Response | Click to download |
Error Response Description
Error responses
Error Code | Error Code Text |
---|---|
400 | Page not found |
200 | Success response |
0 | Error |