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

Functional Description. Release 2024.01

Legend

New or modified field

Field to be removed/deprecated

Unique to v2 Branded Fares

Functional Description

The purpose of this table is to show the responses for NDC services Order Create, Order Change and Order Retrieve.

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

Response Body (OrderViewRS)

NAME

DESCRIPTION

FORMAT

POSSIBLE VALUES

NDC Services

Version

NDC message version

Alphanumeric

Any 

All Services

PrimaryLangID

NDC message language identification

Alphabetical

Any (e.g.: es)

All Services

xmlns

IATA official website

Alphabetical

Any 

All Services

<Document>

ReferenceVersion

Version

Numeric

Any

All Services

<Errors>

Error

Attribute

ShortText

Attribute

Code

Different messages to inform about errors that occurs during the process.

Alphanumeric

Any

All Services

<Success/>

<Warnings/>

Warning

Different messages to inform the agency, for example:

  • Error issuing tickets

  • Changes made outside NDC

Alphanumeric

Any

All Services

<Party / Sender / TravelAgencySender>

Type

Agency Type

  • Online (Default)

  • Offline

If we receive any other value it will return error, but only when using Credit Card form of payment.

Alphabetical

Any

OrderCreate

IATA_Number

Sender IATA number 

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

8 numbers

All Services

AgencyID

Agency ID

Alphanumeric

Any

All Services

Name

Agency name. SELLER_NAME from table NDC_SELLERS.

Alphanumeric

Any

All Services

<Party / Sender / TravelAgencySender / Contacts>

Contact

Attribute

ContactType

Field that agencies can include to specify the information to include in confirmation mails.

  • itin_only

  • itin_and_price (default value)

Alphabetical

  • itin_only

  • itin_and_price (default value)

All Services

Contact / EmailContact / Address

Email to contact the Agency

Alphanumeric

Any

All Services

Contact / PhoneContact / Application

Agency phone type

Alphabetical

  • BUSINESS

  • MOBILE

All Services

Contact / PhoneContact / Number

Phone number to contact the Agency

Numeric

Any

All Services

Contact / Name / Surname

Reference Agency contact surname

Alphanumeric

Any

All Services

Contact / Name / Given

Reference Agency contact name

Alphanumeric

Any

All Services

<Party / Participants>

Participants / Participant

Attribute

AggregatorParticipant@SequenceNumber

Sequence number related to the Participants irrespective of their type (TravelAgency, Aggregator, etc…), sent in the OrderRetrieveRQ

numerics

NOTE: This information is ONLY displayed in the case of TravelPort. Internal documentation, not published.

Participants / Participant / AggregatorParticipant / AggregatorID

The unique identifier of the Aggregator sent in the OrderRetrieveRQ.

7/8 Numeric

<Party> (With Corporates or delegated flow)

Sender / CorporateSender / ID

ID for the corporate

Alphanumeric

Any

All Services

Participants / Participant / TravelAgencyParticipant / IATA_Number

Attribute

SequenceNumber

Sequence number related to the Participants, that will be identified by the type.

Numeric

Any

All Services

Participants / Participant / TravelAgencyParticipant / Name

Agency name

Alphabetical

Any

All Services

Participants / Participant / TravelAgencyParticipant / Type

Only when using IATA Delegation functionality.

This is used to indicate whether the TravelAgencyParticipant is the agency undertaking the Servicing or the agency that created or paid for the order.

Only as per allowed values

  • SERVICING_IATA

  • RESPONSIBLE_IATA

IATA Delegation when CorporateSender is used.

Participants / Participant / TravelAgencyParticipant / Contacts / Contact

Attribute

ContactType

Field that agencies can include to specify the information to include in confirmation mails.

  • itin_only

  • itin_and_price (default value)

Alphabetical

  • itin_only

  • itin_and_price (default value)

All Services

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

Email to contact the Agency

Alphanumeric

Any

All Services

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

Agency phone type

Alphabetical

  • BUSINESS

  • MOBILE

All Services

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

Phone number to contact the Agency

Numeric

Any

All Services

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

Reference Agency contact surname

Alphanumeric

Any

All Services

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

Reference Agency contact name

Alphanumeric

Any

All Services

Participants / Participant / TravelAgencyParticipant / IATA_Number

The identifier of the Travel Agent (Travel Management Company) managing the booking for their Corporate Client (identified in the CorporateSender).

Possible identifiers:

  • IATA number (of the IATA accredited entity)

  • TIDs number (recommended if you are not an IATA Accredited entity)

  • Pseudo IATA (assigned by Iberia)

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.

Numeric

8 numbers

All Services

Participants / Participant / TravelAgencyParticipant / AgencyID

Agency ID

Alphanumeric

Any

All Services

<Response / OrderViewProcesing>

Remarks / Remark

Attribute

DisplayInd

Indicating the obligation to show the remark text to the end user/customer.

Boolean

true

All Services

Remarks / Remark

Important information that should be displayed to the end user/customer.

Today used for:

  • The need to present residence documentation at the airport.

  • Refunded quantity

Alphanumeric

Any

All Services

MarketingMessages / MarketMessage / Text

Information message

Alphabetical

Any

All Services

<Response / Order>

Order

Attribute

OrderID

Attribute

Owner

ID for the Order and Airline code

Alphanumeric

Any

All Services

BookingReferences / BookingReference / ID

Order's underlying legacy PNR Record Locator

Alphanumeric

Any

All Services

BookingReferences / BookingReference / AirlineID

ID for the Airline

Alphanumeric

  • IB

All Services

BookingReferences / BookingReference / ID

External reference ID

Alphabetical

XRef

All Services

BookingReferences / BookingReference / OtherID

Attribute

Name

This attribute contains the senders IATA Number

Numeric

7/8 Numbers

All Services

BookingReferences / BookingReference / OtherID

Sender´s external reference

Alphanumeric

Any (String exceeding 30 chars will be truncated)

All Services

OriginalOrder

Attribute

OriginalOrderID

Original order identification

  • This info is displayed in voluntary change flow for some paxes of the initial booking (not all of them) because of two alive orders are generated.

Alphanumeric

Any

Order Change

TotalOrderPrice / DetailCurrencyPrice / Total

Attribute

Code

Total price of the Order with associated currency 

Numeric

Any

All Services

TotalOrderPrice / DetailCurrencyPrice / Taxes / Total

Attribute

Code

Total taxes amount of the Order with associated currency

Numeric

Any

All Services

TotalOrderPrice / SimpleCurrencyPrice

Attribute

Code

Total price of the new order after making a date, hour or cabin change to the initial booking (Penalty is not included in case that it applies)

Numeric

Any

Order Change

Payments / Payment / Type

Code of payment type

Alpha

  • CC

  • CA

  • MS

OrderCreate

OrderChange

Payments / Payment / Amount / SimpleCurrencyPrice

Attribute

Code

Amount of payment method

Code of currency

numeric

3 alpha

Any

OrderCreate

OrderChange

– This refers to Voucher payment method --

Payments / Payment / Method / VoucherMethod / Number

Voucher discount ID

Alphanumeric

Any

OrderCreate

OrderChange

– This refers to Cash payment method --

Payments / Payment / Method / CashMethod

Indicate that payment method is cash

Empty

Empty

OrderCreate

OrderChange

– This refers to Credit Card payment method --

Payments / Payment / PaymentCardMethod / CardType

Type of credit card

2 alpha

VI, CA, AX, DC, etc

OrderCreate

OrderChange

Payments / Payment / PaymentCardMethod / MaskedCardNumber

Masked card number

Alphanumeric

Any

OrderCreate

OrderChange

TimeLimits / PaymentTimeLimit

Attribute

DateTime

Date for payment time limit

Date

Any

Order Create

Order Retrieve

Status

Attribute

ScheduleChangeInd

Displayed only if the order has undergone an involuntary time change

Boolean

true

Order Retrieve

Status / StatusCode

Shows if the order is unserviceable (UNS) or serviceable with involuntary time change

Alphabetical

  • UNS

  • SRV

Order Retrieve

<Response / Order / OrderItems / OrderItem>

OrderItemID

Attribute

OrderItemID

ID for the OrderItem

Alphanumeric

Any

All Services

ItemStatus

Status for the OrderItem in Partial Refunds

  • B (Used/Flown)

Alphabetical

  • B (Used/Flown)

Order Change

PriceDetail / TotalAmount / SimpleCurrencyPrice

Attribute

Code

Total amount of the OrderItem with associated currency

Numeric

Any

All Services

PriceDetail / BaseAmount

Attribute

Code

Base amount of the OrderItem without taxes

Numeric

Any

All Services

PriceDetail / Taxes / Total

Attribute

Code

Total amount of taxes of the OrderItem with associated currency

Numeric

Any

All Services

PriceDetail / Taxes / Breakdown / Tax / Amount

Attribute

Code

Each amount of tax with associated currency

Numeric

Any

All Services

PriceDetail / Taxes / Breakdown / Tax / Nation

Nation for the tax

Alphabetical

Any

All Services

PriceDetail / Taxes / Breakdown / Tax / TaxCode

Code for the tax

Alphanumeric

Any

All Services

PriceDetail / Taxes / Breakdown / Tax / TaxType

Type for the tax

Alphanumeric

Any

All Services

PriceDetail / Taxes / Breakdown / Tax / Description

Description for the tax

Alphanumeric

Any

OrderCreate - No Payment

Service

Attribute

ServiceID

Attribute

ServiceStatus

ID for the flight service and service status key.

Service status will be displayed only for flight services, special needs and ancillaries.

Alphanumeric

Alphabetical

Any

HK - CONFIRMED

UN - CANCELLED

TK - ACCEPT CHANGES PENDING

HN - CONFIRM PENDING

All Services

Service / PassengerRef

Passenger Identifier

Alphanumeric

Any

All Services

Service / SegmentRef

Segment Identifier

Alphanumeric

Any

All Services

Service / ServiceRef

Service Identifier

Alphanumeric

Any

All Services

Service / ServiceDefinitionRef

Attribute

SegmentRef

Service Identifier with associated segment

Alphanumeric

Any

All Services

Service / SelectedSeat / Seat / Row

Row seat

Numeric

Any

All Services

Service / SelectedSeat / Seat / Column

Column seat

Alphabetical

Any

All Services

(plus) TimeLimits

Attribute

PaymentTimeLimit@Timestamp

(plus) Payment Time Limit for Seats and Baggages booked in on Hold flow.

(plus) Alphanuneric

(plus) Date and Time in UTC format, example:

2024-01-24T22:59:00.000Z

(plus) All Services

FareDetail / PassengerRefs

Passenger ID

Alphanumeric

Any

All Services

FareDetail / Price / TotalAmount / SimpleCurrencyPrice

Attribute

Code

Price

Numeric

Any

All Services

FareDetail / Price / BaseAmount

Attribute

Code

Base Price

Numeric

Any

All Services

FareDetail / Price / Taxes / BreakDown / Tax / Amount

Attribute

Code

Tax

Numeric

Any

All Services

FareDetail / Price / Taxes / BreakDown / Tax / Nation

Nation for the tax

Alphabetical

Any

All Services

FareDetail / Price / Taxes / BreakDown / Tax / TaxCode

Tax code

Alphabetical

Any

All Services

FareDetail / Price / Taxes / BreakDown / Tax / TaxType

Type for the tax

Alphanumeric

Any

All Services

FareDetail / Price / Taxes / BreakDown / Tax / Description

Description for the tax

Alphanumeric

Any

OrderCreate - No Payment

FareDetail / FareComponent / FareBasis / FareBasisCode / Code

Code of the fare

Alphanumeric

Any

All Services

FareDetail / FareComponent / FareBasis / RBD

RBD for the fare

Alphabetical

Any

All Services

FareDetail / FareComponent / FareBasis / CabinType / CabinTypeCode

IATA PADIS Cabin code

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

Migrated flows:
OrderCreate

OrderRetrieve

OrderChange Payment (Time Limit Orders)

OrderChange Voluntary Changes (Unpaid Orders)

OrderChange Partial Refund

FareDetail / FareComponent / FareBasis / CabinType / CabinTypeName

Name of the cabin

Alphabetical

Any of the top row

All Services

<FareDetail / FareComponent / FareRules>

  • This section will be displayed only if the order has not been changed outside the NDC channel.

FareDetail / FareComponent / FareRules / Penalty

Attribute

CancelFeeInd

This attribute will indicate whether a cancellation or refund fee will apply.

Boolean

true/false

All Services

FareDetail / FareComponent / FareRules / Penalty

Attribute

ChangeFeeInd

This attribute will indicate whether a fee will be applied for any voluntary changes.

Boolean

true/false

All Services

FareDetail / FareComponent / FareRules / Penalty

Attribute

RefundableInd

This attribute will indicate whether a fare is refundable or not.

Boolean

true/false

All Services

FareDetail / FareComponent / FareRules / Penalty

Attribute

refs

Reference of the penalty rule that applies to the fare.

Alphanumeric

Any

All Services

FareDetail / FareComponent / FareRules / Penalty / Details / Detail

Attribute

refs

References to detail of penalty

  • Example: refs = “RULEMETADATAKEY_1”

Alphanumeric

Any

All Services

FareDetail / FareComponent / FareRules / Penalty / Details / Detail / Type

Type of penalty applied

Alphabetical

  • Cancel

  • Change

All Services

FareDetail / FareComponent / PriceClassRef

Reference to PriceClass (Branded Fare)

  • Example: FLEXIBLEvEURQEtU

  • This section will be displayed only if the order has not been changed outside the NDC channel.

Alphanumeric

Any

All Services

FareDetail / FareComponent / TicketDesig

Ticket designator associated to the order.

Alphanumerical

Some possible examples:

  • CHRC

  • INBP

  • RCF1

  • F1

  • F2

  • TO

All Services

FareDetail / FareComponent / SegmentRefs

Reference to the segment

Alphanumeric

Any

All Services

FareDetail / TourCode

Private fare associated tour code

Alphanumeric

Any

All Services

<Response / TicketDocInfos / TicketDocInfo>

TicketDocument

Attribute

PrimaryDocInd

In case of conjunction tickets, this indicator will be displayed associated to the primary ticket.

Also if conjunction tickets apply, all of them will be displayed inside the same “TicketDocInfo” tag as a list of associated tickets.

Alphabetical

true

All Services

TicketDocument / TicketDocNbr

Number of the ticket

Numeric

Any

All Services

TicketDocument / Type

Type of ticket

Alphabetical

  • T (Ticket)

  • J (Ancillaries EMD)

  • Y (Refund or Penalty EMD)

*Penalty EMD will only be displayed in Order Change, not in Order Retrieve after the change.

  • All Services (Ticket & ancillaries EMDs)

  • Order Change & Order Retrive (Refund EMD)

  • Order Change (Penalty EMD)

TicketDocument / NumberofBooklets

Number of tickets associated in case of conjunction tickets

Numeric

1-4

All Services

TicketDocument / DateOfIssue

Date of ticket issue at local office

Date

yyyy-MM-dd

All Services

TicketDocument / TimeOfIssue

Hour of ticket issue at local office

Hour

HH:mm

All Services

TicketDocument / Remark

Associated remark to ancillaries or seat description

Alphanumeric

Any

Here some examples depending of ancillary type:

  • “2PC” (Baggages)

  • “IB3207-17JUN-BRUMAD” (Priority Boarding)

  • “CHARACTERISTICS/ Q W“ (Seats)

All Services

TicketDocument / CouponInfo / CouponNumber

Order number of the coupon

Numeric

Any

All Services

TicketDocument / CouponInfo / FareBasisCode / Code

Code of the fare

Alphanumeric

Any

All Services

TicketDocument / CouponInfo / CouponValid / EffectiveDatePeriod / Effective

Coupon effective date

Date

yyyy-MM-dd

All Services

TicketDocument / CouponInfo / Status

Status of the coupon

Alphabetical

IATA Padis Codeset - List for data element 4405 (Status, coded)

  • STATUS - Code

  • AIRP.CONTROL - AL

  • OPEN FOR USE - I

  • USED - B

  • REFUNDED - RF

  • VOID - V

  • EXCHANGED - E

  • CHECKED IN - CK

  • BOARDED - BD

  • SUSPENDED - S

  • IRREGULAR OP - IO

  • UNAVAILABLE - NAV

  • CLOSED CLO

All Services

TicketDocument / CouponInfo / DateOfService

Date of service

Date

yyyy-MM-dd

All Services

TicketDocument / CouponInfo / ServiceReferences

Reference to those services included in this coupon (serviceID related)

Alphanumeric

  • FLIGHT_IB260120230223_ADULT_01

  • BAG_SERVICE-IB260120230223-ADULT_01-CA

All Services

TicketDocument / CouponInfo / InConnectionWithInfo

Attribute

AssociateInd

Connection with info

Boolean

  • True

  • False

All Services

TicketDocument / CouponInfo / InConnectionWithInfo / InConnectionDocNbr

Document in connection

Numeric

Numeric

All Services

TicketDocument / CouponInfo / InConnectionWithInfo / InConnectionCpnNbr

Coupon in connection

Numeric

Numeric

All Services

TicketDocument / CouponInfo / ReasonForIssuance / RFIC

Reason for Issuance

Alphabetical

Examples:

  • A (Seat EMDs)

  • C (Baggage & Sport equipment EMDs)

  • D (Penalty & Residual Value EMDs)

  • E (Priority Boarding)

All Services

TicketDocument / CouponInfo / ReasonForIssuance / Code

Type of service code

Alphanumeric

Examples:

  • 0B5 (Seat EMDs)

  • 0GO (Baggage EMDs)

  • 993 (Penalty EMDs)

  • 99I (Residual Value EMDs)

  • 0G6 (Priority Boarding)

  • 0EC (Bike equipment)

  • 0D4 (Golf equipment)

  • 0DD (Ski equipment)

All Services

TicketDocument / CouponInfo / ReasonForIssuance / Description

Service description

Alphabetical

Examples:

  • SEAT ASSIGNMENT

  • BAGGAGE 23 KG

  • SKII-SKI EQUIPMENT

  • PENALTY FEE

  • RESIDUAL VALUE FUTURE TRANS

  • PRIORITY BOARDING

All Services

TicketDocument / CouponInfo / SoldAirlineInfo / DepartureDateTime

Attribute

ShortDate

Attribute

Time

Date and hour of departure

Date

Hour

yyyy-MM-dd

HH:mm

All Services

TicketDocument / CouponInfo / SoldAirlineInfo / Departure / AirportCode

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

3 Alphanumeric

Any

All Services

TicketDocument / CouponInfo / SoldAirlineInfo / Departure / Date

Date of departure

Date

yyyy-MM-dd

All Services

TicketDocument / CouponInfo / SoldAirlineInfo / Departure / Time

Hour of departure

Hour

HH:mm

All Services

TicketDocument / CouponInfo / SoldAirlineInfo / Arrival / AirportCode

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

3 Alphanumeric

Any

All Services

TicketDocument / CouponInfo / SoldAirlineInfo / MarketingCarrier / AirlineID

ID of the airline that markets the flight

Alphabetical

Any

All Services

TicketDocument / CouponInfo / SoldAirlineInfo / MarketingCarrier / FlightNumber

Number of the airline that markets the flight

Numeric

Any

All Services

TicketDocument / CouponInfo / SoldAirlineInfo / Status

Status of the coupon

Alphabetical

Any

All Services

TicketDocument / CouponInfo / AddlBaggageInfo / AllowableBag

Attribute

Number

Number of checked baggages allowed in fare

Numeric

Any

All Services

TicketDocument / ReportingType

The way in which this sale has been reconciled, for billing and settlement purposes.

Alphabetical

  • Airline

  • BSP

  • ARC

All Services

TicketDocument / Price / Total

Attribute

Code

Currency and  total price of the document

Alphanumeric

Any

All Services

OriginalIssueInfo / IssuingAgentID

NDC Iata number associated to the orginal ticket.

Numeric

Any

All Services

OriginalIssueInfo / DateOfIssue

Issuance date of the original ticket.

Date

Any

All Services

OriginalIssueInfo / LocationCode

Location of the original ticket.

Alphabetical

Any

All Services

OriginalIssueInfo / TicketDocumentNbr

Number of the original ticket.

Numeric

Any

All Services

PassengerReference

Ticket/EMD Passenger Reference

Alphanumeric

Any

All Services

<Response / Commission> (Only if Sender is Real IATA)

Percentage

Percentage of the commision

Numeric

Any

All Services

Amount

Amount of the commision

Numeric

Any

All Services

<Response / DataLists / PassengerList / Passenger>

Passenger

Attribute

PassengerID

Passenger Identifier

PassengerID attribute value can be indicated in PassengerID attribute from AirShopping request.

Alphanumeric

Alphanumeric

Any

Value indicated in PassengerID attribute from AirShopping request

All Services

PTC

Attribute Passenger Type Code

PaxType (3 Alphabetical)

Passenger Type Codes

All Services

Birthdate

Birthdate of the passenger

Date

Date depends of the PTC

All Services

Individual / Gender

Gender of the passenger

Alphabetical

  • Male

  • Female

All Services

Individual / NameTitle

Title of the passenger

Alphabetical

  • MR

  • MRS

  • MS

  • MSS

All Services

Individual / GivenName

Name of the passenger

Alphabetical

Any

All Services

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)

Alphabetical

Any

All Services

Individual / SurnameSuffix

Passenger suffix

Alphabetical

Any

All Services

LoyaltyProgramAccount / Airline / AirlineDesignator

Frequent Flyer Airline ID

2 Alphanumeric

Any

All Services

LoyaltyProgramAccount / AccountNumber

Frequent Flyer number

On Business number

Alphanumeric

Alphanumeric

Any

Any

All Services

FOID / FOID_Number

Number for the document

Alphanumeric

Any

All Services

FOID / FOID_Type

Type of the passenger ID Info

2 Alphanumeric

  • NI

  • PP

All Services

InfantRef

Indicates the infant in lap associated to this adult.

If this tag is not indicated, the infant in lap is associated to the first adult in the Order by Iberia

Alphanumeric

Any

Highly recommended to ensure infant in lap is with correct adult.

IdentityDocument / IdentityDocumentNumber

Number of identity document

Numeric

Any

All Services

IdentityDocument / IdentityDocumentType

Type of document

Alphanumeric

Any

  • F1 (Other Documents, Resident Discount)

  • AI (Additional information, Large Family Discount)

  • F (FiscalId. In case of sending it for the INF, it will be ignored)

All Services

ContactInfoRef

Reference of passenger's contact info

Alphanumeric

Any

All Services

Remark / Remark

  • Type of discount and city/autonomous community code for passenger

  • Verified or not verified resident discount for passenger

Alphanumeric

Any

All Services

<Response / DataLists / ContactList>

ContactInformation

Attribute

ContactID

Id of the contact information

Alphanumeric

Any

All Services

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

Alphabetical

  • itin_only (omits the pricing

  • itin_and_price (which is the default value)

  • not_send_mail

All Services

ContactInformation / ContactProvided / EmailAddress / EmailAddressValue

Email address of the contact

Alphanumeric

Any

All Services

ContactInformation / ContactProvided / Phone / Label

Label that was used in the OrderCreate to identify the purpose for the number.

  • Passenger

  • Emergency

Alphabetical

Any

Order Create

ContactInformation / ContactProvided / Phone / CountryDialingCode

Country Code associated to phone number if it is filled

Alphanumeric

Ej: (+34)

All Services

ContactInformation / ContactProvided / Phone / PhoneNumber

Phone number of the contact

Numeric

Any

All Services

ContactInformation / Individual / Gender

Gender of the passenger

Alphabetical

  • Male

  • Female

All Services

ContactInformation / Individual / Surname

Concatenated Name and Surname of emergency contact

Alphabetical

Any

All Services

<Response / DataLists / BaggageAllowanceList>

  • This section will be displayed only if the order has not been changed outside the NDC channel.

BaggageAllowance

Attribute

BaggageAllowanceID

Id for the Baggage

Alphanumeric

Any

All Services

BaggageAllowance / BaggageCategory

Identifier

  • Example: "CarryOn" or "Checked"

Alphabetical

Any

All Services

BaggageAllowance / PieceAllowance

Attribute

refs

References to media list.

  • Example: refs="Media-CarryOn-Baggage"

Alphanumeric

  • "Media-CarryOn-Baggage"

  • "Media-Checked-Baggage"

All Services

BaggageAllowance / PieceAllowance / ApplicableParty

Text "Traveler" (Identifier for all conditions)

Alphabetical

“Traveler”

All Services

BaggageAllowance / PieceAllowance / TotalQuantity

Quantity allowed

Numeric

Any

All Services

BaggageAllowance / PieceAllowance / BagType

Type of bag allowed

Alphabetical

Any

All Services

BaggageAllowance / PieceAllowance / Descriptions / Description / Text

Associated quantity text

Alphanumeric

Any

All Services

BaggageAllowance / Piece Allowance / PieceMeasurements

Attribute

Quantity

Quantity of piece measurements

NOT USED BY IBERIA today. Included due to mandatory in Schema.

PLEASE IGNORE and use BaggageAllowance / PieceAllowance / TotalQuantity

Numeric

Any

All Services

<Response / DataLists / DescriptionList>

Description

Attribute

ObjectKey

Type of private fare

Alphabetical

Requested product in AirShopping

All Services

Description / Text

Description of private fare

Alphabetical

Requested product in AirShopping

All Services

<Response / DataLists / FareList>

FareGroup

Attribute

refs

Attribute

ListKey

Reference of the fare

Reference of the fare basis code

Alphabetical

Alphabetical

Any

Any

All Services

FareGroup / Fare / FareCode

Code for the fare

Alphanumeric

IATA PADIS Code: 

  • 70J - Public fares

  • 758 - Private Fares

  • 70M - Corporate Private Fares

All Services

FareGroup / FareBasisCode / Code

Code for the fare basis

Alphabetical

Any

All Services

<Response / DataLists / FlightSegmentList / FlightSegment>

FlightSegment

Attribute

SegmentKey

Attribute

SecureFlight

ID of the segment

SecureFlight = true (If it is a secure flight)

Alphanumeric

Any

All Services

Departure / AirportCode

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

3 Alphanumeric

Any

All Services

Departure / Date

Date of departure

Date

yyyy-MM-dd

All Services

Departure / Time

Time of departure

Hour

HH:mm

All Services

Departure / AirportName

Name of the departure city/airport/station

Alphanumeric

Any

All Services

Departure / Terminal / Name

Name of the departure terminal at city/airport/station

Alphanumeric

Any

All Services

Arrival / AirportCode

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

3 Alphanumeric

Any

All Services

Arrival / Date

Date of departure

Date

yyyy-MM-dd

All Services

Arrival / Time

Time of arrival

Hour

HH:mm

All Services

Arrival / ChangeOfDay

Change of day between departure and arrival

1 Numeric

Any

All Services

Arrival / AirportName

Name of the arrival city/airport/station

Alphanumeric

Any

All Services

Arrival / Terminal / Name

Name of the arrival terminal at city/airport/station

Alphanumeric

Any

All Services

MarketingCarrier / AirlineID

ID of the airline that markets the flight

Alphabetical

Any

All Services

MarketingCarrier / Name

Name of the airline that markets the flight

Alphanumeric

Any

All Services

MarketingCarrier / FlightNumber

Number of the flight

Numeric

Any

All Services

OperatingCarrier / AirlineID

ID of the airline that operates the flight

Alphabetical

Any

All Services

OperatingCarrier / Name

Name of the airline that operates the flight

Alphanumeric

Any

All Services

OperatingCarrier / FlightNumber

Number of the flight

Numeric

Any

All Services

OperatingCarrier / Disclosures / Description / Text

Description of the airline

Alphanumeric

Any

All Services

Equipment / AircraftCode

Code of the aircraft that operates the flight

Alphanumeric

Any

All Services

Equipment / Name

Name of the aircraft that operates the flight

Alphanumeric

Any

All Services

FlightDetail / FlightDuration / Value

Duration of the flight

Alphanumeric

Any

All Services

<Response / DataLists / FlightDetail / Stops>

StopQuantity

Number of technical stops

Numeric

>= 0

StopQuantity

StopLocations

List of the technical stops

List

Any

StopLocations

<Response / DataLists / FlightDetail / Stops / StopLocations / StopLocations>

AirportCode

Code of the airport

Alphanumeric

Any

AirportCode

Name

Name of the airport

Alphanumeric

Any

Name

ArrivalDate

Arrival date

Date

yyyy-MM-dd

ArrivalDate

ArrivalTime

Arrival time

Time

hh:mm

ArrivalTime

DepartureDate

Departure date

Date

yyyy-MM-dd

DepartureDate

DepartureTime

Departure time

Time

hh:mm

DepartureTime

GroundTime

Duration of the stop

Alphanumeric

ISO 8601 duration format (EX: PT2H40M)

GroundTime

<Response / DataLists / FlightList>

Flight

Attribute

FlightKey

ID of the flight

Alphanumeric

Any

All Services

Journey / Time

Duration of the flight

Alphanumeric

Any

All Services

SegmentReferences

References for the segment

Alphanumeric

Any

All Services

<Response / DataLists / OriginDestinationList>

OriginDestination

Attribute

OriginDestinationKey

ID of the origin-destination

OriginDestinationKey attribute value can be indicated in OriginDestinationKey attribute from AirShopping request. If this value is not indicated, it will be auto-generated with the default format.

Alphanumeric

Default format: ODX (X → Number digit)

Any (Default format example: OD1)

All Services

DepartureCode

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

3 Alphanumeric

Any

All Services

ArrivalCode

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

3 Alphanumeric

Any

All Services

FlightReferences

References for the flight

Alphanumeric

Any

All Services

<DataLists / InstructionsList / Instruction>

Instruction

Attribute

ListKey

Id for the instruction to sports equipment.

 

Alphanumeric

 

Any

 

All Services

FreeFormTextInstruction

Attribute

refs

Reference for passenger and segments associated to sports equipment

Alphanumeric

PassengerID and SegmentID

Valid example: “ADULT_01 IB303420231016“

All Services

FreeFormTextInstruction / Remark

Sports equipment code

Sport equipment status will be displayed at the end of the remark, with 2 characters separated by a slash. For example: “BAGGAGE/SP/0EC/NN“

Alphanumeric

Any

Valid examples:

  • BIKE: “BAGGAGE/SP/0EC/NN”

  • SKII: “BAGGAGE/SP/0DD/NN”

  • GOLF: “BAGGAGE/SP/0D4/NN”

  • SURF: “BAGGAGE/SP/0D8/NN”

  • SCUB: “BAGGAGE/SP/0EE/NN”

  • FISH: “BAGGAGE/SP/0D6/NN”

All Services

<Response / DataLists / MediaList>

Media

Attribute

ListKey

ID of the Media Item

Alphanumeric

Any

All Services

Media / MediaLink

Http link referring to the Media Item

Alphanumeric

Any

All Services

<Respone / DataLists / PenaltyList / Penalty>

  • This section will be displayed only if the order has not been changed outside the NDC channel.

Penalty

Attribute

ObjectKey

Id for the penalty

Alphanumeric

Any

All Services

Details / Detail / Type

Type of action associated to he penalty like Cancel, Change...

Alphabetical

Any

e.g.: Cancel, Change

All Services

Details / Detail / Application

Associated Code to action refered above like Change, Cancel

FAT Fare or application penalty type
1 No show
2 Prior to departure
3 After departure

Numeric

Any

All Services

Details / Detail / Amounts / Amount / CurrencyAmountValue

Attribute

Code

Amount and currency for the penalty

Alphanumeric

Any

All Services

Details / Detail / Amounts / Amount / AmountApplication

Identifies minimum and maximun penalty amount

Alphabetical

minPrice

maxPrice

All Services

<Response / DataLists / PriceClassList / PriceClass>

  • This section will be displayed only if the order has not been changed outside the NDC channel.

PriceClass

Attribute

PriceClassID

Price Class identificator key:

  • Branded Fare example → BUSFLEXp8eGI8Gt

Alphanumeric

Any

All Services

Name

Identification name of the price class

Alphanumeric

Any

All Services

Code

Code of the price class.

Alphanumeric

Any

All Services

Descriptions / Description

Attribute

ObjectKey

Identification of the description of the condition:

  • Branded Fare example → CFFIB210210BUSFLEX050

Alphanumeric

Any

All Services

Descriptions / Description / Text

Descriptive text about the condition to apply:

  • Branded Fare example → BF/SE/050/BS//STANDARD SEAT SELECTION/FREE

Alphanumeric

Any

All Services

<Response / DataLists / ServiceDefinitionList>

ServiceDefinition

Attribute

ServiceDefinitionID

ID reference of the service

Alphabetical

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

All Services

ServiceDefinition / Name

Name of the service

Alphanumeric

Any

All Services

ServiceDefinition/Encoding/RFIC

RFIC of booked ancillaries

Alphabetical

Any (e.g.: A, C)

All Services

ServiceDefinition/Encoding/Subcode

SubCode (RFISC) of booked ancillaries

Alphanumeric

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

All Services

ServiceDefinition / BaggageAllowanceRef

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

Alphanumeric

Any

All Services

ServiceDefinition / Descriptions / Description

Attribute

refs

Passenger identification associated to the service

Alphanumeric

Any

All Services

ServiceDefinition/Descriptions / Description / Text

For Ancillaries this is a descriptive text regarding the service booked, as explained in Ancillaries

For Special Services, this is the additional information included when booking the service, as explained in Special Service Request (SSR)

Alphanumeric

Any

All Services

ServiceDefinition/BookingInstructions / Method

Method. Always value= SSR

Alphabetical

SSR

All Services

ServiceDefinition / BookingInstructions / SSRCode

Service identification code as explained in Ancillaries and Special Services

Alphabetical

Any (e.g.: DPNA)

All Services

ServiceDefinition / Detail / ServiceItemQuantityRules / MaximumQuantity

Maximum quantity of service

Numeric

Any

All Services

<Response / Metadata / Other / OtherMetadata / CurrencyMetadatas>

CurrencyMetadata

Attribute

MetadataKey

ID of the Metadata

Alphanumeric

Any

All Services

CurrencyMetada / Decimals

Number of decimals

Numeric

Any

All Services

<Response / Metadata / Other / OtherMetadata / PaymentFormMetadatas>

PaymentFormMetadata

Attribute

MetadataKey

ID of the Metadata

Alphanumeric

Any

Order Create and OrderChange payment (installments payment)

PaymentFormMetadata / Text

Installments payment info

Alphanumeric

installments/n/X.XX

where n=number of installments.

where X.XX=interests rate in %

Valid example: installments/3/0.00

Order Create and OrderChange payment (installments payment)

<Response / Metadata / Other / OtherMetadata / RuleMetadatas>

RuleMetadata

Attribute

MetadataKey

ID of the Metadata

Alphanumeric

Any

All Services

RuleMetadata / RuleID

ID of the Metadata

Alphanumeric

  • Cancel

  • Change

All Services

RuleMetadata / RuleID / Values / Value / Instruction

This indicator will display either of the following:

  • "Allowed" → This fare is refundable and/or changeable

  • "Not Allowed" → This fare is not be refundable and/or changeable

Alphabetical

  • Allowed

  • Not Allowed

All Services

  • No labels