Versions Compared

Key

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

...

Release 2024.04

*Functionality improvements do not necessarily affect the message structure.

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

...

Insert excerpt
NDC2:New 17.2 COMBINEDNDC2:New 17.2 COMBINEDAPI Messages with Examples
API Messages with Examples
nameLegend
nopaneltrue

Common Sections

/wiki/spaces/NDC2/pages/3727032388
Expand
titleCommon Sections
HTTP Header

HTTP Header

Insert excerpt
NDC2:HTTP HeaderNDC2:
HTTP Header
nameHTTP Header
nopaneltrue

Expand
titleLanguage, Version and Name Space

Language, Version and Name Space

Insert excerpt

NDC2:

Language, Version and Name Space

NDC2:

Language, Version and Name Space
nameVersion_Lang_NameSpace
nopaneltrue

Expand
titlePoint of Sale

Point of Sale

Insert excerpt

NDC2:

Point of Sale and Document

NDC2:

Point of Sale and Document
name

PointOfSale

Document
nopaneltrue

Expand
titleDocument

Document

Insert excerpt

NDC2:

Point of Sale and Document

NDC2:

Point of Sale and Document
nameDocument
nopaneltrue

Expand
titleParty

Party

Insert excerpt

NDC2:

Party Elements

NDC2:

Party Elements
nameSenderSection
nopaneltrue

Insert excerpt

NDC2:

Party Elements

NDC2:

Party Elements
nameParticipantSection
nopaneltrue

Insert excerpt

NDC2:

Party Elements

NDC2:

Party Elements
nameRecipientSection
nopaneltrue

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

...

Expand
titleQuery - OrderReshopRQ

Insert excerpt
Query - OrderReshopRQ
Query - OrderReshopRQ
nameQuery_OrderReshop_OrderID
nopaneltrue
Insert excerpt
Query - OrderReshopRQ
Query - OrderReshopRQ
nameQuery_OrderReshop_RepriceFlow
nopaneltrue
Insert excerpt
Query - OrderReshopRQ
Query - OrderReshopRQ
nameQuery_OrderReshop_AvailabilityAdd
nopaneltrue
Insert excerpt
Query - OrderReshopRQ
Query - OrderReshopRQ
nameQuery_OrderReshop_AvailabilityCancel
nopaneltrue
Insert excerpt
Query - OrderReshopRQ
Query - OrderReshopRQ
nameQuery_OrderReshop_ReshopReprice
nopaneltrue

Preferences

Expand
title
Preferences
Query - Reprice on hold

Insert excerpt

Preferences

Query -

OrderReshop

Reprice on hold

Preferences

Query -

OrderReshop

Reprice on hold
name

Preferences_OrderReshop

Reprice on hold
nopaneltrue

DataLists

...

/ PassengerList

Expand
titleDataLists - / PassengerList

Insert excerpt
NDC2:PassengerListNDC2:
PassengerList
namePassengerList
nopaneltrue

Example OrderReshopRQ :

Expand
titleExample - OrderReshopRQ - Availability 17.2v2
Code Block
languagexml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <OrderReshopRQ xsi:schemaLocation="http://www.iata.org/IATA/EDIST/2017.2 ../../OrderReshopRQ.xsd" Version="5.000" PrimaryLangID="es" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 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>
                  <Name>Alvaros Agency Tests SA</Name>
                  <Contacts>
                     <Contact>
                        <EmailContact>
                           <Address>pruebas@pruebas.com</Address>
                        </EmailContact>
                        <PhoneContact>
                           <Application>MOBILE</Application>
                           <Number CountryCode="+34">666666666</Number>
                        </PhoneContact>
                        <Name>
                           <Surname>Hernandez</Surname>
                           <Given>Raul</Given>
                        </Name>
                     </Contact>
                  </Contacts>
                  <IATA_Number>12345678</IATA_Number>
                  <AgencyID>Alvaros VIAJES</AgencyID>
               </TravelAgencySender>
            </Sender>
         </Party>
         <Query>
            <OrderID>IB73b10257e52c4aeba1fd7c6b40588064OC</OrderID>
            <Reshop>
               <OrderServicing>
                  <Add>
                     <FlightQuery>
                        <!--Solo indicamos lo que queremos cambiar, lo que se mantiene lo decimos abajo diciendo el servicio que queremos mantenerWe only indicate what we want to change, and what is maintained we say below the service we want to maintain.-->
                        <OriginDestinations>
                           <OriginDestination>
                              <Departure>
                                 <AirportCode>SDR</AirportCode>
                                 <Date>2024-03-05</Date>
                              </Departure>
                              <Arrival>
                                 <AirportCode>EZE</AirportCode>
                              </Arrival>
                           </OriginDestination>
                           <OriginDestination>
                              <Departure>
                                 <AirportCode>EZE</AirportCode>
                                 <Date>2024-03-10</Date>
                              </Departure>
                              <Arrival>
                                 <AirportCode>SDR</AirportCode>
                              </Arrival>
                           </OriginDestination>
                        </OriginDestinations>
                     </FlightQuery>
                     <Preference>
                        <FlightPreferences>
                           <Characteristic>
                              <DirectPreferences>4</DirectPreferences>
                           </Characteristic>
                        </FlightPreferences>
                     </Preference>
                     <Passengers>
                        <PassengerReferences>ADULT_01 ADULT_02</PassengerReferences>
                     </Passengers>
                  </Add>
                  <Delete>
                     <OrderItem OrderItemID="IB73b10257e52c4aeba1fd7c6b40588064OC_01"/>
                     <OrderItem OrderItemID="IB73b10257e52c4aeba1fd7c6b40588064OC_02"/>
                  </Delete>
               </OrderServicing>
            </Reshop>
         </Query>
         <DataLists>
            <PassengerList>
               <Passenger PassengerID="ADULT_01">
                  <PTC>ADT</PTC>
                  <Individual>
                     <GivenName>Luis Alfonso</GivenName>
                     <Surname>PÈrez PÈrez</Surname>
                  </Individual>
               </Passenger>
               <Passenger PassengerID="ADULT_02">
                  <PTC>ADT</PTC>
                  <Individual>
                     <GivenName>Ana Laura</GivenName>
                     <Surname>Santos Perez</Surname>
                  </Individual>
               </Passenger>
            </PassengerList>
         </DataLists>
      </OrderReshopRQ>
   </soapenv:Body>
</soapenv:Envelope>
Expand
titleExample - OrderReshopRQ - Fare 17.2v2
Code Block
languagexml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <OrderReshopRQ xsi:schemaLocation="http://www.iata.org/IATA/EDIST/2017.2 ../../OrderReshopRQ.xsd" Version="5.000" PrimaryLangID="es" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 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>12345678</IATA_Number>
                  <AgencyID>Alvaros VIAJES</AgencyID>
               </TravelAgencySender>
            </Sender>
         </Party>
         <Query>
            <OrderID>IB73b10257e52c4aeba1fd7c6b40588064OC</OrderID>
            <Reshop>
               <OrderServicing>
                  <!--CambiamosWe only solochange lathe idadeparture, queremoswe mantenerwant la vueltato keep the return-->
                  <Add>
                     <Qualifier>
                        <ExistingOrderQualifier>
                           <OrderKeys>
                              <OrderID Owner="IB">IB73b10257e52c4aeba1fd7c6b40588064OC</OrderID>
                              <AssociatedIDs>
                                 <AssociatedID>
                                    <OfferItemID Owner="IB">IB16e45cf7c4c1447abddaea68fb5242dbOP_01</OfferItemID>
                                    <!--Reference to previous ReshopOffer so we can use the items-->
                                 </AssociatedID>
                              </AssociatedIDs>
                           </OrderKeys>
                           <PassengerReferences>ADULT_01 ADULT_02</PassengerReferences>
                        </ExistingOrderQualifier>
                     </Qualifier>
                  </Add>
               </OrderServicing>
            </Reshop>
         </Query>
         <DataLists>
            <PassengerList>
               <Passenger PassengerID="ADULT_01">
                  <PTC>ADT</PTC>
                  <Individual>
                     <GivenName>Luis Alfonso</GivenName>
                     <Surname>PÈrez PÈrez</Surname>
                  </Individual>
               </Passenger>
               <Passenger PassengerID="ADULT_02">
                  <PTC>ADT</PTC>
                  <Individual>
                     <GivenName>Ana Laura</GivenName>
                     <Surname>Santos Perez</Surname>
                  </Individual>
               </Passenger>
            </PassengerList>
         </DataLists>
      </OrderReshopRQ>
   </soapenv:Body>
</soapenv:Envelope>

Error messages

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

Error Codes

...

Examples OrderReshopRQ 2024:

Expand
titleOrderReshopRQ OpenJaw UC01 (Canceling the Order) example 2024
Code Block
languagexml
<Query>
	<OrderID>IBd9f8773737e74c85b1172bf9168214b1OC</OrderID>
	<Reshop>
		<OrderServicing>
			<Delete>
				<OrderItem OrderItemID="IBd9f8773737e74c85b1172bf9168214b1OC_01"/>
			</Delete>
		</OrderServicing>
	</Reshop>
</Query>
Expand
titleOrderReshopRQ for Cancel (for only some passengers resulting in a Split) UC02 example 2024
Code Block
languagexml
<Query>
	<OrderID>IB95a0ff8f7dd846a7af4227367d18c52cOP</OrderID>
	<Reshop>
		<OrderServicing>
			<Delete>
				<OrderItem OrderItemID="IB95a0ff8f7dd846a7af4227367d18c52cOP_01"/>
			</Delete>
		</OrderServicing>
	</Reshop>
</Query>
Expand
titleOrderReshopRQ for Change (for only some passengers resulting in a Split) UC04 example 2024
Code Block
languagexml
<Query>
	<OrderID>IB7f6dc0a005474129b12c57947e7d0144OC</OrderID>
	<Reshop>
		<OrderServicing>
			<Add>
				<FlightQuery>
					<OriginDestinations>
						<OriginDestination>
							<Departure>
								<AirportCode>MAD</AirportCode>
								<Date>2024-11-15</Date>
							</Departure>
							<Arrival>
								<AirportCode>BIO</AirportCode>
							</Arrival>
						</OriginDestination>
					</OriginDestinations>
				</FlightQuery>
				<Passengers>
					<PassengerReferences>ADULT_02</PassengerReferences>
				</Passengers>
			</Add>
			<Delete>
				<OrderItem OrderItemID="IB7f6dc0a005474129b12c57947e7d0144OC_02"/>
			</Delete>
		</OrderServicing>
	</Reshop>
</Query>
Expand
titleOrderReshopRQ Public Fare UC04 example 2024
Code Block
languagexml
<Query>
	<OrderID>IB7f6dc0a005474129b12c57947e7d0144OC</OrderID>
	<Reshop>
		<OrderServicing>
			<Add>
				<Qualifier>
					<ExistingOrderQualifier>
						<OrderKeys>
							<OrderID Owner="IB">IB7f6dc0a005474129b12c57947e7d0144OC</OrderID>
							<AssociatedIDs>
								<AssociatedID>
									<OfferItemID Owner="IB">IBd96faaf0e7a847788900f5615af9c551OP_01</OfferItemID>
								</AssociatedID>
							</AssociatedIDs>
						</OrderKeys>
						<PassengerReferences>ADULT_02</PassengerReferences>
					</ExistingOrderQualifier>
				</Qualifier>
			</Add>
		</OrderServicing>
	</Reshop>
</Query>
Expand
titleOrderReshopRQ Upselling UC07 example 2024
Code Block
languagexml
<Query>
	<OrderID>IB1efddf008dde4414824bb611a260e75bOP</OrderID>
	<Reshop>
		<OrderServicing>
			<Delete>
				<OrderItem OrderItemID="IB1efddf008dde4414824bb611a260e75bOP_01"/>
			</Delete>
		</OrderServicing>
	</Reshop>
</Query>
Expand
titleOrderReshopRQ Reprice UC08 example 2024
Code Block
languagexml
<Query>
	<OrderID>IB0a88e0b496d7465286620feb1a282412OC</OrderID>
	<Reprice/>
</Query>
Expand
titleOrderReshopRQ IATA Delegation UC08 example 2024
Code Block
languagexml
The IATA to which it is delegated now will be 22222222 and the IATA with which we created the order is 11111111

<Sender>
	<TravelAgencySender>
		<Name>UAT's Agency Tests SA</Name>
		<Contacts>
			<Contact>
				<EmailContact>
					<Address>xxxxxx.xxxxx@xxxxx.es</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>
<Participants>
	<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>Martínez</Surname>
						<Given>Pepe</Given>
					</Name>
				</Contact>
			</Contacts>
			<IATA_Number>11111111</IATA_Number>
			<AgencyID>First Agency</AgencyID>
		</TravelAgencyParticipant>
	</Participant>
Expand
titleOrderReshopRQ Cancel Reprice UC08 example 2024
Code Block
languagexml
<Query>
	<OrderID>IB0a88e0b496d7465286620feb1a282412OC</OrderID>
	<Reshop>
		<OrderServicing>
			<Delete>
				<OrderItem OrderItemID="IB0a88e0b496d7465286620feb1a282412OC_01"/>
			</Delete>
		</OrderServicing>
	</Reshop>
</Query>
Expand
titleOrderReshopRQ Cancel IATA Delegation UC08 example 2024
Code Block
languagexml
<Sender>
	<TravelAgencySender>
		<Name>UA's Agency Tests SA</Name>
		<Contacts>
			<Contact>
				<EmailContact>
					<Address>xxxxxx.xxxxx@xxxxx.es</Address>
				</EmailContact>
				<PhoneContact>
					<Application>MOBILE</Application>
					<Number>+666666666</Number>
				</PhoneContact>
				<Name>
					<Surname>Perez</Surname>
					<Given>Pepe</Given>
				</Name>
			</Contact>
		</Contacts>
		<IATA_Number>11111111</IATA_Number>
		<AgencyID>First 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>Martínez</Surname>
					<Given>Pepe</Given>
				</Name>
			</Contact>
		</Contacts>
		<IATA_Number>22222222</IATA_Number>
		<AgencyID>Second Agency</AgencyID>
	</TravelAgencyParticipant>
</Participant>
Expand
titleOrderReshopRQ Market UC10 example 2024
Code Block
languagexml
<PointOfSale>
	<Location>
		<CountryCode>CL</CountryCode>
	</Location>
</PointOfSale>
Expand
titleOrderReshopRQ Availability, Partial Change UC12 example 2024
Code Block
languagexml
<Reshop>
	<OrderServicing>
		<Add>
			<FlightQuery>
				<OriginDestinations>
					<OriginDestination>
						<Departure>
							<AirportCode>GVA</AirportCode>
							<Date>2024-10-28</Date>
						</Departure>
						<Arrival>
							<AirportCode>EZE</AirportCode>
						</Arrival>
					</OriginDestination>
				</OriginDestinations>
			</FlightQuery>
			<Passengers>
				<PassengerReferences>ADULT_01</PassengerReferences>
			</Passengers>
		</Add>
		<Delete>
			<OrderItem OrderItemID="IB4491ac33c3fd4abebc7e5b13102666b4OC_01">
				<ServiceRetainRequestIDs>FLIGHT_IB685620241006_ADULT_01 FLIGHT_IB340220241007_ADULT_01</ServiceRetainRequestIDs>
			</OrderItem>
		</Delete>
	</OrderServicing>
</Reshop>
Expand
titleOrderReshopRQ Availability, OriginDestinationKey UC12 example 2024
Code Block
languagexml
<FlightsOverview>
	<FlightRef PriceClassRef="BASICSxQJrzyh9fV" ODRef="OD1">FL11</FlightRef>
	<FlightRef PriceClassRef="BASICSxQJrzyh9fV" ODRef="OD2">FL22</FlightRef>
</FlightsOverview>
<OriginDestinationList>
	<OriginDestination OriginDestinationKey="OD1">
		<DepartureCode>EZE</DepartureCode>
		<ArrivalCode>ORY</ArrivalCode>
		<FlightReferences>FL11</FlightReferences>
	</OriginDestination>
	<OriginDestination OriginDestinationKey="OD2">
		<DepartureCode>GVA</DepartureCode>
		<ArrivalCode>EZE</ArrivalCode>
		<FlightReferences>FL21 FL22 FL23 FL24</FlightReferences>
	</OriginDestination>
</OriginDestinationList>
Expand
titleOrderReshopRQ Availability, Multicurrency in AR market UC12 example 2024
Code Block
languagexml
<Metadata>
	<Other>
		<OtherMetadata>
			<CurrencyMetadatas>
				<CurrencyMetadata MetadataKey="USD">
					<Decimals>2</Decimals>
					<Name>Dólar (USA)</Name>
				</CurrencyMetadata>
			</CurrencyMetadatas>
		</OtherMetadata>
	</Other>
</Metadata>
Expand
titleOrderReshopRQ Fare, Partial Change UC12 example 2024
Code Block
languagexml
<Query>
	<OrderID>IB4491ac33c3fd4abebc7e5b13102666b4OC</OrderID>
	<Reshop>
		<OrderServicing>
			<Add>
				<Qualifier>
					<ExistingOrderQualifier>
						<OrderKeys>
							<OrderID Owner="IB">IB4491ac33c3fd4abebc7e5b13102666b4OC</OrderID>
							<AssociatedIDs>
								<AssociatedID>
									<OfferItemID Owner="IB">IB99cb4308799a4bcd96d7f5d90c963fa6OP_01</OfferItemID>
								</AssociatedID>
							</AssociatedIDs>
						</OrderKeys>
						<PassengerReferences>ADULT_01</PassengerReferences>
					</ExistingOrderQualifier>
				</Qualifier>
			</Add>
		</OrderServicing>
	</Reshop>
</Query>

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:

Errors

Image Added