Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Current »

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'NDC2:Version 17.2 COMBINED (v1 and v2)'.

Common Sections

 HTTP Header

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

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

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

Document

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<Document>

ReferenceVersion

The IATA Schema version.

Numeric

Any

 All Services

 Party

Party

Sender Section

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<Party>

Sender / TravelAgencySender / Name

Agency Name

Iberia will always use the Name stored in our system when the Seller/Sender registered to use our NDC.

Alphanumeric

Any

All Request messages and OrderViewRS

Sender / TravelAgencySender / Contacts / Contact

Attribute

ContactType

Used to indicate to whom to send email confirmation emails and what information to include.

More information can be found here

Only as per allowed values

"itin_only"

or

"itin_and_price"

All Request messages and OrderViewRS

Sender / TravelAgencySender / Contacts / Contact / EmailContact / Address

Email to contact the Travel Agency

Mandatory for schema if 'EmailContact' tag is indicated.

Alphanumeric

Any

All Request messages and OrderViewRS

Sender / TravelAgencySender / 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 OrderViewRS

Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Number

Attribute

CountryCode

Phone number to contact the Travel Agency, with CountryCode.

<Number CountryCode="+34">666666666</Number>

Numeric

Any valid telephone number with Country code.

All Request messages and OrderViewRS

Sender / TravelAgencySender / 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 OrderViewRS

Sender / TravelAgencySender / Contacts / Contact / Name / Given

The given name of the person to contact in the Travel Agency

Alphanumeric

Any

All Request messages and OrderViewRS

Sender / TravelAgencySender / IATA_Number

Sender IATA identifier:

IATA number (used by IATA accredited Travel Agents)

TIDs number  (recommended if you are not an IATA Accredited agent)

If using the IATA Delegation functionality for Servicing orders, and no CorporateSender information is included in the message, then the Servicing IATA's number is included here.

Numeric

7/8 Numbers

All Request messages and OrderViewRS

Sender / TravelAgencySender / OtherIDs / OtherID

Pseudo IATA (assigned by Iberia)

NDC Mandatory

Numeric

7/8 Numbers

All Request messages and OrderViewRS

Sender / TravelAgencySender / AgencyID

Presently, Iberia does not make use of this field.

Mandatory for Schema.

Alphanumeric

Any

All Request messages and OrderViewRS

Sender / CorporateSender / ID

ID for the Corporate. These are issued by Iberia and British Airways, and are sometimes referred to as a “JBID”.

Not applicable to OrderList.

NDC Mandatory

Alphanumeric

Identifier assigned by Iberia.

All Request messages and OrderViewRS

Sender / ORA_Sender / AirlineID

Code of the Offer/Order Responsible Airline sending the message. Used in the OCN message.

Two Alphabetical Letters

IB

OrderChangeNotif

Sender / ORA_Sender / Name

Name of the Offer/Order Responsible Airline sending the message. Used in the OCN message.

Alphabetical

Iberia

OrderChangeNotif

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:

Query

 Query - OrderRetrieve

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<Query / Filters> Order by OrderID

OrderID

Attribute

Owner

 

Order owner

Alphanumeric

IB

OrderID

Order identification

Alphanumeric

Any

<Query / Filters> Order by Locator and Surname

Passengers / Individual / Surname

Passenger's surname

  • (Agency can specify separated by a special character "@" first and second surname → Ex: De la Morena@López)

Alphanumeric

Any

BookingReferences / BookingReference / ID

Order's locator

Alphanumeric

Any

BookingReferences / BookingReference / AirlineID

Airline ID

2 Alphanumeric

IB

Example OrderRetrieveRQ:

 OrderRetrieveRQ example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.iata.org/IATA/EDIST/2017.2">
   <soapenv:Header/>
   <soapenv:Body>
      <OrderRetrieveRQ 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>########</IATA_Number>
                  <AgencyID>Travel Agency</AgencyID>
               </TravelAgencySender>
            </Sender>
         </Party>
         <Query>
            <Filters>
               <Passengers>
                  <Individual>
                     <Surname>Del Casar@Pérez de Hoz</Surname>
                  </Individual>
               </Passengers>
               <BookingReferences>
                  <BookingReference>
                     <ID>NFH2G</ID>
                     <AirlineID>IB</AirlineID>
                  </BookingReference>
               </BookingReferences>
            </Filters>
         </Query>
      </OrderRetrieveRQ>
   </soapenv:Body>
</soapenv:Envelope>

Examples OrderRetrieveRQ 2024:

 OrderRetrieveRQ Market Peru UC04 example 2024
<Location>
	<CountryCode>PE</CountryCode>
</Location>
 OrderRetrieveRQ Reprice UC08 example 2024
<Query>
	<Filters>
		<OrderID Owner="IB">IB0a88e0b496d7465286620feb1a282412OC</OrderID>
	</Filters>
</Query>
 OrderRetrieveRQ IATA Delegation UC08 example 2024
<Sender>
	<TravelAgencySender>
		<Name>AgencyName</Name>
		<Contacts>
			<Contact>
				<EmailContact>
					<Address>agency@agencyemail.com</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>
 OrderRetrieveRQ Contact Agent UC09 example 2024
<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>
 OrderRetrieveRQ Market UC10 example 2024
<PointOfSale>
	<Location>
		<CountryCode>CL</CountryCode>
	</Location>
</PointOfSale>

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:

Errors

  • No labels