...
...
Release 2023.09
Legend |
---|
...
New or |
...
modified field | Field to be removed/deprecated |
Unique to v2 Branded Fares |
---|
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 |
---|
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 |
|
|
Version | The IATA version of the message | Numeric | Any | Schema |
<PointOfSale> |
| |||
Location / CountryCode | Country code | 2 Alphabetical | 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 |
|
|
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 | Mandatory for schema if 'Name' tag is indicated. |
Sender / TravelAgencySender / Contacts / Contact / Name / Given | Reference Agency contact name | Alphanumeric | Any |
| ||||
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 |
|
|
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 | Mandatory for schema if 'Name' tag is indicated. |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Given | Reference Agency contact name | Alphanumeric | Any |
| ||||||
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
| Order owner | Alphanumeric | IB | Schema | ||
OrderID | Order identification | Alphanumeric | Any | Schema | ||
<Query / Filters> Order by Locator and Surname |
| |||||
Passengers / Individual / Surname | Passenger's surname |
| 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 OrderViewRS v17.2
Error messages
For further information about all kind of error messages, please go to the following link:
...