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

Release 2024.04

*Functionality improvements do not necessarily affect the message structure.

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

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

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<Document>

ReferenceVersion

The IATA Schema version.

Numeric

Any

 All Services

 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

Recipient Section - (only for OCN message)

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<Party>

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

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

Query

 Query - OrderReshopRQ

Query - OrderID

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<Query> 

OrderID

Id of the Order

Alphanumeric

Any

Query - Reprice Flow (to be deprecated in the future, and replaced with Reprice on hold )

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<Query / Reshop / OrderServicing / Add / Qualifier / ExistingOrderQualifier>

OrderKeys / OrderID

Attribute

Owner

Order Identification

Alphanumeric

Any

OrderKeys / AssociatedIDs / AssociatedID / OfferItemID

Attribute

Owner

The ID of the Offer to be purchased together with the identity of the Owner of the Offer (which in this case is always Iberia).

2-character Alphabetical

IB

PassengerReferences

Reference of the passenger

Alphanumeric

Any

Query - Reshop Availability (Add)

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<Query / Reshop / OrderServicing / Add / FlightQuery>

OriginDestinations / OriginDestination

Attribute

OriginDestinationKey

ID for the Origin/Destination

Alphanumeric

This attribute can be filled with any value, but first character cannot be a number digit or a special character.

OriginDestinations / OriginDestination / Departure / AirportCode

Departure airport code

Mandatory for schema if 'OriginDestination' tag is indicated.

3 Alphabetical

Any valid airport code (JFK)

OriginDestinations / OriginDestination / Departure / Date

Departure date

Mandatory for schema if 'OriginDestination' tag is indicated.

Date 

Any Date (2019-10-06<)

OriginDestinations / OriginDestination / Arrival / AirportCode

Arrival airport code

Mandatory for schema if 'OriginDestination' tag is indicated.

3 Alphabetical

Any valid airport code (BCN)

OriginDestinations / OriginDestination / MarketingCarrierAirline / AirlineID

Airline identification code

Mandatory for schema if 'MarketingCarrierAirline' tag is indicated.

2 Alphabetical

Any valid, in our case IB

OriginDestinations / OriginDestination / MarketingCarrierAirline / FlightNumber

Flight number identification

Alphanumeric

It is valid to fill in with the following options for flight changes in paid orders (Not available for unpaid orders):

  • OPEN (All flights availability will be displayed)

  • XXXX (Specific Flight Number - This flight number availability will be displayed).

<Query / Reshop / OrderServicing / Add / Passengers>

PassengerReferences

Passenger references the new search applies to

Mandatory for schema if 'Passengers' tag is indicated.

Alphanumeric

Any (Ex: ADULT_01 CHILD_01 INFANT_01)

<Query / Reshop / OrderServicing / Add / Preference>

If the Preference tag is included in the request, one or more of the following must be included.

If more that one is used, then they must be sent in the same order as listed below.

FarePreferences / Types / Type

Attribute

PreferencesContext

Type of product selected.

Alphanumeric

For the Products currently available through our NDC channel, and the codes required to request them please see the information in Private Leisure Fares.

FarePreferences / TicketDesigs / TicketDesig

Spanish Resident discount code.

Alphanumeric

  • RC (Residente Canarias)

  • BP (Residente Baleares)

  • RM (Residente Melilla)

  • RE (Residente Ceuta)

  • BI (Para el interior de Baleares)

  • DC (Para el interior de Canarias)

Spanish Large Family discount code

  • F1 (General discount)

  • F2 (Special discount)

FlightPreferences / Characteristic / DirectPreferences

Maximum number of stops.

Numeric

  • 0 or Empty - Direct Flights (Default)

  • n (1, 2, 3...) - Maximum number

CabinPreferences / CabinType / Code

IATA PADIS Cabin code (This info will be applied as a preference, so other offers will also be returned).

1 Numeric

PADIS → 9873 Cabin class of service, coded

1 → First class, Highest class of service (First Class Category)
2 → Second class, Medium class of service (Business Class Category)
3 → Third class, lowest class of service (all economy/coach class categories)
4 → Economy/coach premium
5 → Economy/coach

Query - Reshop Availability (Delete)

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<Query / Reshop / OrderServicing / Delete>

OrderItem 

Attribute

OrderItemID

Identification of the flight item associated to the passenger who is asking for new availabilities options.

Mandatory for schema if 'Delete' tag is indicated.

Alphanumeric

Any valid flight item returned in Order Create RS.

ServiceRetainRequestIDs

Flight services that passenger wants to mantain in new search.

Alphanumeric

Any valid flight service returned in Order Create RS.

Query - Reshop Fare

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<Query / Reshop / OrderServicing / Add / Qualifier / ExistingOrderQualifier>

OrderKeys / OrderID

Attribute

Owner

The ID of the Order being serviced together with the identity of the Owner of the Offer (which in this case is always Iberia).

Mandatory for schema if 'ExistingOrderQualifier' tag is indicated.

2-character Alphabetical

IB

OrderKeys / AssociatedIDs / AssociatedID / OfferItemID

Attribute

Owner

The ID of the Offer to be purchased together with the identity of the Owner of the Offer (which in this case is always Iberia).

2-character Alphabetical

IB

PassengerReferences

References the passenger(s) to which the Offer applies.

Alphanumeric

Any (Ex: ADULT_01 CHILD_01 INFANT_01)

Preferences

 Preferences

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<Preference>

*See Note Below

FarePreferences / Types / Type

Attribute

PreferencesContext

Mandatory for schema if 'Preference' tag is indicated and don't have other preference inside.

Type of product selected (e.g. “TO“, Tour Operator private product):

<Type PreferencesContext="TO">758</Type>

Alphanumeric

For the Products currently available through our NDC channel, and the codes required to request them please see the information in Private Leisure Fares.

FarePreferences / TicketDesigs / TicketDesig

Spanish Resident discount code.

Mandatory for schema if 'Preference' tag is indicated and don't have other preference inside.

Alphanumeric

  • RC (Residente Canarias)

  • BP (Residente Baleares)

  • RM (Residente Melilla)

  • RE (Residente Ceuta)

  • BI (Para el interior de Baleares)

  • DC (Para el interior de Canarias)

Spanish Large Family discount code

  • F1 (General discount)

  • F2 (Special discount)

FlightPreferences / Characteristic / DirectPreferences

Maximum number of stops.

Mandatory for schema if 'Preference' tag is indicated and don't have other preference inside

Numeric

  • 0 or Empty - Direct Flights (Default)

  • n (1, 2, 3...) - Maximum number

CabinPreferences / CabinType / Code

IATA PADIS Cabin code (This info will be applied as a preference, so other offers will also be returned).

Mandatory for schema if 'Preference' tag is indicated and don't have other preference inside

1 Numeric

PADIS → 9873 Cabin class of service, coded

1 → First class, Highest class of service (First Class Category)
2 → Second class, Medium class of service (Business Class Category)
3 → Third class, lowest class of service (all economy/coach class categories)
4 → Economy/coach premium
5 → Economy/coach

PricingMethodPreference / BestPricingOption

Code to select best pricing option.

Optional and just for NDC.

1 Alphabetical

  • C (cheapest fares)

  • Y (cheapest fares for a specific cabin type)

*Preference

Please note that the preferences Fare, Flight, Cabin and PricingMethod must always be past in this sequence if more that one is being used.

DataLists / PassengerList

 DataLists / PassengerList

NAME

DESCRIPTION

FORMAT

ALLOWED/ POSSIBLE VALUES

NDC SERVICES

<DataLists / PassengerList>

Passenger

Attribute

PassengerID

A unique ID for each passenger.

Alphanumeric (Maximum → 20 characters)

This attribute can be filled with any value, but first character cannot be a number digit or a special character.

AirShoppingRQ/RS

OfferPriceRQ/RS

SeatAvailabilityRS

ServiceListRS

OrderCreateRQ

OrderViewRS

OrderChangeRQ

OrderReshopRQ/RS

Passenger / PTC

Passenger Type Code

3 Alphabetical 

Type of Passengers

AirShoppingRQ/RS

OfferPriceRQ/RS

SeatAvailabilityRS

ServiceListRS

OrderCreateRQ

OrderReshopRQ

OrderChangeRQ

OrderViewRS

Passenger / BirthDate

Birthdate of the passenger

Mandatory for secure flights for all passengers.

Mandatory for CHD and INF Passengers

Date (yyyy-mm-dd)

Date depends of the PTC

OrderChangeRQ

OrderCreateRQ

OrderViewRS

Passenger / Individual

Attribute

IndividualID

ID of the passenger (within this specific message), for internal use only.

Must be unique for each passenger in the message and can be referenced in Query / DataLists / ContactList / ContactInformation / IndividualRef

Alphanumeric (Maximum → 20 characters)

This attribute can be filled with any value, but first character cannot be a number digit or a special character.

OrderChangeRQ

OrderCreateRQ

Passenger / Individual / Gender

Gender of the passenger.

In secure flight:

  • Mandatory for infant passengers

  • Mandatory for all other passengers if the title is not indicated

  • Mandatory for secure flights and infant passengers in the OrderCreate message.

Alphabetical

  • Male

  • Female

  • Unspecified

OrderCreateRQ

OrderViewRS

OrderChangeRQ

Passenger / Individual / NameTitle

Title of the passenger
NDC supports followings fields (MR, MRS, MS, MISS).

If another value is introduced no error is shown, it is ignored unless the Secure Flight is involved.

In secure flight:

  • Optional for infant passengers

  • Mandatory for all other passengers if the gender is not indicated.

  • NDC Mandatory for secure flights

Alphabetical

  • MR

  • MRS

  • MS

  • MSS

  • MISS

OrderCreateRQ

OrderViewRS

OrderChangeRQ

Passenger / Individual / GivenName

Name of the passenger (which includes all given names, including first and second names).

Alphabetical

Any

OfferPriceRQ/RS

SeatAvailabilityRS

ServiceListRS

OrderCreateRQ

OrderViewRS

OrderChangeRQ

Passenger / Individual / Surname

Surname of the passenger.

If the name and surnames exceed the maximum number of characters allowed, the original name will be displayed, without trimming.

If agency has specified separated by a special character "@" first and second surname, it will be displayed as introduced with separator → e.g.: De la Morena@López)

Mandatory for schema if 'GivenName' tag is indicated.

Alphabetical

Any

OfferPriceRQ/RS

SeatAvailabilityRS

ServiceListRS

OrderCreateRQ

OrderViewRS

OrderChangeRQ

Passenger / Individual / SurnameSuffix

Can be used to indicate that the individual holds a position, educational degree, accreditation, office, or honor.

Can be used to distinguish between two passengers with exactly the same NameTitle, GivenName and Surname (i.e. John Smith, and John Smith Jr.)

Mandatory if NameTitle, GivenName and Surname are the same for two passengers.

Alphabetical

Any

  • JR

  • SR

OrderCreateRQ

OrderViewRS

OrderChangeRQ

Passenger / LoyaltyProgramAccount / Airline / AirlineDesignator

Frequent Flyer Airline ID

Mandatory if 'LoyaltyProgramAccount' tag is indicated

Alphanumeric

Any

AirShoppingRQ/RS

OfferPriceRQ/RS

SeatAvailabilityRS

ServiceListRS

OrderCreateRQ

OrderViewRS

Passenger / LoyaltyProgramAccount / AccountNumber

Frequent Flyer number

On Business number (only to be sent in OrderCreateRQ)

Mandatory if 'LoyaltyProgramAccount' tag is indicated in OrderCreate or OrderChange

Alphanumeric

Alphanumeric

Any

Any

AirShoppingRQ/RS

OfferPriceRQ/RS

SeatAvailabilityRS

ServiceListRS

OrderCreateRQ

OrderViewRS

Passenger / FOID / FOID_Number

Number for the document

Mandatory for schema if 'FOID' tag is indicated.

Alphanumeric

PP (Passport): Any sequence of alpha numeric characters, also "-" and "." characters are accepted.

Valid examples: 1234-ABC, G.12345

NI (National ID): Only alpha numeric characters are allowed

Valid examples:

X1234567S

123456789012A

OrderChangeRQ

OrderCreateRQ

OrderViewRS

Passenger / FOID / FOID_Type

Type of the passenger ID Info

Mandatory for schema if 'FOID' tag is indicated.

2 Alphanumeric

  • PP (Passport) - Not valid for Spanish Resident and Large Family discounts

  • NI (National ID)

OrderChangeRQ

OrderCreateRQ

OrderViewRS

Passenger / InfantRef

Indicates the infant in lap associated to this adult.

If this tag is not indicated in the OrderCreateRQ, the infant in lap will be associated to the first adult in the Order automatically.

Recommended to ensure infant in lap is with correct adult.

Alphanumeric

Reference to infant PassengerID tag

OrderCreateRQ

OrderViewRS

Passenger / IdentityDocument / IdentityDocumentNumber

If Type of document is:

  • F1 - this will be the Spanish Resident certificate number 

(Optional if Spanish DNI/NIE is sent. Validated only if sent without Spanish DNI/NIE)

  • AI - this will be the Large Family certificate number

  • F - this should be the relevant fiscal information for the country.

    • The information should be sent using the following two or three elements separated by obliques "/":

      • Document Type

      • Document Number/ID

      • Company Name (optional)

    • examples:

      • "RUC/12345678X/BIG COMPANY"

      • “CUIL/9393933333

    • This fiscal information will be included on the tickets as required by local laws.

  • If any unacceptable information is sent and not included in the reservation/tickets, a warning message will be returned in the OrderViewRS.

  • Mandatory for schema if 'IdentityDocument' tag is indicated 

    NDC Mandatory for POS: PE, EC, AR and GT (FiscalID). For Infant passengers is not mandatory, so case that this document doesn’t come it will be assign the fiscal documentation from one of the Adults passengers.

Alphanumeric

  • 12 characters maximum for residence document

  • 20 characters maximum for large family document

  • 70 characters maximum for FiscalId

OrderChangeRQ

OrderCreateRQ

OrderViewRS

Passenger / IdentityDocument / IdentityDocumentType

Type of document

Mandatory for schema if 'IdentityDocument' tag is indicated  NDC Mandatory for POS: PE, EC, AR and GT (FiscalID)

2 Alphanumeric

  • F1 (Resident Discount)

  • AI (Additional information, Large Family Discount)

  • F (FiscalId)

  • Any other document

OrderChangeRQ

OrderCreateRQ

OrderViewRS

Passenger / ContactInfoRef

Reference for passenger contact info

Alphanumeric

Any

OrderChangeRQ

OrderCreateRQ

OrderViewRS

Passenger / Remark / Remark

In OrderCreate it is used to communicate the:

Municipality of residence / Community code for large family

<Remark>
  <!--Resident Discount Location Code-->
  <Remark>RESIDENT-380380</Remark>
</Remark>
<Remark>
  <!--Large Family Discount Community Code-->
  <Remark>LARGEFAMILY-380380</Remark>
</Remark>

In OrderView is is used to communicate the:

  • Type of discount applied and the Municipality/Community code for the passenger

  • Verified or not verified resident discount for passenger

<Remark>
  <Remark>RESIDENT-380380</Remark>
</Remark>
<Remark>
  <Remark>LARGEFAMILY-380380</Remark>
</Remark>
<Remark>
  <Remark>UNVERIFIED RESIDENT STATUS</Remark>
</Remark>

Mandatory for schema if 'IdentityDocument' tag is indicated.

Alphanumeric

  • RESIDENT-Code of Location

  • LARGEFAMILY-Code of Community

INE - Relación de municipios y códigos por provincias

OrderChangeRQ

OrderCreateRQ

OrderViewRS

Example :

 Example - OrderReshopRQ - Availability 17.2v2
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <OrderReshopRQ xsi:schemaLocation="http://www.iata.org/IATA/EDIST/2017.2 ../../OrderReshopRQ.xsd" Version="5.000" PrimaryLangID="es" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 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>
                  <Name>Alvaros Agency Tests SA</Name>
                  <Contacts>
                     <Contact>
                        <EmailContact>
                           <Address>pruebas@pruebas.com</Address>
                        </EmailContact>
                        <PhoneContact>
                           <Application>MOBILE</Application>
                           <Number CountryCode="+34">666666666</Number>
                        </PhoneContact>
                        <Name>
                           <Surname>Hernandez</Surname>
                           <Given>Raul</Given>
                        </Name>
                     </Contact>
                  </Contacts>
                  <IATA_Number>12345678</IATA_Number>
                  <AgencyID>Alvaros VIAJES</AgencyID>
               </TravelAgencySender>
            </Sender>
         </Party>
         <Query>
            <OrderID>IB73b10257e52c4aeba1fd7c6b40588064OC</OrderID>
            <Reshop>
               <OrderServicing>
                  <Add>
                     <FlightQuery>
                        <!--Solo indicamos lo que queremos cambiar, lo que se mantiene lo decimos abajo diciendo el servicio que queremos mantener.-->
                        <OriginDestinations>
                           <OriginDestination>
                              <Departure>
                                 <AirportCode>SDR</AirportCode>
                                 <Date>2024-03-05</Date>
                              </Departure>
                              <Arrival>
                                 <AirportCode>EZE</AirportCode>
                              </Arrival>
                           </OriginDestination>
                           <OriginDestination>
                              <Departure>
                                 <AirportCode>EZE</AirportCode>
                                 <Date>2024-03-10</Date>
                              </Departure>
                              <Arrival>
                                 <AirportCode>SDR</AirportCode>
                              </Arrival>
                           </OriginDestination>
                        </OriginDestinations>
                     </FlightQuery>
                     <Preference>
                        <FlightPreferences>
                           <Characteristic>
                              <DirectPreferences>4</DirectPreferences>
                           </Characteristic>
                        </FlightPreferences>
                     </Preference>
                     <Passengers>
                        <PassengerReferences>ADULT_01 ADULT_02</PassengerReferences>
                     </Passengers>
                  </Add>
                  <Delete>
                     <OrderItem OrderItemID="IB73b10257e52c4aeba1fd7c6b40588064OC_01"/>
                     <OrderItem OrderItemID="IB73b10257e52c4aeba1fd7c6b40588064OC_02"/>
                  </Delete>
               </OrderServicing>
            </Reshop>
         </Query>
         <DataLists>
            <PassengerList>
               <Passenger PassengerID="ADULT_01">
                  <PTC>ADT</PTC>
                  <Individual>
                     <GivenName>Luis Alfonso</GivenName>
                     <Surname>PÈrez PÈrez</Surname>
                  </Individual>
               </Passenger>
               <Passenger PassengerID="ADULT_02">
                  <PTC>ADT</PTC>
                  <Individual>
                     <GivenName>Ana Laura</GivenName>
                     <Surname>Santos Perez</Surname>
                  </Individual>
               </Passenger>
            </PassengerList>
         </DataLists>
      </OrderReshopRQ>
   </soapenv:Body>
</soapenv:Envelope>
 Example - OrderReshopRQ - Fare 17.2v2
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <OrderReshopRQ xsi:schemaLocation="http://www.iata.org/IATA/EDIST/2017.2 ../../OrderReshopRQ.xsd" Version="5.000" PrimaryLangID="es" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 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>12345678</IATA_Number>
                  <AgencyID>Alvaros VIAJES</AgencyID>
               </TravelAgencySender>
            </Sender>
         </Party>
         <Query>
            <OrderID>IB73b10257e52c4aeba1fd7c6b40588064OC</OrderID>
            <Reshop>
               <OrderServicing>
                  <!--Cambiamos solo la ida, queremos mantener la vuelta-->
                  <Add>
                     <Qualifier>
                        <ExistingOrderQualifier>
                           <OrderKeys>
                              <OrderID Owner="IB">IB73b10257e52c4aeba1fd7c6b40588064OC</OrderID>
                              <AssociatedIDs>
                                 <AssociatedID>
                                    <OfferItemID Owner="IB">IB16e45cf7c4c1447abddaea68fb5242dbOP_01</OfferItemID>
                                    <!--Reference to previous ReshopOffer so we can use the items-->
                                 </AssociatedID>
                              </AssociatedIDs>
                           </OrderKeys>
                           <PassengerReferences>ADULT_01 ADULT_02</PassengerReferences>
                        </ExistingOrderQualifier>
                     </Qualifier>
                  </Add>
               </OrderServicing>
            </Reshop>
         </Query>
         <DataLists>
            <PassengerList>
               <Passenger PassengerID="ADULT_01">
                  <PTC>ADT</PTC>
                  <Individual>
                     <GivenName>Luis Alfonso</GivenName>
                     <Surname>PÈrez PÈrez</Surname>
                  </Individual>
               </Passenger>
               <Passenger PassengerID="ADULT_02">
                  <PTC>ADT</PTC>
                  <Individual>
                     <GivenName>Ana Laura</GivenName>
                     <Surname>Santos Perez</Surname>
                  </Individual>
               </Passenger>
            </PassengerList>
         </DataLists>
      </OrderReshopRQ>
   </soapenv:Body>
</soapenv:Envelope>

Error messages

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

Errors

  • No labels