Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Release 2023.21

Examples of messages with complete flows can be downloaded from here.

...

Insert excerpt
NDCDOCStage:Copy of API Messages with ExamplesNDCDOCStage:Copy of
API Messages with Examples
nameLegend
nopaneltrue

Common Sections

Expand
titleCommon SectionsHTTP Header

HTTP Header

Insert excerpt
NDCDOCStage:Copy of HTTP HeaderNDCDOCStage:Copy of
HTTP Header
nameHTTP Header
nopaneltrue

Expand
titleLanguage, Version and Name Space

Language, Version and Name Space

Insert excerpt

NDCDOCStage:Copy of

Language, Version and Name Space

NDCDOCStage:Copy of Language

Language, Version and Name Space
nameVersion_Lang_NameSpace
nopaneltrue

Expand
titlePoint of Sale

Point of Sale

Insert excerpt

NDCDOCStage:Copy of

Point of Sale and Document

NDCDOCStage:Copy of

Point of Sale and Document
namePointOfSale
nopaneltrue

Expand
titleDocument

Document

Insert excerpt

NDCDOCStage:Copy of

Point of Sale and Document

NDCDOCStage:Copy of

Point of Sale and Document
nameDocument
nopaneltrue

Expand
titleParty

Party

Insert excerpt

NDCDOCStage:Copy of

Party Elements

NDCDOCStage:Copy of

Party Elements
nameSenderSection
nopaneltrue

Insert excerpt

NDCDOCStage:Copy of

Party Elements

NDCDOCStage:Copy of

Party Elements
nameParticipantSection
nopaneltrue

Insert excerpt

NDCDOCStage:Copy of

Party Elements

NDCDOCStage:Copy of Party Elements

Party Elements
nameRecipientSection
nopaneltrue

In addition to the Common Sections, this service is called with the following data:

...

Expand
titleOrderChangeMetadata

Insert excerpt
OrderChangeMetadata
OrderChangeMetadata
nameOrderChangeMetadata
nopaneltrue

DataLists

...

Expand
titlePassengerListDataLists -

PassengerList

Insert excerpt
NDCDOCStage:Copy of PassengerListNDCDOCStage:Copy of
PassengerList
namePassengerList
nopaneltrue

...

Expand
titleContactListDataLists -

ContactList

Insert excerpt
NDCDOCStage:Copy of ContactListNDCDOCStage:Copy of
ContactList
nameContactList
nopaneltrue

...

Expand
titleFlightSegmentListDataLists -

FlightSegmentList

Insert excerpt
NDCDOCStage:Copy of FlightSegmentListNDCDOCStage:Copy of
FlightSegmentList
nameFlightSegment
nopaneltrue

...

Expand
titleDataLists - InstructionsList

InstructionList

Insert excerpt
NDCDOCStage:Copy of InstructionsListNDCDOCStage:Copy of
InstructionsList
nameInstructionsList
nopaneltrue

Metadata

Expand
titleForms of Payment

Insert excerpt
Forms of Payment Metadata
Forms of Payment Metadata
namePaymentFormMetadata
nopaneltrue

Example OrderChangeRQ:

Expand
titleXML SampleOrderChangeRQ example
Code Block
languagexml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.iata.org/IATA/EDIST/2017.2">
	<soapenv:Header/>
	<soapenv:Body>
		<OrderChangeRQ Version="5.000" PrimaryLangID="es" xmlns="http://www.iata.org/IATA/EDIST/2017.2">
			<PointOfSale>
				<Location>
					<CountryCode>ES</CountryCode>
				</Location>
			</PointOfSale>
			<Document>
				<ReferenceVersion>5.000</ReferenceVersion>
			</Document>
			<Party>
				<Sender>
					<TravelAgencySender>
						<IATA_Number>78288254<Number>XXXXXXXX</IATA_Number>
						<AgencyID>firstAgency</AgencyID>
					</TravelAgencySender>
				</Sender>
				<Participants>
					<Participant>
						<AggregatorParticipant SequenceNumber="1">
							<AggregatorID>00000022<<AggregatorID>000000XX</AggregatorID>
						</AggregatorParticipant>
					</Participant>
				</Participants>
			</Party>
			<Query>
				<OrderID>IB5908506ad86443e48f241f318a18bb26OC</OrderID>
				<PassengerServicing>
					<New PassengerID="ADULT_02">
						<ActionType>Add</ActionType>
					</New>
				</PassengerServicing>
			</Query>
			<DataLists>
				<PassengerList>
					<Passenger PassengerID="ADULT_01">
						<PTC>ADT</PTC>
						<Birthdate>1965-12-20</Birthdate>
						<Individual IndividualID="IND_ADULT_01">
							<Gender>Male</Gender>
							<NameTitle>MR</NameTitle>
							<GivenName>JANE</GivenName>
							<Surname>SMITH</Surname>
						</Individual>
						<FOID>
							<FOID_Number>30000529L</FOID_Number>
							<FOID_Type>NI</FOID_Type>
						</FOID>
						<ContactInfoRef>ADULT_01_CONTACT</ContactInfoRef>
					</Passenger>
					<Passenger PassengerID="ADULT_02">
						<PTC>ADT</PTC>
						<Birthdate>1955-04-01</Birthdate>
						<Individual IndividualID="IND_ADULT_02">
							<Gender>Female</Gender>
							<NameTitle>MRS</NameTitle>
							<GivenName>BAMBI</GivenName>
							<Surname>DISNEY RESERVAS</Surname>
						</Individual>
						<FOID>
							<FOID_Number>47226285V</FOID_Number>
							<FOID_Type>NI</FOID_Type>
						</FOID>
						<ContactInfoRef>ADULT_01_CONTACT</ContactInfoRef>
					</Passenger>
				</PassengerList>
				<ContactList>
					<ContactInformation ContactID="ADULT_01_CONTACT">
						<ContactType/>
						<ContactProvided>
							<EmailAddress>
								<EmailAddressValue>iteggo.cavalos@iberia.es</EmailAddressValue>
							</EmailAddress>
						</ContactProvided>
						<ContactProvided>
							<Phone>
								<Label>Passenger</Label>
								<PhoneNumber>+34666554433</PhoneNumber>
							</Phone>
							<Phone>
								<Label>Emergency</Label>
								<PhoneNumber>34666554433</PhoneNumber>
							</Phone>
						</ContactProvided>
						<Individual>
							<GivenName>CONTACTO</GivenName>
							<Surname>EMERGENCIA</Surname>
						</Individual>
					</ContactInformation>
					<ContactInformation ContactID="Payer">
						<ContactType>Payer</ContactType>
						<ContactProvided>
							<EmailAddress>
								<EmailAddressValue>accept@accept.com</EmailAddressValue>
							</EmailAddress>
						</ContactProvided>
						<ContactProvided>
							<Phone>
								<PhoneNumber>1273211111</PhoneNumber>
							</Phone>
						</ContactProvided>
						<IndividualRef>IND_ADULT_01</IndividualRef>
					</ContactInformation>
				</ContactList>
				<FlightSegmentList>
					<FlightSegment SegmentKey="IB042320240527">
						<Departure>
							<AirportCode>BIO</AirportCode>
							<Date>2024-05-27</Date>
							<Time>09:15</Time>
							<AirportName>Bilbao</AirportName>
						</Departure>
						<Arrival>
							<AirportCode>MAD</AirportCode>
							<Date>2024-05-27</Date>
							<Time>10:25</Time>
							<ChangeOfDay>0</ChangeOfDay>
							<AirportName>Madrid Adolfo Suarez-Barajas</AirportName>
							<Terminal>
								<Name>4</Name>
							</Terminal>
						</Arrival>
						<MarketingCarrier>
							<AirlineID>IB</AirlineID>
							<Name>Iberia</Name>
							<FlightNumber>0423</FlightNumber>
						</MarketingCarrier>
						<OperatingCarrier>
							<AirlineID>IB</AirlineID>
							<Name>Iberia</Name>
							<FlightNumber>0423</FlightNumber>
							<Disclosures>
								<Description>
									<Text>IB</Text>
								</Description>
							</Disclosures>
						</OperatingCarrier>
						<Equipment>
							<AircraftCode>32A</AircraftCode>
							<Name>Airbus A320 (Sharklets)</Name>
						</Equipment>
						<FlightDetail>
							<FlightDuration>
								<Value>PT1H10M</Value>
							</FlightDuration>
						</FlightDetail>
					</FlightSegment>
					<FlightSegment SegmentKey="IB380420240527">
						<Departure>
							<AirportCode>MAD</AirportCode>
							<Date>2024-05-27</Date>
							<Time>15:40</Time>
							<AirportName>Madrid Adolfo Suarez-Barajas</AirportName>
							<Terminal>
								<Name>4</Name>
							</Terminal>
						</Departure>
						<Arrival>
							<AirportCode>IBZ</AirportCode>
							<Date>2024-05-27</Date>
							<Time>16:55</Time>
							<ChangeOfDay>0</ChangeOfDay>
							<AirportName>Ibiza</AirportName>
						</Arrival>
						<MarketingCarrier>
							<AirlineID>IB</AirlineID>
							<Name>Iberia</Name>
							<FlightNumber>3804</FlightNumber>
						</MarketingCarrier>
						<OperatingCarrier>
							<AirlineID>I2</AirlineID>
							<Name>Iberia Express</Name>
							<Disclosures>
								<Description>
									<Text>I2</Text>
								</Description>
							</Disclosures>
						</OperatingCarrier>
						<Equipment>
							<AircraftCode>32Q</AircraftCode>
							<Name>Airbus A321neo</Name>
						</Equipment>
						<FlightDetail>
							<FlightDuration>
								<Value>PT1H15M</Value>
							</FlightDuration>
						</FlightDetail>
					</FlightSegment>
				</FlightSegmentList>
				<InstructionsList>
					<Instruction ListKey="Instruction_1">
						<FreeFormTextInstruction refs="ADULT_02 IB042320240527 IB380420240527">
							<Remark>BAGGAGE/SP/0DD</Remark>
						</FreeFormTextInstruction>
					</Instruction>
				</InstructionsList>
			</DataLists>
		</OrderChangeRQ>
	</soapenv:Body>
</soapenv:Envelope>

Response Body

Order View RS v17 v2 (Branded Fares)

Error messages

Examples OrderChangeRQ 2024:

Expand
titleOrderChangeRQ for Cancel (For only some passengers resulting in a Split) UC02 example 2024
Code Block
languagexml
<Query>
	<OrderID>IB95a0ff8f7dd846a7af4227367d18c52cOP</OrderID>
	<OrderServicing>
		<AcceptOffer>
			<Offer OfferID="IB4875affa788a49bba5ea0a9f8b928bbf" Owner="IB" ResponseID="GW-1712245668175-fUH4w">
				<OfferItem OfferItemID="IB4875affa788a49bba5ea0a9f8b928bbf_01">
					<PassengerRefs>ADULT_01</PassengerRefs>
				</OfferItem>
			</Offer>
		</AcceptOffer>
		<Delete>
			<OrderItemID>IB95a0ff8f7dd846a7af4227367d18c52cOP_01</OrderItemID>
		</Delete>
	</OrderServicing>
</Query>
Expand
titleOrderChangeRQ Name Correction Passenger 2 UC03 example 2024
Code Block
languagexml
<PassengerServicing>
	<New PassengerID="ADULT_02">
		<Individual>
			<GivenName>BAMBOS</GivenName>
			<Surname>DISNEY RESERVAS</Surname>
		</Individual>
		<ActionType>Add</ActionType>
	</New>
	<Previous PassengerID="ADULT_02">
		<Individual>
			<GivenName>BAMBI</GivenName>
			<Surname>DISNEY RESERVAS</Surname>
		</Individual>
		<ActionType>Delete</ActionType>
	</Previous>
</PassengerServicing>
Expand
titleOrderChangeRQ Split for Change UC04 example 2024
Code Block
languagexml
<OrderServicing>
	<AcceptOffer>
		<Offer OfferID="IBd96faaf0e7a847788900f5615af9c551OP" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzI1MzU5MTU1MjA3LVB2TE15">
			<OfferItem OfferItemID="IBd96faaf0e7a847788900f5615af9c551OP_01">
				<PassengerRefs>ADULT_02</PassengerRefs>
			</OfferItem>
		</Offer>
	</AcceptOffer>
	<Delete>
		<OrderItemID>IB7f6dc0a005474129b12c57947e7d0144OC_02</OrderItemID>
	</Delete>
</OrderServicing>
Expand
titleOrderChangeRQ Credit Card Payment UC04 example 2024
Code Block
languagexml
<Payments>
	<Payment>
		<Type>CC</Type>
		<Method>
			<PaymentCard>
				<CardType>VI</CardType>
				<SeriesCode>XXX</SeriesCode>
				<CardHolderName>JANE SMITH</CardHolderName>
				<CardHolderBillingAddress>
					<Street>125 PRESTON RD BRIGH</Street>
					<CityName>MA</CityName>
					<StateProv>BN</StateProv>
					<PostalCode>BN12LP</PostalCode>
					<CountryCode>ES</CountryCode>
				</CardHolderBillingAddress>
				<CardNumber>44XXXXXXXXXXXX04</CardNumber>
				<EffectiveExpireDate>
					<Expiration>MMYY</Expiration>
				</EffectiveExpireDate>
			</PaymentCard>
		</Method>
		<Amount Code="USD">187.0</Amount>
		<Payer>
			<ContactInfoRefs>Payer</ContactInfoRefs>
		</Payer>
	</Payment>
</Payments>
Expand
titleOrderChangeRQ Passenger Change UC04 example 2024
Code Block
languagexml
<PassengerList>
	<Passenger PassengerID="ADULT_02">
		<PTC>ADT</PTC>
		<Individual IndividualID="IND_ADULT_02">
			<Gender>Female</Gender>
			<NameTitle>MRS</NameTitle>
			<GivenName>BAMBI</GivenName>
			<Surname>DISNEY RESERVAS</Surname>
		</Individual>
	</Passenger>
</PassengerList>
Expand
titleOrderChangeRQ Reprice UC08 example 2024
Code Block
languagexml
<Query>
	<OrderID>IB0a88e0b496d7465286620feb1a282412OC</OrderID>
	<AcceptRepricedOrder>
		<ResponseID>GW-1720521893210-x4bNe</ResponseID>
	</AcceptRepricedOrder>
</Query>
Expand
titleOrderChangeRQ IATA Delegation UC08 example 2024
Code Block
languagexml
<Sender>
	<TravelAgencySender>
		<Name>UATs Agency Tests SA</Name>
		<Contacts>
			<Contact>
				<EmailContact>
					<Address>xxxxx@xxxxx.com</Address>
				</EmailContact>
				<PhoneContact>
					<Application>MOBILE</Application>
					<Number>+666666666</Number>
				</PhoneContact>
				<Name>
					<Surname>Perez</Surname>
					<Given>Pepe</Given>
				</Name>
			</Contact>
		</Contacts>
		<IATA_Number>22222222</IATA_Number>
		<AgencyID>Second Agency</AgencyID>
	</TravelAgencySender>
</Sender>
<Participant>
	<TravelAgencyParticipant SequenceNumber="1">
		<Name>AgencyName</Name>
		<Contacts>
			<Contact>
				<EmailContact>
					<Address>xxxxxx.xxxxx@xxxxx.es</Address>
				</EmailContact>
				<PhoneContact>
					<Application>BUSINESS</Application>
					<Number>+34666666555</Number>
				</PhoneContact>
				<Name>
					<Surname>Martinez</Surname>
					<Given>Pepe</Given>
				</Name>
			</Contact>
		</Contacts>
		<IATA_Number>11111111</IATA_Number>
		<AgencyID>First Agency</AgencyID>
	</TravelAgencyParticipant>
</Participant>
Expand
titleOrderChangeRQ Add Frequent Flyer UC08 example 2024
Code Block
languagexml
<Query>
	<OrderID>IB0a88e0b496d7465286620feb1a282412OC</OrderID>
	<PassengerServicing>
		<New PassengerID="ADULT_01">
			<LoyaltyProgramAccount>
				<Airline>
					<AirlineDesignator>IB</AirlineDesignator>
				</Airline>
				<AccountNumber>28033504</AccountNumber>
			</LoyaltyProgramAccount>
			<ActionType>Add</ActionType>
		</New>
	</PassengerServicing>
</Query>
Expand
titleOrderChangeRQ Add On Business UC08 example 2024
Code Block
languagexml
<Query>
	<OrderID>IB0a88e0b496d7465286620feb1a282412OC</OrderID>
	<PassengerServicing>
		<New PassengerID="ADULT_01">
			<LoyaltyProgramAccount>
			    <Airline>
					<AirlineDesignator>IB</AirlineDesignator>
				</Airline>
				<AccountNumber>OB87654324</AccountNumber>
			</LoyaltyProgramAccount>
			<ActionType>Add</ActionType>
		</New>
	</PassengerServicing>
</Query>
Expand
titleOrderChangeRQ Cash Payment UC09 example 2024
Code Block
languagexml
<Payments>
	<Payment>
		<Type>CA</Type>
		<Method>
			<Cash CashInd="true"/>
		</Method>
		<Amount Code="EUR">10.00</Amount>
		<Payer>
			<ContactInfoRefs>Payer</ContactInfoRefs>
		</Payer>
	</Payment>
</Payments>
Expand
titleOrderChangeRQ Priority Boarding Postsale UC09 example 2024
Code Block
languagexml
<OrderID>IBaa818c1811134178b949e1aa4a55a690OC</OrderID>
<OrderServicing>
	<AcceptOffer>
		<Offer OfferID="ALACARTE_IB2d8cd2c7efb246d98e74c30cf2bee15d" Owner="IB" ResponseID="IBaa818c1811134178b949e1aa4a55a690OC">
			<OfferItem OfferItemID="ALACARTE_PRIORITY_IB2d8cd2c7efb246d98e74c30cf2bee15d_01">
				<PassengerRefs>ADULT_01</PassengerRefs>
			</OfferItem>
			<OfferItem OfferItemID="ALACARTE_PRIORITY_IB2d8cd2c7efb246d98e74c30cf2bee15d_01">
				<PassengerRefs>ADULT_02</PassengerRefs>
			</OfferItem>
		</Offer>
	</AcceptOffer>
</OrderServicing>
Expand
titleOrderChangeRQ Payment Postsale. Credit Card UC10 example 2024
Code Block
languagexml
<Payments>
	<Payment>
		<Type>CC</Type>
		<Method>
			<PaymentCard>
				<CardType>VI</CardType>
				<SeriesCode>XXX</SeriesCode>
				<CardHolderName>JANE SMITH</CardHolderName>
				<CardHolderBillingAddress>
					<Street>125 PRESTON RD BRIGH</Street>
					<CityName>MA</CityName>
					<StateProv>BN</StateProv>
					<PostalCode>BN12LP</PostalCode>
					<CountryCode>CL</CountryCode>
				</CardHolderBillingAddress>
				<CardNumber>40XXXXXXXXXXXX23</CardNumber>
				<EffectiveExpireDate>
					<Expiration>MMYY</Expiration>
				</EffectiveExpireDate>
			</PaymentCard>
		</Method>
		<Amount Code="CLP">139632.00</Amount>
		<Payer>
			<ContactInfoRefs>Payer</ContactInfoRefs>
		</Payer>
	</Payment>
</Payments>
Expand
titleOrderChangeRQ 15 & 32 kg Baggage Postsale UC10 example 2024
Code Block
languagexml
<OrderServicing>
	<AcceptOffer>
		<Offer OfferID="ALACARTE_IBbb80730260b14e90a956ea41f1b39018" Owner="IB" ResponseID="IB3c0ba7931a73458eb69be3bf25a8ebe4OC">
			<OfferItem OfferItemID="ALACARTE_BAGGAGE_IBbb80730260b14e90a956ea41f1b39018_01">
				<PassengerRefs>ADULT_02</PassengerRefs>
			</OfferItem>
			<OfferItem OfferItemID="ALACARTE_BAGGAGE_IBbb80730260b14e90a956ea41f1b39018_17">
				<PassengerRefs>ADULT_02</PassengerRefs>
			</OfferItem>
			<OfferItem OfferItemID="ALACARTE_BAGGAGE_IBbb80730260b14e90a956ea41f1b39018_25">
				<PassengerRefs>ADULT_02</PassengerRefs>
			</OfferItem>
			<OfferItem OfferItemID="ALACARTE_BAGGAGE_IBbb80730260b14e90a956ea41f1b39018_41">
				<PassengerRefs>ADULT_02</PassengerRefs>
			</OfferItem>
		</Offer>
	</AcceptOffer>
</OrderServicing>
Expand
titleOrderChangeRQ Credit Card UC11 example 2024
Code Block
languagexml
<Payments>
	<Payment>
		<Type>CC</Type>
		<Method>
			<PaymentCard>
				<CardType>VI</CardType>
				<SeriesCode>XXX</SeriesCode>
				<CardHolderName>JANE SMITH</CardHolderName>
				<CardHolderBillingAddress>
					<Street>125 PRESTON RD BRIGH</Street>
					<CityName>MA</CityName>
					<StateProv>BN</StateProv>
					<PostalCode>BN12LP</PostalCode>
					<CountryCode>ES</CountryCode>
				</CardHolderBillingAddress>
				<CardNumber>40XXXXXXXXXXXX99</CardNumber>
				<EffectiveExpireDate>
					<Expiration>MMYY</Expiration>
				</EffectiveExpireDate>
			</PaymentCard>
		</Method>
		<Amount Code="EUR">14.00</Amount>
		<Payer>
			<ContactInfoRefs>Payer</ContactInfoRefs>
		</Payer>
	</Payment>
</Payments>
Expand
titleOrderChangeRQ Postsale Seat UC11 example 2024
Code Block
languagexml
<OrderServicing>
	<AcceptOffer>
		<Offer OfferID="ALACARTE_SEAT_IB1f0c7c670e0c475abbeec10c895e268a" Owner="IB" ResponseID="IB30c290390a7a41268d2316713f0edc9fOC">
			<OfferItem OfferItemID="ALACARTE_SEAT_IB1f0c7c670e0c475abbeec10c895e268a_03">
				<PassengerRefs>ADULT_01</PassengerRefs>
				<ALaCarteSelection>
					<Quantity>1</Quantity>
					<SegmentID>IB395020240826</SegmentID>
				</ALaCarteSelection>
				<SeatSelection>
					<Row>16</Row>
					<Column>A</Column>
				</SeatSelection>
			</OfferItem>
		</Offer>
	</AcceptOffer>
</OrderServicing>
Expand
titleOrderChangeRQ Postsale Special Equipment UC12 example 2024
Code Block
languagexml
<OrderServicing>
	<AcceptOffer>
		<Offer OfferID="ALACARTE_IBd7dcea90136e4b188fbc2424766ef4ee" Owner="IB" ResponseID="IB4491ac33c3fd4abebc7e5b13102666b4OC">
			<OfferItem OfferItemID="ALACARTE_SPEQUIPMENT_IBd7dcea90136e4b188fbc2424766ef4ee_17">
				<PassengerRefs>ADULT_01</PassengerRefs>
			</OfferItem>
			<OfferItem OfferItemID="ALACARTE_SPEQUIPMENT_IBd7dcea90136e4b188fbc2424766ef4ee_01">
				<PassengerRefs>ADULT_01</PassengerRefs>
			</OfferItem>
		</Offer>
	</AcceptOffer>
</OrderServicing>
Expand
titleOrderChangeRQ Postsale Cash UC12 example 2024
Code Block
languagexml
<Payments>
	<Payment>
		<Type>CA</Type>
		<Method>
			<Cash CashInd="true"/>
		</Method>
		<Amount Code="USD">260.00</Amount>
		<Payer>
			<ContactInfoRefs>Payer</ContactInfoRefs>
		</Payer>
	</Payment>
</Payments>

Response Body

OrderViewRS

Examples of messages with complete flows can be downloaded from here.

Error messages

For further information about all kind of error messages, please go to the following link:

Error CodesErrors

Image RemovedImage Added