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

Release 2024.04

Examples of messages with complete flows can be downloaded from here.

The response is the OrderViewRS.

 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

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

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 - OrderCreate

Error rendering macro 'excerpt-include' : No link could be created for 'Query (OrderCreate)'.

DataLists

 PassengerList

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

OfferPriceRQ/RS

SeatAvailabilityRS

ServiceListRS

OrderCreateRQ

OrderViewRS

Passenger / LoyaltyProgramAccount / AccountNumber

Frequent Flyer number

On Business number

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

Alphanumeric

Alphanumeric

Any

Any

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

 ContactList

ContactList

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<DataLists / ContactList>

ContactInformation

Attribute

ContactID

Id of the contact information

Alphanumeric

Any

OrderCreateRQ
OrderChangeRQ
OrderViewRS
OrderReshopRS

ContactInformation / ContactProvided / ContactType

Identifier of field that agencies can include to specify the information to include in confirmation mails.

  • itin_only (omits the pricing

  • itin_and_price (which is the default value)

  • not_send_mail

Alphabetic

  • itin_only (omits the pricing

  • itin_and_price (which is the default value)

  • not_send_mail

OrderCreateRQ
OrderChangeRQ
OrderViewRS
OrderReshopRS

ContactInformation / ContactNotProvided

It's allowed to refuse to provide contact information for IATA agencies --> The passenger contact must include tag <ContactNotProvided/>

  • The agency's contact details (if any) are assigned to passengers who refuse.

  • If no passenger provides their contact details and not all refuse --> Error "You must indicate if the passengers have refused to provide their contact details"

  • If any passenger provides contact details --> It's optional to refuse

  • If all passengers refuse and no Agency Contact is provided --> Error

  • Refuse Tag for Non IATA Agencies --> Warning and no assignment is done

Empty

Empty

 OrderCreateRQ

ContactInformation / ContactProvided / EmailAddress / EmailAddressValue

Email address of the contact

Alphanumeric

Any

OrderCreateRQ
OrderChangeRQ
OrderViewRS
OrderReshopRS

ContactInformation / ContactProvided / Phone / Label

Identify type of phone number.

If the phone number is from an emergency contact, you must write at the OrderCreateRQ: <label>EMERGENCY</label>

Alphabetic

Any

OrderCreateRQ
OrderChangeRQ
OrderViewRS
OrderReshopRS

ContactInformation / ContactProvided / Phone / CountryDialingCode

Country Code associated to phone number if it is filled

Alphanumeric

Ej: (+34)

OrderCreateRQ
OrderChangeRQ
OrderViewRS
OrderReshopRS

ContactInformation / ContactProvided / Phone / PhoneNumber

Phone number of the contact

Numeric

Any

OrderCreateRQ
OrderChangeRQ
OrderViewRS
OrderReshopRS

ContactInformation / Individual / GivenName

Concatenated Name of emergency contact

Alphabetic

Any

OrderCreateRQ
OrderChangeRQ
OrderViewRS
OrderReshopRS

ContactInformation / Individual / Surname

Concatenated Surname of emergency contact

Alphabetic

Any

OrderCreateRQ
OrderChangeRQ
OrderViewRS
OrderReshopRS

 FlightSegmentList

FlightSegmentList

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<DataLists / FlightSegmentList>

FlightSegment

Attribute

SegmentKey

SegmentKey = ID of the segment

<FlightSegment SegmentKey="IB340620231106">

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment

Attribute

SecureFlight

True (If it is a secure flight)

Attribute omitted if not SecureFlight

Alphabetical

True

OfferPriceRS
OrderViewRS
OrderReshopRS (Fare)

FlightSegment / Departure / AirportCode

IATA 3 character code for the departure city/airport/station

3 Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Departure / Date

Date of departure

Date

yyyy-MM-dd

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Departure / Time

Time of departure

Hour

HH:mm

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Departure / AirportName

Name of the departure city/airport/station

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment Departure / Terminal / Name

Name of the departure terminal at city/airport/station

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Arrival / AirportCode

IATA 3 character code for the arrival city/airport/station

3 Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Arrival / Date

Date of departure

Date

yyyy-MM-dd

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Arrival / Time

Time of arrival

Hour

HH:mm

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Arrival / ChangeOfDay

Change of day between departure and arrival

1 Numeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Arrival / AirportName

Name of the arrival city/airport/station

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Arrival / Terminal / Name

Name of the arrival terminal at city/airport/station

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / MarketingCarrier / AirlineID

ID of the airline that markets the flight

Alphabetical

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / MarketingCarrier / Name

Name of the airline that markets the flight

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / MarketingCarrier / FlightNumber

Number of the flight

Numeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / OperatingCarrier / AirlineID

ID of the airline that operates the flight

Alphabetical

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / OperatingCarrier / Name

Name of the airline that operates the flight

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / OperatingCarrier / FlightNumber

Number of the flight

Numeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / OperatingCarrier / Disclosures / Description / Text

Description of the airline

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Equipment / AircraftCode

Code of the aircraft that operates the flight

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Equipment / Name

Name of the aircraft that operates the flight

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

<DataLists / FlightSegmentList / FlightSegment/FlightDetail / FlightDuration>

Value

Duration of the flight, period of time (PT) indicated in hours and minutes.

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

<DataLists / FlightSegmentList / FlightSegment/FlightDetail / Stops>

StopQuantity

Number of technical stops

Numeric

>= 0

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

StopLocations

List of the technical stops

List

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

<DataLists / FlightSegmentList / FlightSegment/FlightDetail / Stops / StopLocations / StopLocation>

AirportCode

Code of the airport

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

Name

Name of the airport

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

ArrivalDate

Arrival date

Date

yyyy-MM-dd

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

ArrivalTime

Arrival time

Time

hh:mm

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

DepartureDate

Departure date

Date

yyyy-MM-dd

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

DepartureTime

Departure time

Time

hh:mm

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

GroundTime

Duration of the stop

Alphanumeric

ISO 8601 duration format (EX: PT2H40M)

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

 InstructionsList

InstructionList

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<DataLists / InstructionsList> 

Instruction

Attribute

ListKey

Id for the instruction to select sport equipment

 

Alphanumeric

 

Any

 

OrderCreateRQ

OrderRetrieveRQ

OrderViewRS

Instruction / FreeFormTextInstruction

Attribute

refs

Reference for passenger and segments associated to selected sport equipment

Alphanumeric

PassengerID and SegmentID

Valid example: “ADULT_01 IB303420231016“

OrderCreateRQ

OrderRetrieveRQ

OrderViewRS

Instruction / FreeFormTextInstruction / Remark

Selected sport equipment code

Alphanumeric

  • BIKE: BAGGAGE/SP/0EC

  • SKII: BAGGAGE/SP/0DD

  • GOLF: BAGGAGE/SP/0D4

  • SURF: BAGGAGE/SP/0D8

  • SCUB: BAGGAGE/SP/0EE

  • FISH: BAGGAGE/SP/0D6

OrderCreateRQ

OrderRetrieveRQ

OrderViewRS

 ServiceDefinitionList

ServiceDefinitionList

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<DataLists / ServiceDefinitionList>

ServiceDefinition

Attribute

ServiceDefinitionID

ID reference of the service

Alphabetical

Any (e.g.: DEAF, BAGSERVICE-1)

SeatAvailabilityRS
ServiceListRS

OrderCreateRQ
OrderViewRS

ServiceDefinition / Name

Name of the service

Alphanumeric

Any

SeatAvailabilityRS
ServiceListRS

OrderCreateRQ
OrderViewRS

ServiceDefinition / Encoding / RFIC

RFIC of booked ancillaries

Alphabetical

Any (e.g.: A, C)

SeatAvailabilityRS
ServiceListRS
OrderViewRS

ServiceDefinition / Encoding / Subcode

SubCode (RFISC) of booked ancillaries

Alphanumeric

Any (e.g.: 0B5, 0GO)

SeatAvailabilityRS
ServiceListRS
OrderViewRS

ServiceDefinition / BaggageAllowanceRef

Reference associated to hand/checked baggage included in passenger fare.

Alphanumeric

Any

OrderViewRS

ServiceDefinition / Descriptions / Description

Attribute

refs

Passenger identification associated to the service

Alphanumeric

Any

SeatAvailabilityRS
ServiceListRS
OrderViewRS

ServiceDefinition / Descriptions / Description / Text

Description of the service (Limited to 90 characters)

*Additional text is mandatory for DPNA to explain reason for assistance.

Alphanumeric

Any

SeatAvailabilityRS
ServiceListRS
OrderViewRS

ServiceDefinition / BookingInstructions / SSRCode

Ancillary SSR type on booking (used for legacy system compatibility)

Alphabetical

  • Ancillaries:

    • XBAG - Baggage

    • BDPR - Priority Boarding

    • BIKE - Bicycle (Sport Equipment)

    • SPEQ - Sport Equipment

    • RQST - Seat

  • Special Needs:

    • BLND - Blind Passenger

    • DEAF - Deaf Passenger

    • WCHR - Wheelchair for ramp

    • WCHS - Wheelchair for steps

    • DPNA - Disabled Passenger Needs Assistance*

SeatAvailabilityRS
ServiceListRS

OrderCreateRQ
OrderViewRS

ServiceDefinition / BookingInstructions / Method

Method. Always value= SSR

Alphabetical

SSR

SeatAvailabilityRS
ServiceListRS
OrderViewRS

ServiceDefinition / ServiceBundle

Contains one or more ServiceDefinitionRef when buying more that one of the same service

Alphanumeric

Any

ServiceListRS

ServiceDefinition / Detail / ServiceItemQuantityRules / MaximumQuantity

Maximum quantity of service

Numeric

Any

ServiceListRS

Example OrderCreateRQ:

 XML Sample
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <OrderCreateRQ Version="5.000" 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>AgencyName</Name>
                  <Contacts>
                     <Contact>
                        <EmailContact>
                           <Address>ibprueb2@gmail.com</Address>
                        </EmailContact>
                        <PhoneContact>
                           <Application>BUSINESS</Application>
                           <Number>+34666554433</Number>
                        </PhoneContact>
                        <Name>
                           <Surname>Martínez</Surname>
                           <Given>Pepe</Given>
                        </Name>
                     </Contact>
                  </Contacts>
                  <IATA_Number>12345678</IATA_Number>
                  <AgencyID>TRAVEL AGENCY</AgencyID>
               </TravelAgencySender>
            </Sender>
         </Party>
         <Query>
            <Order>
               <Offer OfferID="IB700fb61f0530487abb23d62f37d536c6OC" Owner="IB" ResponseID="Qm9va2luZ0AxNjI3NDYxNzk2ODY4LUdjUmtu">
                  <OfferItem OfferItemID="IB700fb61f0530487abb23d62f37d536c6OC_01">
                     <PassengerRefs>ADULT_01 ADULT_02 ADULT_03 ADULT_04</PassengerRefs>
                  </OfferItem>
               </Offer>
               <!--Introducción de los servicios especiales-->
               <Offer OfferID="ALACARTE_SSR_IB7e5c68abeb5e482c839c6efbdf4472ac" Owner="IB" ResponseID="Qm9va2luZ0AxNjI3NDYxNzk2ODY4LUdjUmtu">
                  <OfferItem OfferItemID="IB700fb61f0530487abb23d62f37d536c6OC_DEAF">
                     <PassengerRefs>ADULT_01</PassengerRefs>
                     <ServiceSelection ServiceID="SSR_SN_c9db38dc-ada9-4955-b9db-7a16875ed74f">
                        <ServiceDefinitionID>SPECIAL_NEED-DEAF</ServiceDefinitionID>
                     </ServiceSelection>
                  </OfferItem>
                  <OfferItem OfferItemID="IB700fb61f0530487abb23d62f37d536c6OC_SVAN">
                     <PassengerRefs>ADULT_01</PassengerRefs>
                     <ServiceSelection ServiceID="SSR_SN_5e6fb112-7c1d-4242-92a4-b7b48408cacf">
                        <ServiceDefinitionID>SPECIAL_NEED-SVAN</ServiceDefinitionID>
                     </ServiceSelection>
                  </OfferItem>
               </Offer>
            </Order>
            <Payments>
               <Payment>
                  <Type>MS</Type>
                  <Method>
                     <Voucher>
                        <Number>BONO100EUR</Number>
                     </Voucher>
                  </Method>
                  <Amount Code="EUR">1243.56</Amount>
                  <Payer>
                     <ContactInfoRefs>Payer</ContactInfoRefs>
                  </Payer>
               </Payment>
               <Payment>
                  <Type>CA</Type>
                  <Method>
                     <Cash CashInd="true"/>
                  </Method>
                  <Amount Code="EUR">0</Amount>
                  <Payer>
                     <ContactInfoRefs>Payer</ContactInfoRefs>
                  </Payer>
               </Payment>
            </Payments>
            <DataLists>
               <PassengerList>
                  <Passenger PassengerID="ADULT_01">
                     <PTC>ADT</PTC>
                     <Birthdate>1993-12-23</Birthdate>
                     <Individual IndividualID="IND_ADULT_01">
                        <Gender>Male</Gender>
                        <NameTitle>MR</NameTitle>
                        <GivenName>ADULTO</GivenName>
                        <Surname>UNO PRUEBA</Surname>
                     </Individual>
                     <FOID>
                        <FOID_Number>12345678Z</FOID_Number>
                        <FOID_Type>NI</FOID_Type>
                     </FOID>
                     <ContactInfoRef>REFUSE_CONTACT</ContactInfoRef>
                  </Passenger>
                  <Passenger PassengerID="ADULT_02">
                     <PTC>ADT</PTC>
                     <Birthdate>1987-08-23</Birthdate>
                     <Individual IndividualID="IND_ADULT_02">
                        <Gender>Female</Gender>
                        <NameTitle>MRS</NameTitle>
                        <GivenName>ADULTA</GivenName>
                        <Surname>UNA PRUEBA</Surname>
                     </Individual>
                     <FOID>
                        <FOID_Number>75481546P</FOID_Number>
                        <FOID_Type>NI</FOID_Type>
                     </FOID>
                     <ContactInfoRef>REFUSE_CONTACT</ContactInfoRef>
                  </Passenger>
                  <Passenger PassengerID="ADULT_03">
                     <PTC>ADT</PTC>
                     <Birthdate>1993-12-23</Birthdate>
                     <Individual IndividualID="IND_ADULT_03">
                        <Gender>Male</Gender>
                        <NameTitle>MR</NameTitle>
                        <GivenName>ADULTO</GivenName>
                        <Surname>TRES PRUEBA</Surname>
                     </Individual>                     
                     <FOID>
                        <FOID_Number>25369424X</FOID_Number>
                        <FOID_Type>NI</FOID_Type>
                     </FOID>
                     <ContactInfoRef>REFUSE_CONTACT</ContactInfoRef>
                  </Passenger>
                  <Passenger PassengerID="ADULT_04">
                     <PTC>ADT</PTC>
                     <Birthdate>1987-08-23</Birthdate>
                     <Individual IndividualID="IND_ADULT_04">
                        <Gender>Female</Gender>
                        <NameTitle>MRS</NameTitle>
                        <GivenName>ADULTA</GivenName>
                        <Surname>CUATRO PRUEBA</Surname>
                     </Individual>
                     <FOID>
                        <FOID_Number>74582559E</FOID_Number>
                        <FOID_Type>NI</FOID_Type>
                     </FOID>
                     <ContactInfoRef>REFUSE_CONTACT</ContactInfoRef>
                  </Passenger>
               </PassengerList>
               <ContactList>
                  <ContactInformation ContactID="Payer">
                     <ContactType>Payer</ContactType>
                     <ContactProvided>
                        <EmailAddress>
                           <EmailAddressValue>pasajeroib@bylup.com</EmailAddressValue>
                        </EmailAddress>
                     </ContactProvided>
                     <IndividualRef>IND_ADULT_01</IndividualRef>
                  </ContactInformation>
                  <ContactInformation ContactID="REFUSE_CONTACT">
                     <ContactNotProvided/>
                  </ContactInformation>
               </ContactList>
               <ServiceDefinitionList>
                  <ServiceDefinition ServiceDefinitionID="SPECIAL_NEED-DEAF">
                     <Name>Deaf Passenger</Name>
                     <Descriptions>
                        <Description refs="ADULT_01">
                           <Text>Request Service Animal if travelling with one*/?()</Text>
                        </Description>
                     </Descriptions>
                     <BookingInstructions>
                        <SSRCode>DEAF</SSRCode>
                     </BookingInstructions>
                  </ServiceDefinition>
                  <ServiceDefinition ServiceDefinitionID="SPECIAL_NEED-SVAN">
                     <Name>Service Animal</Name>
                     <Descriptions>
                        <Description refs="ADULT_01">
                           <Text>Service Animal travelling in the cabin with Blind, Deaf, Disabled passengers or Certified Instructors. Specify breed and weight of animal</Text>
                        </Description>
                     </Descriptions>
                     <BookingInstructions>
                        <SSRCode>SVAN</SSRCode>
                     </BookingInstructions>
                  </ServiceDefinition>
               </ServiceDefinitionList>
            </DataLists>
         </Query>
      </OrderCreateRQ>
   </soapenv:Body>
</soapenv:Envelope>

Error messages

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

Errors

  • No labels