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 5 Next »

Introduction

The Party section of the messages can vary depending on the following scenarios:

  1. The Seller/Sender (Travel Agent) is connected directly to Iberia’s NDC API

  2. The Seller/Sender is using an Aggregator who is connected to Iberia’s NDC API

  3. There is a Corporate involved which can occur in both scenarios one and two

  4. The IATA Delegation functionality is being used, which can only be done with scenarios two and three

In the case whereby the Seller is connected directly to Iberia the last element with the AggregatorID is simply omitted from the message.

If one or more Aggregators are involved they are simply included in the Participant section.

When a Corporate is involved, and is identified as the Sender, then the Travel Agency becomes a participant, with or without an Aggregator participant depending on whether an Aggregator is involved.

Section Elements

 New or modified element

To be removed/deprecated

Unique to v2 - Branded Fares

Unique to V1 - Fare Families

Sender Section

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

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

Sender / TravelAgencySender / Contacts

Attribute

Contact@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

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

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

Sender / TravelAgencySender / Contacts / Contact / PhoneContact

Attribute

Number@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

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

Sender / TravelAgencySender / Contacts / Contact / Name / Given

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

Alphanumeric

Any

All Request messages

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

Sender / TravelAgencySender / OtherIDs / OtherID

Pseudo IATA (assigned by Iberia)

NDC Mandatory

Numeric

7/8 Numbers

All Request messages

Sender / TravelAgencySender / AgencyID

Presently, Iberia does not make use of this field.

Mandatory for Schema.

Alphanumeric

Any

All Request messages

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

Sender / ORA_Sender / AirlineID

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

Two Alphabetical Letters

IB

All Request messages

Sender / ORA_Sender / Name

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

Alphabetical

Iberia

All Request messages

Participant Section

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

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

Attribute

Contact@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

Attribute

TravelAgencyParticipant@SequenceNumber

AggregatorParticipant@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

 Participants / Participant

Attribute

AggregatorParticipant@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

This element is returned in all services except:

OrderViewRS

 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

Recipient Section - (only for OCN message)

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

Recipient / TravelAgencyRecipient / IATA_Number

Used in the OCN message to identify the IATA of the TravelAgency/Seller to whom this message is being directed.

7/8 Numeric

N/A

OrderChangeNotification

Recipient / TravelAgencyRecipient / AgencyID

Used in the OCN message to include the name, as per our database, of TravelAgency/Seller to whom this message is being directed.

Alphanumeric

N/A

OrderChangeNotification

Examples:

1. TravelAgencySender with no Aggregator (Direct Connect):

 Example Sender with no Aggregator (Direct Connect)
<Party>
	<Sender>
		<TravelAgencySender>
			<Name>TEST TRAVEL AGENCY</Name>
			<Contacts>
				<Contact>
					<EmailContact>
						<Address>agencia@prueba.com</Address>
					</EmailContact>
					<PhoneContact>
						<Application>MOBILE</Application>
						<Number>+34#########</Number>
					</PhoneContact>
					<Name>
						<Surname>Perez-Nieto</Surname>
						<Given>Pepe</Given>
					</Name>
				</Contact>
			</Contacts>
			<IATA_Number>########</IATA_Number>
			<AgencyID>TESTTRAVELAGENCY</AgencyID>
		</TravelAgencySender>
	</Sender>
</Party>

2. TravelAgencySender with one or more Aggregators:

 Example TraveAgencySender and Aggregator Participant:
<Party>
    <Sender>
        <TravelAgencySender>
			<Name>TEST TRAVEL AGENCY</Name>
			<Contacts>
				<Contact>
					<EmailContact>
						<Address>agencia@prueba.com</Address>
					</EmailContact>
					<PhoneContact>
						<Application>MOBILE</Application>
						<Number>+34#########</Number>
					</PhoneContact>
					<Name>
						<Surname>Perez-Nieto</Surname>
						<Given>Pepe</Given>
					</Name>
				</Contact>
			</Contacts>
			<IATA_Number>########</IATA_Number>
			<AgencyID>TESTTRAVELAGENCY</AgencyID>
		</TravelAgencySender>
	</Sender>
	<Participants>
		<Participant>
			<AggregatorParticipant SequenceNumber="1">
				<AggregatorID>########</AggregatorID>
			</AggregatorParticipant>
		</Participant>
	</Participants>
</Party>

 Example TravelAgencySender and two Aggregator Participants
<Party>
	<Sender>
        <TravelAgencySender>
			<Name>TEST TRAVEL AGENCY</Name>
			<Contacts>
				<Contact>
					<EmailContact>
						<Address>agencia@prueba.com</Address>
					</EmailContact>
					<PhoneContact>
						<Application>MOBILE</Application>
						<Number>+34#########</Number>
					</PhoneContact>
					<Name>
						<Surname>Perez-Nieto</Surname>
						<Given>Pepe</Given>
					</Name>
				</Contact>
			</Contacts>
			<IATA_Number>########</IATA_Number>
			<AgencyID>TESTTRAVELAGENCY</AgencyID>
		</TravelAgencySender>
	</Sender>
	<Participants>
		<Participant>
			<AggregatorParticipant SequenceNumber="1">
				<AggregatorID>########</AggregatorID>
			</AggregatorParticipant>
		</Participant>
		<Participant>
			<AggregatorParticipant SequenceNumber="2">
				<AggregatorID>########</AggregatorID>
			</AggregatorParticipant>
		</Participant>
	</Participants>
</Party>

3. CorporateSender with TravelAgencyParticipant:

 Example Corporate with TravelAgencyParticipant:
<Party>
	<Sender>
		<CorporateSender>
			<ID>XXXXXXXX</ID>
		</CorporateSender>
	</Sender>
	<Participants>
		<Participant>
			<TravelAgencyParticipant SequenceNumber="1">
				<Name>AgencyName</Name>
				<Contacts>
					<Contact>
						<EmailContact>
							<Address>AgencyMail@xxx.com</Address>
						</EmailContact>
						<PhoneContact>
							<Application>BUSINESS</Application>
							<Number>+34#########</Number>
						</PhoneContact>
						<Name>
							<Surname>MartÌnez</Surname>
							<Given>Pepe</Given>
						</Name>
					</Contact>
				</Contacts>
				<IATA_Number>########</IATA_Number>
				<AgencyID>TravelAgent</AgencyID>
			</TravelAgencyParticipant>
		</Participant>
	</Participants>
</Party>

4. CorporateSender with just TravelAgencyParticipant:

 Example Corporate with TravelAgencyParticipant:
<Party>
		<Sender>
		<CorporateSender>
			<ID>XXXXXXXX</ID>
		</CorporateSender>
	</Sender>
	<Participants>
		<Participant>
		<TravelAgencyParticipant SequenceNumber="1">
				<Name>AgencyName</Name>
				<Contacts>
					<Contact>
						<EmailContact>
							<Address>AgencyMail@xxx.com</Address>
						</EmailContact>
						<PhoneContact>
							<Application>BUSINESS</Application>
							<Number>+34#########</Number>
						</PhoneContact>
						<Name>
							<Surname>MartÌnez</Surname>
							<Given>Pepe</Given>
						</Name>
					</Contact>
				</Contacts>
				<IATA_Number>########</IATA_Number>
				<AgencyID>TravelAgent</AgencyID>
			</TravelAgencyParticipant>
			</Participant>
	</Participants>
</Party>

5. CorporateSender with TravelAgencyParticipant and Aggregator Participant:

 Example Corporate with TraveAgencyParticipant and Aggregator Participant:
<Party>
	<Sender>
		<CorporateSender>
			<ID>XXXXXXXX</ID>
		</CorporateSender>
	</Sender>
	<Participants>
		<Participant>
			<TravelAgencyParticipant SequenceNumber="1">
				<Name>AgencyName</Name>
				<Contacts>
					<Contact>
						<EmailContact>
							<Address>AgencyMail@xxx.com</Address>
						</EmailContact>
						<PhoneContact>
							<Application>BUSINESS</Application>
							<Number>+34#########</Number>
						</PhoneContact>
						<Name>
							<Surname>Martínez</Surname>
							<Given>Pepe</Given>
						</Name>
					</Contact>
				</Contacts>
				<IATA_Number>########</IATA_Number>
				<AgencyID>firstAgency</AgencyID>
			</TravelAgencyParticipant>
		</Participant>
		<Participant>
			<AggregatorParticipant SequenceNumber="2">
				<AggregatorID>########</AggregatorID>
			</AggregatorParticipant>
		</Participant>
	</Participants>
</Party>

6. When using IATA Delegation

6.1. Example TravelAgencySender with Aggregator Participant:

 Example TravelAgencySender with AggregatorParticipant using IATA Delegation
<Party>
	<Sender>
<TravelAgencySender>
			<Name>TEST TRAVEL AGENCY</Name>
			<Contacts>
				<Contact>
					<EmailContact>
						<Address>agencia@prueba.com</Address>
					</EmailContact>
					<PhoneContact>
						<Application>MOBILE</Application>
						<Number>+34#########</Number>
					</PhoneContact>
					<Name>
						<Surname>Perez-Nieto</Surname>
						<Given>Pepe</Given>
					</Name>
				</Contact>
			</Contacts>
			<IATA_Number>########</IATA_Number>
			<AgencyID>TESTTRAVELAGENCY</AgencyID>
		</TravelAgencySender>
	</Sender>
	<Participants>
		<Participant>
			<TravelAgencyParticipant SequenceNumber="2">
				<IATA_Number>78298065</IATA_Number>
				<AgencyID>Barceló</AgencyID>
			</TravelAgencyParticipant>
		</Participant>
		<Participant>
			<AggregatorParticipant SequenceNumber="3">
				<AggregatorID>00010113</AggregatorID>
			</AggregatorParticipant>
		</Participant>
	</Participants>
</Party>

REMEMBER - - When using IATA Delegation, the Sender is always the Servicing IATA and the TravelAgencyParticipant is always the Responsible IATA. Therefore, no Type element is necessary to identify the role each is playing.

6.2. Example CorporateSender with TravelAgencyParticipant and AggregatorParticipant:

 Example Corporate with TraveAgencyParticipants and Aggregator Participant:
<Party>
	<Sender>
		<CorporateSender>
			<ID>IN3401ES</ID>
		</CorporateSender>
	</Sender>
	<Participants>
		<Participant>
			<TravelAgencyParticipant SequenceNumber="1">
				<Type>SERVICING_IATA</Type>
				<IATA_Number>11112220</IATA_Number>
				<AgencyID>AGENCY_B</AgencyID>
			</TravelAgencyParticipant>
		</Participant>
		<Participant>
			<TravelAgencyParticipant SequenceNumber="2">
				<Type>RESPONSIBLE_IATA</Type>
				<IATA_Number>78298065</IATA_Number>
				<AgencyID>Barceló</AgencyID>
			</TravelAgencyParticipant>
		</Participant>
		<Participant>
			<AggregatorParticipant SequenceNumber="3">
				<AggregatorID>00010113</AggregatorID>
			</AggregatorParticipant>
		</Participant>
	</Participants>
</Party>

REMEMBER - - When CorporateSender is included in the Party section of the message, the Type element must be included for each of the TravelAgencyParticipants to indicate the role each of them is playing in the delegation process.

New NDC Footer.png

  • No labels