Versions Compared

Key

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

...

Release 2023.16

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

This service is used to request priced availability for flights for the requested origin and destination, date and cabin. The service also returns priced availability for the next higher cabins (normally the next 2 higher cabins). Example, if the availability is requested for Economy, service will return priced availability for Economy, Premium Economy and Business (assuming these cabins are offered on the route requested).

...

The AirShoppingRQ message is made up of the following sections:

Insert excerpt
API Messages with Examples
API Messages with Examples
nameLegend
nopaneltrue

Common Sections

Expand
titleCommon SectionsHTTP 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
namePointOfSale
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 excerptNDC2:Party ElementsNDC2:Party ElementsnameRecipientSectionnopaneltrue

Shopping Preferences

Insert excerptNDC2:Shopping PreferencesNDC2:Shopping PreferencesnameShoppingPreferencesnopaneltrue

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

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

Parameters

Expand
titleParameters

Insert excerpt
Parameters - OverrideCurrency
Parameters - OverrideCurrency
nameOverrideCurrency
nopaneltrue

CoreQuery

This is the principal part of the AirShoppingRQ, whose main elements are the Origin (Departure) and Destination(Arrival) Cities/Airports and departure date.

Expand
titleCoreQuery

Insert excerpt
Core Query
Core Query
nameCoreQuery
nopaneltrue

DataLists - PassengerList

...

Preference

Can, optionally, indicate flight, fare and cabin preferences.

Expand
title
PassengerListNDC2:PassengerList
Preference

Insert excerpt

NDC2:PassengerList

Preference
Preference
name

PassengerList

ShoppingPreferences
nopaneltrue

...

DataLists / PassengerList

This is where you specify the number of passengers and their type

Expand
title
MetadataNDC2:Metadata
PassengerList

Insert excerpt

NDC2:Metadata

PassengerList
PassengerList
name

CurrencyMetadata

PassengerList
nopaneltrue

Example AirShoppingRQ:

Expand
titleXML SampleAirShoppingRQ example
Code Block
languagexml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <AirShoppingRQ 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>
               <CorporateSender>
                  <ID>XXXXXXXX</ID>
               </CorporateSender>
            </Sender>
            <Participants>
               <Participant>
                  <TravelAgencyParticipant SequenceNumber="1">
                     <Name>NDC Agency Name</Name>
                     <Contacts>
                        <Contact>
                           <EmailContact>
                              <Address>email@email.com</Address>
                           </EmailContact>
                           <PhoneContact>
                              <Application>BUSINESS</Application>
                              <Number>#########</Number>
                           </PhoneContact>
                           <Name>
                              <Surname>MartÌnez<<Surname>Martinez</Surname>
                              <Given>Pepe</Given>
                           </Name>
                        </Contact>
                     </Contacts>
                     <IATA_Number>XXXXXXXX</IATA_Number>
                     <AgencyID>XXXXXXXX</AgencyID>
                  </TravelAgencyParticipant>
               </Participant>
            </Participants>
         </Party>
         <CoreQuery>
            <OriginDestinations>
               <OriginDestination OriginDestinationKey="IDA">
                  <Departure>
                     <AirportCode>MAD</AirportCode>
                     <Date>2022-04-25</Date>
                  </Departure>
                  <Arrival>
                     <AirportCode>PAR</AirportCode>
                  </Arrival>
               </OriginDestination>
               <OriginDestination OriginDestinationKey="VUELTA">
                  <Departure>
                     <AirportCode>PAR</AirportCode>
                     <Date>2022-04-30</Date>
                  </Departure>
                  <Arrival>
                     <AirportCode>MAD</AirportCode>
                  </Arrival>
               </OriginDestination>
            </OriginDestinations>
         </CoreQuery>
         <Preference>
            <FlightPreferences>
               <Characteristic>
                  <DirectPreferences>0</DirectPreferences>
               </Characteristic>
            </FlightPreferences>
            <PricingMethodPreference>
               <BestPricingOption>C</BestPricingOption>
            </PricingMethodPreference>
         </Preference>
         <DataLists>
            <PassengerList>
               <Passenger PassengerID="Pasajero1">
                  <PTC>ADT</PTC>
               </Passenger>
               <Passenger PassengerID="Pasajero2">
                  <PTC>ADT</PTC>
               </Passenger>
               <Passenger PassengerID="Pasajero3">
                  <PTC>ADT</PTC>
               </Passenger>
            </PassengerList>
         </DataLists>
      </AirShoppingRQ>
  <Metadata> </soapenv:Body>
</soapenv:Envelope>

Examples AirShoppingRQ 2024:

Expand
titleAirShoppingRQ OpenJaw UC01 example 2024
Code Block
languagexml
<CoreQuery>
	<OriginDestinations>
		<OriginDestination>
			<Departure>
				<AirportCode>MAD</AirportCode>
				<Date>2024-08-19</Date>
			</Departure>
			<Arrival>
				<AirportCode>LIS</AirportCode>
			</Arrival>
 <Other>
               <OtherMetadata>
                  <CurrencyMetadatas>
                     <CurrencyMetadata MetadataKey="EUR"/>
                  </CurrencyMetadatas>
               </OtherMetadata>
            </Other>
         </Metadata>
      </AirShoppingRQ>
   </soapenv:Body>
</soapenv:Envelope>		</OriginDestination>
		<OriginDestination>
			<Departure>
				<AirportCode>OPO</AirportCode>
				<Date>2024-09-01</Date>
			</Departure>
			<Arrival>
				<AirportCode>MAD</AirportCode>
			</Arrival>
		</OriginDestination>
	</OriginDestinations>
</CoreQuery>
Expand
titleAirShoppingRQ Private Fare Sport UC03 example 2024
Code Block
languagexml
<Preference>
	<FarePreferences>
		<Types>
			<Type PreferencesContext="SPORT">758</Type>
		</Types>
	</FarePreferences>
</Preference>
Expand
titleAirShoppingRQ Public Fare UC04 example 2024
Code Block
languagexml
<CoreQuery>
	<OriginDestinations>
		<OriginDestination>
			<Departure>
				<AirportCode>MAD</AirportCode>
				<Date>2024-11-13</Date>
			</Departure>
			<Arrival>
				<AirportCode>BIO</AirportCode>
			</Arrival>
		</OriginDestination>
	</OriginDestinations>
</CoreQuery>
Expand
titleAirShoppingRQ Cheapest Type Y UC05 example 2024
Code Block
languagexml
<Preference>
	<PricingMethodPreference>
		<BestPricingOption>Y</BestPricingOption>
	</PricingMethodPreference>
	<CabinPreferences>
		<CabinType>
			<Code>2</Code>
		</CabinType>
	</CabinPreferences>
</Preference>
Expand
titleAirShoppingRQ Resident UC05 example 2024
Code Block
languagexml
<CoreQuery>
	<OriginDestinations>
		<OriginDestination>
			<Departure>
				<AirportCode>MAD</AirportCode>
				<Date>2025-01-25</Date>
			</Departure>
			<Arrival>
				<AirportCode>LPA</AirportCode>
			</Arrival>
		</OriginDestination>
	</OriginDestinations>
</CoreQuery>
<Preference>
	<FarePreferences>
		<TicketDesigs>
			<TicketDesig>RC</TicketDesig>
		</TicketDesigs>
	</FarePreferences>
</Preference>
Expand
titleAirShoppingRQ Public & Corporate Fare Combination UC06 example 2024
Code Block
languagexml
<Sender>
	<CorporateSender>
		<ID>IXXXXXXS</ID>
	</CorporateSender>
</Sender>
Expand
titleAirShoppingRQ Cheapest C UC06 example 2024
Code Block
languagexml
<Preference>
	<PricingMethodPreference>
		<BestPricingOption>C</BestPricingOption>
	</PricingMethodPreference>
</Preference>
Expand
titleAirShoppingRQ Large Family UC06 example 2024
Code Block
languagexml
<FarePreferences>
	<TicketDesigs>
		<TicketDesig>F2</TicketDesig>
	</TicketDesigs>
</FarePreferences>
Expand
titleAirShoppingRQ Max Stops UC09 example 2024
Code Block
languagexml
<Preference>
	<FlightPreferences>
		<Characteristic>
			<DirectPreferences>4</DirectPreferences>
		</Characteristic>
	</FlightPreferences>
</Preference>
<CoreQuery>
	<OriginDestinations>
		<OriginDestination>
			<Departure>
				<AirportCode>BIO</AirportCode>
				<Date>2024-07-31</Date>
			</Departure>
			<Arrival>
				<AirportCode>MIA</AirportCode>
			</Arrival>
		</OriginDestination>
	</OriginDestinations>
</CoreQuery>
Expand
titleAirShoppingRQ Market UC10 example 2024
Code Block
languagexml
<PointOfSale>
	<Location>
		<CountryCode>CL</CountryCode>
	</Location>
</PointOfSale>
Expand
titleAirShoppingRQ Private Fare Sport UC11 example 2024
Code Block
languagexml
<Preference>
	<FarePreferences>
		<Types>
			<Type PreferencesContext="SPORT">758</Type>
		</Types>
	</FarePreferences>
</Preference>
Expand
titleAirShoppingRQ OriginDestinationKey UC12 example 2024
Code Block
languagexml
<CoreQuery>
	<OriginDestinations>
		<OriginDestination OriginDestinationKey="OD1">
			<Departure>
				<AirportCode>BUE</AirportCode>
				<Date>2024-10-06</Date>
			</Departure>
			<Arrival>
				<AirportCode>PAR</AirportCode>
			</Arrival>
		</OriginDestination>
		<OriginDestination OriginDestinationKey="OD2">
			<Departure>
				<AirportCode>GVA</AirportCode>
				<Date>2024-10-23</Date>
			</Departure>
			<Arrival>
				<AirportCode>BUE</AirportCode>
			</Arrival>
		</OriginDestination>
	</OriginDestinations>
</CoreQuery>
Expand
titleAirShoppingRQ Multicurrency in AR Market UC12 example 2024
Code Block
languagexml
<Parameters>
	<Pricing>
		<OverrideCurrency>USD</OverrideCurrency>
	</Pricing>
</Parameters>

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

...