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

Legend

(plus) New or modify field   (minus) To be removed/deprecated

HTTP Headers

HEADER NAME

DESCRIPTION

MANDATORY?

EXAMPLE

api_key

Your unique key used to authorise access to the API.

Yes

n/a

Request Body

NAME

DESCRIPTION

FORMAT

ALLOWED VALUES

MANDATORY FOR

PrimaryLangID

Two character ISO Language Code, for the agent’s preferred language. This is for error messages and some other data such as legal waivers.

2 Alphabetical

  • EN

  • ES


Version

The IATA version of the message

Numeric

Any

Schema

<PointOfSale>


Location / CountryCode

Country code

2 Alphabetical

List of Countries

If toggle feature for market validation is activated.

<Document>

Schema

ReferenceVersion

The IATA Schema version.

Numeric

Any


<Party / Sender> Only for Real IATA

Schema

TravelAgencySender / IATA_Number

Sender unique identifier such as:

IATA number (if you have one)

TIDs number  (recommended if you do not have an IATA)

Numeric

7/8 Numbers

NDC Mandatory

<Party / Sender> Only for Pseudo IATA

Schema

TravelAgencySender / OtherIDs / OtherID

Pseudo IATA (assigned by Iberia)

Numeric

7/8 Numeric

NDC Mandatory

<Party>

Schema

Sender / CorporateSender / ID

Corporate ID

Alphanumeric

Any


Sender / TravelAgencySender / Name

Agency Name

Alphanumeric

Any


Sender / TravelAgencySender / Contacts / Contact / EmailContact / Address

Email to contact the Agency

Alphanumeric

Any

Mandatory for schema if 'EmailContact' tag is indicated.

Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Application

Agency phone type

Alphabetical

  • Business

  • Mobile


Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Number

Phone number to contact the Agency

Numeric

Any


Sender / TravelAgencySender / Contacts / Contact / Name / Surname

Reference Agency contact surname

Alphanumeric

Any


Sender / TravelAgencySender / Contacts / Contact / Name / Given

Reference Agency contact name

Alphanumeric

Any

Mandatory for schema if 'Name' tag is indicated.

Sender / TravelAgencySender / AgencyID

Id for the Agency

Alphanumeric

Any

Schema

Participants / Participant / AggregatorParticipant / AggregatorID

Participant / Aggregator unique identifier:

IATA number (if you have one)

TIDs number  (recommended if you do not have an IATA)

Pseudo IATA(assigned by Iberia)

7 Numeric

7 Numbers

Mandatory for schema if 'Participants' tag is indicated.

<Party> (With Corporates)

Schema

Sender / CorporateSender / ID

ID for the Corporate

Alphanumeric

Any

NDC Mandatory

Participants / Participant / TravelAgencyParticipant / Name

Agency Name

Alphanumeric

Any


Participants / Participant / TravelAgencyParticipant / Contacts / Contact / EmailContact / Address

Email to contact the Agency

Alphanumeric

Any

Mandatory for schema if 'EmailContact' tag is indicated.

Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Application

Agency phone type

Alphabetical

  • Business

  • Mobile


Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Number

Phone number to contact the Agency

Numeric

Any


Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Surname

Reference Agency contact surname

Alphanumeric

Any


Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Given

Reference Agency contact name

Alphanumeric

Any

Mandatory for schema if 'Name' tag is indicated.

Participants / Participant / TravelAgencyParticipant / IATA_Number

Sender unique identifier such as:

IATA number (if you have one)

TIDs number  (recommended if you do not have an IATA)

Numeric

7/8 Numbers

NDC Mandatory

Participants / Participant / TravelAgencyParticipant / AgencyID

Id for the Agency

Alphanumeric

Any

Schema

Participants / Participant / AggregatorParticipant / AggregatorID

Participant / Aggregator unique identifier:

IATA number (if you have one)

TIDs number  (recommended if you do not have an IATA)

Pseudo IATA(assigned by Iberia)

7 Numeric

7 Numbers

Mandatory for schema if 'Participants' tag is indicated.

<Query / Filters> Order by OrderID


OrderID

Attribute

Owner


Order owner

Alphanumeric

IB

Schema

OrderID

Order identification

Alphanumeric

Any

Schema

<Query / Filters> Order by Locator and Surname


Passengers / Individual / Surname

Passenger's surname

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

Alphanumeric

Any

Schema

BookingReferences / BookingReference / ID

Order's locator

Alphanumeric

Any

Schema

BookingReferences / BookingReference / AirlineID

Airline ID

2 Alphanumeric

IB

Schema

Response Body

Order View RS v17

Error messages

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

Mensajes de Error

  • No labels