Release 2024.04

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

New or modified element

To be removed/deprecated

Unique to v2 - Branded Fares

Unique to V1 - Fare Families

We provide two different methods to request the ServiceList:

Pre-Sale: Needs a previous AirShopping for returning an offer and a price breakdown.
Post-Sale: Needs a previously created and fully paid Order. Including extra data it will return the baggage catalogue for the ordered flight.

The various search parameters are described below:

Common Sections

HTTP Header

NAME	DESCRIPTION	FORMAT	ALLOWED/POSSIBLE VALUES
api_key	Your unique key used to authorize access to the API. update source	Alphanumeric	N/A

Language, Version and Name Space

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

Version

The IATA version of the message

Mandatory for Schema

Numeric

Any

All Services

PrimaryLangID

Two character ISO Language Code, for the agent’s preferred language.

This is used for error messages and some other data such as legal waivers.

2 Alphabetical

EN
ES

All Services

(except in the OrderChangeNotification)

xmlns

IATA official website

Mandatory for Schema

Alphanumeric

Any

All Services

Point of Sale

HEADER NAME	DESCRIPTION	FORMAT	ALLOWED/POSSIBLE VALUES	NDC SERVICES
<PointOfSale>
Location / CountryCode	The point of sale country code.	2 letter country code	List of countries	All request messages

Document

NAME	DESCRIPTION	FORMAT	ALLOWED/POSSIBLE VALUES	NDC SERVICES
<Document>
ReferenceVersion	The IATA Schema version.	Numeric	Any	All Services

Party

Participant Section

NAME	DESCRIPTION	FORMAT	ALLOWED/POSSIBLE VALUES	NDC SERVICES
<Party>
Participants / Participant / TravelAgencyParticipant / Name	Travel Agency Name. This is the Travel Agent who is registered with Iberia and British Airways as managing travel for the above Corporate. A validation check is run against our Sales database.	Alphanumeric	Any	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Type	Only when using IATA Delegation functionality. Mandatory for IATA Delegation when CorporateSender is used. This is used to indicate whether the TravelAgencyParticipant is the agency undertaking the Servicing or the agency that created or paid for the order. see example: Party Elements	Only as per allowed values	`"SERVICING_IATA"` or `"RESPONSIBLE_IATA"`	This element is returned in all services except: AirShopping OfferPrice OrderCreate OrderList
Participants / Participant / TravelAgencyParticipant / Contacts / Contact Attribute ContactType	Used to indicate to whom to send email confirmation emails and what information to include	Only as per allowed values	`"itin_only"` or `"itin_and_price"`	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / EmailContact / Address	Email to contact the Agency	Alphanumeric	Any	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Application	To indicate whether the Travel Agency phone is a fixed line or mobile.	Only as per allowed values	`"BUSINESS"` or `"MOBILE"`	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Number	Phone number to contact the Travel Agency	Numeric	Any	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Surname	The surname of the person to contact in the Travel Agency. Mandatory for schema if 'Name' tag is indicated.	Alphanumeric	Any	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Given	The given name of the person to contact in the Travel Agency	Alphanumeric	Any	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant Attribute SequenceNumber	Sequence number related to the Participants, irrespective of their type (TravelAgency, Aggregator, etc…), sent in the request. The order of the sequence number must follow the order in which the parties are connecting to our API. With the highest number being the party whose API key is being used to connect to us, and the lowest number (1) being the party in contact with the travelling passenger. See example 5 below.	Numeric		All messages when there are more than one Participant.
Participants / Participant / TravelAgencyParticipant / IATA_Number	The Travel Agency’s unique identifier: IATA number (if you have one) TIDs number (recommended if you do not have an IATA) If using the IATA Delegation functionality for Servicing orders: If no CorporateSender information is included in the message, then the Responsible IATA's number must be included here. If CorporateSender information is included in the message, then the Servicing IATA’s number and the Responsible IATA's number must both be included here with their SequenceNumber and their applicable Type. The Servicing IATA must have the lowest SequenceNumber and the Responsible IATA must be the next number in the sequence. In both cases. See examples below	7/8 Numeric	The identifier registered with Iberia.	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / AgencyID	Iberia do not presently use this field, although it is mandatory as per the schema.	Alphanumeric	Any	All Request messages.
Participants / Participant / AggregatorParticipant Attribute SequenceNumber	Sequence number related to the Participants irrespective of their type (TravelAgency, Aggregator, etc…), sent in the request. The order of the sequence number must follow the order in which the parties are connecting to our API. With the highest number being the party whose API key is being used to connect to us, and the lowest number (1) being the party in contact with the travelling passenger. See example 5 below.	Numeric		All Request messages.
Participants / Participant / AggregatorParticipant / AggregatorID	The unique identifier of the Aggregator. This can be any of the following: IATA number (if you have one) TIDs number (recommended if you do not have an IATA) Pseudo IATA(assigned by Iberia and British Airways)	7/8 Numeric	The identifier registered with Iberia.	This element is returned in all services except: OrderViewRS
Participants / Participant / AggregatorParticipant / Name	The name of the Aggregator as stored in our database associated to the AggregatorID. following:	Alphanumeric	The name registered with Iberia.	This element is ONLY used and returned in the: OrderChangeNotification

Participant Section

NAME	DESCRIPTION	FORMAT	ALLOWED/POSSIBLE VALUES	NDC SERVICES
<Party>
Participants / Participant / TravelAgencyParticipant / Name	Travel Agency Name. This is the Travel Agent who is registered with Iberia and British Airways as managing travel for the above Corporate. A validation check is run against our Sales database.	Alphanumeric	Any	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Type	Only when using IATA Delegation functionality. Mandatory for IATA Delegation when CorporateSender is used. This is used to indicate whether the TravelAgencyParticipant is the agency undertaking the Servicing or the agency that created or paid for the order. see example: Party Elements	Only as per allowed values	`"SERVICING_IATA"` or `"RESPONSIBLE_IATA"`	This element is returned in all services except: AirShopping OfferPrice OrderCreate OrderList
Participants / Participant / TravelAgencyParticipant / Contacts / Contact Attribute ContactType	Used to indicate to whom to send email confirmation emails and what information to include	Only as per allowed values	`"itin_only"` or `"itin_and_price"`	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / EmailContact / Address	Email to contact the Agency	Alphanumeric	Any	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Application	To indicate whether the Travel Agency phone is a fixed line or mobile.	Only as per allowed values	`"BUSINESS"` or `"MOBILE"`	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Number	Phone number to contact the Travel Agency	Numeric	Any	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Surname	The surname of the person to contact in the Travel Agency. Mandatory for schema if 'Name' tag is indicated.	Alphanumeric	Any	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Given	The given name of the person to contact in the Travel Agency	Alphanumeric	Any	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant Attribute SequenceNumber	Sequence number related to the Participants, irrespective of their type (TravelAgency, Aggregator, etc…), sent in the request. The order of the sequence number must follow the order in which the parties are connecting to our API. With the highest number being the party whose API key is being used to connect to us, and the lowest number (1) being the party in contact with the travelling passenger. See example 5 below.	Numeric		All messages when there are more than one Participant.
Participants / Participant / TravelAgencyParticipant / IATA_Number	The Travel Agency’s unique identifier: IATA number (if you have one) TIDs number (recommended if you do not have an IATA) If using the IATA Delegation functionality for Servicing orders: If no CorporateSender information is included in the message, then the Responsible IATA's number must be included here. If CorporateSender information is included in the message, then the Servicing IATA’s number and the Responsible IATA's number must both be included here with their SequenceNumber and their applicable Type. The Servicing IATA must have the lowest SequenceNumber and the Responsible IATA must be the next number in the sequence. In both cases. See examples below	7/8 Numeric	The identifier registered with Iberia.	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / AgencyID	Iberia do not presently use this field, although it is mandatory as per the schema.	Alphanumeric	Any	All Request messages.
Participants / Participant / AggregatorParticipant Attribute SequenceNumber	Sequence number related to the Participants irrespective of their type (TravelAgency, Aggregator, etc…), sent in the request. The order of the sequence number must follow the order in which the parties are connecting to our API. With the highest number being the party whose API key is being used to connect to us, and the lowest number (1) being the party in contact with the travelling passenger. See example 5 below.	Numeric		All Request messages.
Participants / Participant / AggregatorParticipant / AggregatorID	The unique identifier of the Aggregator. This can be any of the following: IATA number (if you have one) TIDs number (recommended if you do not have an IATA) Pseudo IATA(assigned by Iberia and British Airways)	7/8 Numeric	The identifier registered with Iberia.	This element is returned in all services except: OrderViewRS
Participants / Participant / AggregatorParticipant / Name	The name of the Aggregator as stored in our database associated to the AggregatorID. following:	Alphanumeric	The name registered with Iberia.	This element is ONLY used and returned in the: OrderChangeNotification

Participant Section

NAME	DESCRIPTION	FORMAT	ALLOWED/POSSIBLE VALUES	NDC SERVICES
<Party>
Participants / Participant / TravelAgencyParticipant / Name	Travel Agency Name. This is the Travel Agent who is registered with Iberia and British Airways as managing travel for the above Corporate. A validation check is run against our Sales database.	Alphanumeric	Any	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Type	Only when using IATA Delegation functionality. Mandatory for IATA Delegation when CorporateSender is used. This is used to indicate whether the TravelAgencyParticipant is the agency undertaking the Servicing or the agency that created or paid for the order. see example: Party Elements	Only as per allowed values	`"SERVICING_IATA"` or `"RESPONSIBLE_IATA"`	This element is returned in all services except: AirShopping OfferPrice OrderCreate OrderList
Participants / Participant / TravelAgencyParticipant / Contacts / Contact Attribute ContactType	Used to indicate to whom to send email confirmation emails and what information to include	Only as per allowed values	`"itin_only"` or `"itin_and_price"`	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / EmailContact / Address	Email to contact the Agency	Alphanumeric	Any	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Application	To indicate whether the Travel Agency phone is a fixed line or mobile.	Only as per allowed values	`"BUSINESS"` or `"MOBILE"`	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Number	Phone number to contact the Travel Agency	Numeric	Any	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Surname	The surname of the person to contact in the Travel Agency. Mandatory for schema if 'Name' tag is indicated.	Alphanumeric	Any	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Given	The given name of the person to contact in the Travel Agency	Alphanumeric	Any	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant Attribute SequenceNumber	Sequence number related to the Participants, irrespective of their type (TravelAgency, Aggregator, etc…), sent in the request. The order of the sequence number must follow the order in which the parties are connecting to our API. With the highest number being the party whose API key is being used to connect to us, and the lowest number (1) being the party in contact with the travelling passenger. See example 5 below.	Numeric		All messages when there are more than one Participant.
Participants / Participant / TravelAgencyParticipant / IATA_Number	The Travel Agency’s unique identifier: IATA number (if you have one) TIDs number (recommended if you do not have an IATA) If using the IATA Delegation functionality for Servicing orders: If no CorporateSender information is included in the message, then the Responsible IATA's number must be included here. If CorporateSender information is included in the message, then the Servicing IATA’s number and the Responsible IATA's number must both be included here with their SequenceNumber and their applicable Type. The Servicing IATA must have the lowest SequenceNumber and the Responsible IATA must be the next number in the sequence. In both cases. See examples below	7/8 Numeric	The identifier registered with Iberia.	All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
Participants / Participant / TravelAgencyParticipant / AgencyID	Iberia do not presently use this field, although it is mandatory as per the schema.	Alphanumeric	Any	All Request messages.
Participants / Participant / AggregatorParticipant Attribute SequenceNumber	Sequence number related to the Participants irrespective of their type (TravelAgency, Aggregator, etc…), sent in the request. The order of the sequence number must follow the order in which the parties are connecting to our API. With the highest number being the party whose API key is being used to connect to us, and the lowest number (1) being the party in contact with the travelling passenger. See example 5 below.	Numeric		All Request messages.
Participants / Participant / AggregatorParticipant / AggregatorID	The unique identifier of the Aggregator. This can be any of the following: IATA number (if you have one) TIDs number (recommended if you do not have an IATA) Pseudo IATA(assigned by Iberia and British Airways)	7/8 Numeric	The identifier registered with Iberia.	This element is returned in all services except: OrderViewRS
Participants / Participant / AggregatorParticipant / Name	The name of the Aggregator as stored in our database associated to the AggregatorID. following:	Alphanumeric	The name registered with Iberia.	This element is ONLY used and returned in the: OrderChangeNotification

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

Parameters Pre-Sale

NAME
DESCRIPTION
FORMAT
ALLOWED/POSSIBLE VALUES
<Parameters> Only Pre-sale flow
ServiceFilters / ServiceFilter / GroupCode
Filter to specify certain types of ancillary offers.
If it is omitted, only bags of 23kgs will be returned (maintaining backward compatibility).
Alphabetical
BG (Baggage)*
TS (Travel Services - must be used with SubGroupCode)
_{*If it is omitted, only bags of 23kgs will be returned (maintaining backward compatibility).}
ServiceFilters / ServiceFilter / SubGroupCode
Additional secondary filter to be used in conjunction with GroupCode when necessary.
Alphabetical
PR (Priority Boarding)

ShoppingResponseID

NAME
DESCRIPTION
FORMAT
ALLOWED/POSSIBLE VALUES
<ShoppingResponseID> Pre-sale
ResponseID
ResponseID of OfferPrice service
Alphanumeric
Any

Query

Query Pre-Sale & Post-Sale

Query Post-Sale

NAME	DESCRIPTION	FORMAT	ALLOWED/POSSIBLE VALUES
<Query> Post-sale
OrderID	Order ID with mandatory attribute Owner	Alphanumeric	The order id of an existing order which has been created, paid and ticketed
Offer / OrderID Attribute Owner	Airline code	Alphabetical	Any

Query Pre-Sale

NAME	DESCRIPTION	FORMAT	ALLOWED/POSSIBLE VALUES
<Query / Offers> Pre-sale
Offer / OfferID	ID for the Offer	Alphanumeric	Any
Offer / OfferID Attribute Owner	Airline code	Alphabetical	Any
Offer / OfferItemIDs / OfferItemID	ID for the Offer item	Alphanumeric	Any
Offer / OfferItemIDs / OfferItemID Attribute Owner	Airline code	Alphabetical	Any

Qualifier

NAME
DESCRIPTION
FORMAT
ALLOWED/POSSIBLE VALUES
<Qualifier>
SpecialNeedQualifiers / Code
Special Needs code.
DISA can be used to obtain all services at the same time.
Alphabetical
BLND (Blind Passenger)
DEAF (Deaf Passenger)
WCHR (Wheelchair for ramp)
WCHS (Wheelchair for steps)
DPNA (Disabled Passenger)
DISA (All services)

Metadata / Currency

Currency / Metadata

NAME
DESCRIPTION
FORMAT
ALLOWED/POSSIBLE VALUES
NDC SERVICES
<Metadata / Other / OtherMetadata / CurrencyMetadatas>
CurrencyMetadata

Attribute
MetadataKey
ID of the Metadata using the currency code
Alphanumeric
Any available currency for the defined market
All Services
CurrencyMetadata / Decimals
Number of decimals for the currency
Numeric
Any
All Services
CurrencyMetadata / Name
The name of the currency
Alphabetical
Any
All Services

Example ServiceListRQ:

Example

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Header/>
   <soap:Body>
      <ServiceListRQ xmlns:tag0="http://www.iata.org/IATA/EDIST/2017.2" Version="5.000"
                          PrimaryLangID="es">
         <PointOfSale>
            <Location>
               <CountryCode>ES</CountryCode>
            </Location>
         </PointOfSale>
         <Document>
            <ReferenceVersion>5.000</ReferenceVersion>
         </Document>
         <Party>
            <Sender>
               <TravelAgencySender>
                  <Name>AgencyName</Name>
                  <Contacts>
                     <Contact>
                        <EmailContact>
                           <Address>agency@agencyemail.com</Address>
                        </EmailContact>
                        <PhoneContact>
                           <Application>MOBILE</Application>
                           <Number>+34666666666</Number>
                        </PhoneContact>
                        <Name>
                           <Surname>Perez</Surname>
                           <Given>Pepe</Given>
                        </Name>
                     </Contact>
                  </Contacts>
                  <IATA_Number>11112220</IATA_Number>
                  <AgencyID>First Agency</AgencyID>
               </TravelAgencySender>
            </Sender>
            <Participants>
               <Participant>
                  <AggregatorParticipant SequenceNumber="1">
                     <AggregatorID>00000022</AggregatorID>
                  </AggregatorParticipant>
               </Participant>
            </Participants>
         </Party>
         <Parameters>
            <ServiceFilters>
               <ServiceFilter>
                  <GroupCode>BG</GroupCode>
               </ServiceFilter>
               <ServiceFilter>
                  <GroupCode>BG</GroupCode>
                  <SubGroupCode>SP</SubGroupCode>
               </ServiceFilter>
            </ServiceFilters>
         </Parameters>
         <ShoppingResponseID>
            <ResponseID>Qm9va2luZ0BHVy0xNzAxMjU0Nzk1MjcwLXFJU2R4</ResponseID>
         </ShoppingResponseID>
         <Query>
            <Offers>
               <Offer>
                  <OfferID Owner="IB">IB5ca2c0a1f5da4dad9f422cfabe6504c5OC</OfferID>
                  <OfferItemIDs>
                     <OfferItemID Owner="IB">IB5ca2c0a1f5da4dad9f422cfabe6504c5OC_01  </OfferItemID>
                  </OfferItemIDs>
               </Offer>
            </Offers>
         </Query>
      </ServiceListRQ>
   </soap:Body>
</soap:Envelope>

Error messages

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

Errors

Release 2024.04

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

[data-colorid=w73tbikded]{color:#ff5630} html[data-color-mode=dark] [data-colorid=w73tbikded]{color:#cf2600}[data-colorid=n6205wpp9u]{color:#bf2600} html[data-color-mode=dark] [data-colorid=n6205wpp9u]{color:#ff6640}Participant Section

[data-colorid=uc8bzuoytx]{color:#ff5630} html[data-color-mode=dark] [data-colorid=uc8bzuoytx]{color:#cf2600}[data-colorid=tw4emdq2iy]{color:#bf2600} html[data-color-mode=dark] [data-colorid=tw4emdq2iy]{color:#ff6640}Participant Section

[data-colorid=ovm2xe74he]{color:#bf2600} html[data-color-mode=dark] [data-colorid=ovm2xe74he]{color:#ff6640}[data-colorid=f3vu7qtte0]{color:#ff5630} html[data-color-mode=dark] [data-colorid=f3vu7qtte0]{color:#cf2600}Participant Section

NAMEDESCRIPTIONFORMATALLOWED/POSSIBLE VALUES<ShoppingResponseID> Pre-saleResponseIDResponseID of OfferPrice serviceAlphanumericAny

Query Post-Sale

Attribute

Query Pre-Sale

Attribute

Attribute

Attribute

Example ServiceListRQ:

Error messages

Participant Section

Participant Section

Participant Section

NAME
DESCRIPTION
FORMAT
ALLOWED/POSSIBLE VALUES
<ShoppingResponseID> Pre-sale
ResponseID
ResponseID of OfferPrice service
Alphanumeric
Any