ndc-jaxb.0.1.4.source-code.edist_commontypes.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ndc-jaxb Show documentation
Show all versions of ndc-jaxb Show documentation
JAXB generated classes for NDC Client
The newest version!
EDIST XML SPECIFICATION: Common XML Objects shared by all EDIST Domains.
Address representation choice.
Core Address Information.
CORE ADDRESS representation.
Address.
Detailed Address Information.
DETAIL ADDRESS representation.
Specifies directions to a given address (I.e. to service fulfilment address, if other than an airport)
PAYMENT ADDRESS.
PAYMENT ADDRESS representation.
Note: This a "relaxed cardinality" representation of Structured Address to support various combinations of Address Verification fields.
Street. Examples: Main Street, 100 Main Street
Post office box. Example: P.O. Box 21
Building name, room, apartment, or suite number.
City name. Example: Tampa
State or province code or name. Examples: NY, New York
Postal code. Examples: 11001, 11001-2345
Country name or code.
Examples: US, United States
Encoding Scheme: ISO 3166-1 (two character) Country Code
SIMPLE (non-structured) ADDRESS.
SIMPLE ADDRESS representation.
Address line text.
Example:
100 Main Street
New York, NY 10100
STRUCTURED ADDRESS.
STRUCTURED ADDRESS representation.
AddressAtOrigin or AddressAtDestination
Street. Examples: Main Street, 100 Main Street
Building name, room, apartment, or suite number.
Post office box. Example: P.O. Box 21
City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
State or province code. Examples: NY, QUE
Postal code. Examples: 11001, 11001-2345
County that the address is located in. Example: Litchfield
Core Air Pass information.
Detail Air Pass information.
AIR PASS CORE representation.
Air Pass Program issuing airline designator code. Example: BA
Encoding Scheme: IATA/ A4A (two to three character) Airline Designator Code
Airr Pass Certificate information.
Unique certificate number. Example: 12345678
Certificate Application. Example: Redemption
Certificate Effective/ Expiration Period.
AIR PASS DETAIL representation.
Program Name. Example: PASSPRO
Program Code. Example: PP01
Agency or Corporate Certificate holder or program owner information.
Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory . Example: TPA
S5 Record Attributes information.
S5 record attributes definition.
ENCODING: Note, Attributes on the Services Record S5 that can be used as filter criteria for a service.
Service group information.
Service Group code.
BD (BUNDLED SERVICE)
BG (BAGGAGE)
IE (IN-FLIGHT ENTERTAINMENT)
LG (LOUNGE)
Service group description.
Example: BAGGAGE OPTIONS
Service subgroup information.
Service Sub-Group Code(s).
Group BG: CT (Container), PP (Pre-Paid Excess Baggage)
Group IE: IT (Internet Access), TV (Television)
ENCODING: Note, Standard Group and Sub Group on the Services Record S5 that can be used as filter criteria for a service.
Service subgroup description.
Example: CARRY ON HAND BAGGAGE
Description 1 codes.
ENCODING: Note, standard Description codes (or text translation for these codes) on the Optional Services Record S5.
Description code.
Example: 05 (UP TO 5 KG)
=sample values=
05 = up to 5 kg
1Y = One Year
AI = Aisle
B1 = First Bag
Description code text.
Example: UP TO 5 KG
Description 2 codes.
ENCODING: Note, standard Description codes (or text translation for these codes) on the Optional Services Record S5.
Description code.
Example: HT (HOT)
Description code text.
Example: HOT
record S5 diagnostic definition.
Unique ID. Example 6
Record S7 diagnostic definition.
Unique ID. Example: 6
Table sequence number. Example: 3
ID of the first occurrence of an excess bag. Example: 4
ID of the last occurrence of an excess bag. Example: 6
Carry-on and checked baggage allowances.
The allowable baggage types and max number.
The permitted baggage types by RFISC for the applicable baggage allowance.
The maximum numberof this baggage type.
The charge amount for different baggage types
The baggage charge type by RFISC for the applicable baggage charge.
The baggage charge amount which is applied to the 1st and 2nd checked bag.
The currency code for payment of a baggage charge. Use ISO 4217, three alpha code.
The determining carrier code and the max number for each type of carry-on allowable baggage.
The determining carrier code of the carry-on allowance baggage type.
The permitted baggage type by RFISC for the carry-on baggage allowance.
The maximum number of each allowable baggage type.
The carry on chargeable baggage information.
Specifies the embargo information.
The embargo information
The permitted baggage type by RFISC for the carry-on baggage allowance.
The baggage charge amount which is applied to the 1st and 2nd checked bag.
The currency code for payment of a baggage charge. Use ISO 4217, three alpha code.
The maximum linear dimensions of the baqggage follwed by centimeters 'C' or inches 'I'.
The maximum baggage weight followed by kilos 'K' or pounds 'L'.
The maximum bag dimensions and weight for free carry on baggage.
The maximum linear dimensions of the baqggage follwed by centimeters 'C' or inches 'I'.
The maximum baggage weight followed by kilos 'K' or pounds 'L'.
The maximum bag dimensions and weight for free checked baggage.
The maximum linear dimensions of the baqggage follwed by centimeters 'C' or inches 'I'.
The maximum baggage weight followed by kilos 'K' or pounds 'L'.
The checked chargeable baggage information.
Specifies the embargo information.
The embargo information
The permitted baggage type by RFISC for the checked baggage allowance.
The baggage charge amount which is applied to the 1st and 2nd checked bag.
The currency code for payment of a baggage charge. Use ISO 4217, three alpha code.
The maximum linear dimensions of the baqggage follwed by centimeters 'C' or inches 'I'.
The maximum baggage weight followed by kilos 'K' or pounds 'L'.
The maximum linear dimensions of the baqggage follwed by centimeters 'C' or inches 'I'.
A data type for Baggage Allowance by Description.
Baggage weight restriction application. Examples: Party, Traveler
Note: Party applies to all Travelers.
Applicable bag type.
Examples: Carry-On, 1st Checked Bag, 2nd Checked Bag
A data type for Baggage Allowance by Dimensions.
Baggage weight restriction application. Examples: Party, Traveler
Note: Party applies to all Travelers.
Baggage dimension UOM (unit of measure). Example: Centimeter, Inch
A choice between specifying baggage dimensions as:
- Total linear dimensions
- Individual length, height and/ or width
Maximum linear dimensions value. Example: 62
Notes:
1. Linear measurement = length + width + height
2. Size unit of measure is specified in BagUOM.
Minimum linear dimensions value. Example: 20
Notes:
1. Linear measurement = length + width + height
2. Size unit of measure is specified in BagUOM.
Maximum baggage dimension category and value.
Notes: Baggage Size UOM (unit of measure) is specified in BagUOM.
Baggage dimensions category.
Examples: Length, Height, Width
Maximum dimension value. Example: 30
Minimum dimension value. Example: 10
Applicable bag type.
Examples: Carry-On, 1st Checked Bag, 2nd Checked Bag
A data type for Baggage Allowance by Piece.
Baggage weight restriction application. Examples: Party, Traveler
Note: Party applies to all Travelers.
Maximum pieces.
Example: 4
Type of Bag,.
Example: Golf Equipment, Bag, Fishing, Car Seat
Applicable bag type.
Examples: Carry-On, 1st Checked Bag, 2nd Checked Bag
Provides information on per piece weight and dimensions.
BAGGAGE WEIGHT allowance per baggage piece.
BAGGAGE DIMENSION allowance per baggage piece.
Quantity of pieces with these measurements.
Provides logical combiinaton between allowances pieces. Enumaration with OR and AND as posisble values.
A data type for Baggage Allowance by Weight.
Baggage weight restriction application. Examples: Party, Traveler
Note: Party applies to all Travelers.
Maximum weight value and unit of measure.
Maximum weight value. Example: 50
Baggage weight unit of measure. Example: Kilogram, Pound
Applicable bag type.
Examples: Carry-On, 1st Checked Bag, 2nd Checked Bag
A data type for US Department of Transportation (DOT) Reservation or Disclosure baggage rule.
Select a value from the enumerated list or enter a string value.
=enumerated values=
N = NOT SUBJECT TO US DOT RESERVATION OR DISCLOSURE
Y = SUBJECT TO US DOT RESERVATION AND DISCLOSURE
D = SUBJECT TO DISCLOSURE BUT NOT TO US DOT RESERVATION
US Department of Transportation (DOT) Reservation or Disclosure baggage rule.
Examples: Y, Disclosure AND US DOT Reservation
DESCRIPTION of Allowance with application information.
CARRY-ON ALLOWANCE definition.
Carry-On Allowance detail.
Defines the maximum number of each allowable baggage type.
Carry-on Allowance.
CHECKED BAG ALLOWANCE defiition.
Checked Bag Allowance detail.
Defines the maximum number of each allowable baggage type.
Checked Baggage Allowance.
BAGGAGE DIMENSION Allowance with application information.
Defines the maximum number of each allowable baggage type.
BAGGAGE WEIGHT Allowance iwith application nformation.
Booking Reference information to include Record Locator, Assigning Airling Identifier, etc.
Booking Reference information to include Record Locator, Assigning Airling Identifier, etc.
Booking Reference detail.
Booking Reference definition.
Booking Reference Type. Example: 6 (Passenger confirmation number) Encoding Scheme: IATA Padis Codeset - List for data element [1153] Reference Qualifier
Existing Booking Reference ID. Example: R1A3SK
A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory.
Name. Example: British Airways
Other Assigning Entity ID. Example: UID12345 Note: Entity Name may be specified in the @Name property.
Object association(s) between this object and any other object or metadata instance(s).
Object Metadata Association(s). Example: meta1 meta3
Entity Name.
Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory .
Example: TPA
Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory .
Example: TPA
City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
PADIS/ THIRD-PARTY CODESET definition.
NDC Capability Model: CODESET
============
Representation(s)
============
• IATA PADIS Encoding
• Third-Pary Standard Encoding
• Implementer-Proprietary Encoding
============
Feature(s)
============
• Code value, code definition and code table name may be specified
• URI to codeset information source may be specified
• Supports Language Localization (Alternate Language Values)
• Codeset Source Details (owner, location, etc.) may be specified
============
Metadata
============
• Yes
Code value. Example: 003
Code Definition. Example: Travel Agency
Code set table name.
Codeset location uri. Example: http://anysite.com/codeset
Address Contact.
ADDRESS CONTACT definition.
Contact(s).
Contact detail.
Email address details, including application (I.e. home, business, etc.).
Passenger Name information.
Note: Detailed Name information, such as prefix, title and suffix, are specified in PassengerMetadata.
Family name, last name
Example: SMITH
Given name, first name or names
Name Title. Examples: MR, MRS, DR
Surname Suffixes and / or Letters, Examples:Jr., Sr., III., Ret., Esq., Ph.D., M.D.
Middle name or initial. Examples: G, GEORGE
Type of contact. For e.g. Primary or Emergency contact.
CONTACT CORE definition.
EMAIL ADDRESS helper object.
Email address application. Examples: Personal, Business, SMS
The traveler email address for contact.
Email address details, including application (I.e. home, business, etc.).
Email Address. Example: [email protected]
Email Address representation.
Phone Contact.
Provides telephone information, and allows to specify telephone number application (ie Home, Business, etc.). May be used for a simle, unstrucutured number, or, in combination with child attributes allows to create a structured telephone number (ie Country Code number, Area Code numbers, etc.)
PHONE CONTACT definition.
PHONE NUMBER helper object.
Phone number application. Examples: Billing, Business, Home, Mobile
Phone number text.
Examples:
+01 999-999-9999 ext 1234,
617-9976
Note: This may be a simple, un-structured phone number, such as +01 999-999-9999 ext 1234 or combined with child attributes to create a structured phone number.
Phone number country code. Examples: 1, 01, +1
Phone number area code. Example: 813
Phone extension number. Examples: 1234, ext 1234
Other Contact Method.
OTHER CONTACT METHOD definition.
Contact method name. Example: Marketing Website
Method value. Example: www.marketingsite.com
Named contact group. Example: John Smith Business
Commission information.
A data type for Core Commission.
Choice between specifying
amount value or percentage.
Commission amount. Example: 20.00 USD
Commission percentage. Example: 20
Commission code. Example: 1000, BFST
Country Code. Examples: US, FR
Encoding Scheme: ISO 3166-1 (two character) Country Code
COUNTRY CODE representation.
Notes:
1. Examples: US, FR
2. Encoding Scheme: ISO 3166-1 (two character) Country Code
COUNTRY RADIUS QUERY definition.
Country Code(s).
Country Code. Examples: US, FR
Encoding Scheme: ISO 3166-1 (two character) Country Code
Keyword/ Value Search Criteria.
Notes: This capability may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. If supported, the technical implementation of this capability is not dictated by this specification.
COUNTRY PROXIMITY representation.
Notes: This contains either the requested maximum distance search radius values -or- the actual Proximity information, which is typically used to specify the results from the named location radius search.
COUNTRY PROXIMITY representation.
Notes:
1. This contains either the requested maximum distance search radius values -or- the actual Proximity information, which is typically used to specify the results from the named location radius search.
Country Code. Examples: US, FR
Encoding Scheme: ISO 3166-1 (two character) Country Code
Currency amount. Example: 10000, 100.00, 100
Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
A globally unique identifier for this object instance.
Association(s) between this object and any metadata instance(s).
Object association(s) between this object and any object instance(s).
Currency code Application.
Examples: Actual, Display, Requested, Conversion, Other
A data type for ISO Currency Code.
Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
A data type for Currency Amount with Mandatory Currency Encoding.
AMOUNT with OPTIONAL CURRENCY ENCODING representation.
In some markets, commission is VAT-able (ie Taxable)
Monetary value amount and currency code.
ISO Currency Code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
Requested search processing and results currency information.
Notes:
1. This is not the point of sale currency that is specified in the PointOfSale node.
2. This element repeats to allow multiple search result currencies to be specified using a currency code and currency role combination.
ISO Currency Code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
Description(s).
Description detail.
Association to Description element in DataList. Example: DE1 DE2
DESCRIPTION definition.
NDC Capability Model: Descriptions
REPRESENTATIONS
============
• Source URL
• Plain Text
• Marked-Up Text
• Rich Media Object ID and/ or URL to Source (e.g. images and streaming video)
============
====
Feature(s)
a) Rendering Instructions, for converting an attachment into a specified display format, may be included with Media Attachments.
3. Metadata: Yes
2. Rendering Instructions, for converting an attachment into a specified display format, may be included with Media Attachments.
3. These capabilities may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. If supported, the technical implementation of this capability is not dictated by this specification.
Description value.
Mark-up Style. Example: HTML
LINK to Description information source.
Description-associated Media Object(s).
Description-associated MEDIA OBJECT ID or Key. Example: IMG1
Description-associated MEDIA LINK.
Description-associated Media Attachment ID. Example: ATT1.
Media Object Unique ID or Key. Example: DESC1
UNIQUE MEDIA ID representation.
Unique Media ID. Example: IMG215
Media Link (to media source.)
Media Attachment.
MEDIA ATTACHMENT representation.
Attachment Uniform Resource Identifier (URI).
Attachment Description.
Attachment Encoding Method. Example: BASE64
The size of the Attachment in kilobytes. Example: 60
Rendered Media Instructions.
A data type for a set of rendering instructions for converting XML data in a designated element into a specified display format or instructions to display a pre-rendered version of the data.
Rendering Method. Example: Narrative, XSLT, Other
An identifier for a file format or content type of the rendered output.
Rendering Attachment URI, e.g. for a stylesheet.
Attachment Size Value. Example: 57KB
Rendering Instruction Parameters.
Notes: This is typically used for XSLT.
An overview of the rendering method or style.
A data type for a Rendering Parameter, typically for XSLT.
Rendering Instruction Parameter detail.
Rendering Parameter Name.
Rendering Parameter Value.
Directions.
Directions detail.
DIRECTIONS definition.
NDC Capability Model: Directions
1. Representation(s): URL to source; Plain Text
2. Association(s): Airport, City, x, x and y
3. Feature(s): From/To Context; Named Collection
3. Metadata: Yes
Text-based Directions.
Directions source URL.
Directions name. Example: Directions to Headquarters
Directions from location. Example: City Center
Directions to location. Example: Headquarters
Disclosure(s).
Disclosure(s).
Plain Text or Rich Media Disclosure Description(s).
Discount monetary value amount and currency value.
Discount percentage value.
DISCOUNT core representation.
NDC Capability: Discount
1. Discount amount value may be represented as a fixed amount or a percentage.
2. Contextual discount application (e.g. category) may be specified.
3. Metadata may be defined.
Discount Application. Example: BAG
Discount Description.
CORE FQTV Program Information.
SUMMARY FQTV Program Information.
DETAIL FQTV Program Information, including Alliance information.
FQTV Program Alliance Information.
Unique FQTV Program Code or ID. Example: MAM
A data type for FQTV Program ID.
A data type for Core Frequent Traveler Program.
Non airline loyalty information eg Avios.
Object association(s) between this object and any object or metadata instance(s).
Object Metadata Association(s). Example: meta1 meta3
Traveler FQTV Account information.
Traveler FQTV program sign in (or user) ID.
FQTV account number.
Example: FQTV123456
Program Tier
Tier Program name
Tier Program code
Tier Program priority
A data type for Summary Frequent Traveler Program.
FQTV Program information URL. Example: https://www.britishairways.com/en-gb/executive-club/about-the-club
Program Name. Example: Miles and More
A data type for Detail Frequent Traveler Program.
FQTV Program Alliances(s).
FQTV Alliance detail.
Traveler Frequent Flyer (FQTV) Account Information.
Traveler FQTV ACCOUNT definition.
FQTV Program Sponsoring Airline. Example: BA
Encoding Scheme: IATA/ A4A (two or three character) Airline Designator Code
Traveler FQTV Account information.
Traveler FQTV program sign in (or user) ID.
FQTV account number.
Example: FQTV123456
The Program ID will be used to specify Frequent Flyer Program. This will be the name of the program
FQTV PROGRAM ALLIANCE representation.
Used to specify the alliance CodeSet. Refer to IATA PADIS Code List for data element 9906. Used in conjunction with Name (Alliance Name) and Participants (Alliance Particiaption information)
Alliance information URL.
Example: http://www.oneworld.com/home
Alliance name. Example: One World Alliance
"Alliance Participation information. Used in conjunction with Code (Unique Alliance code or ID-OWA
and Name (Alliance Name-One World Alliance)."
Participant detail.
Identifies a particular Airline participant in an Alliance in view of an FQTV program details.
Identifies a particular affiliated FQTV program in an Alliance in view of an FQTV program details.
FQTV ALLIANCE- AIRLINE PARTICIPANTS representation.
A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory
Airline-sponsored FQTV Program name. Example: Miles and More
FQTV ALLIANCE- PROGRAM PARTICIPANTS representation.
Airline-sponsored FQTV Program name. Example: Miles and More
A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory
Identifies a particular affiliated FQTV program in an Alliance in view of an FQTV program details.
Identifies a particular Airline participant in an Alliance in view of an FQTV program details.
Instant purchase type.
Examples:
CC (Ticketless purchase immediately charged to credit card)
NO (Not an instant purchase)
TT (Simultaneous with time of ticketing)
Encoding scheme: IATA PADIS Codeset IPT - Instant Purchase Type
Instant Purchase Type definition.
Keyword/ Value Pair Detail.
KEYWORD/ VALUE PAIR object.
Key Word. Example: SKYC
Key-Word Value(s). Example: SkyCouch
Language code. Example: en, en-US
Encoding Schemes: ISO 639-1 Code OR Microsoft National Language Support (NLS) Code
Notes:
1. Supports ISO 639-1 (two alpha character) neutral language encoding indicated by a name such as "en" for English.
2. Supports MNLS geographically specific language encoding indicated by a name that includes both locale and country/region information. For example, the locale English (United States) has the language name "en-US".
Language(s).
Language Code representation.
Notes:
1. Language code. Example: en, en-US
2. Encoding Schemes: ISO 639-1 Code OR Microsoft National Language Support (NLS) Code
3. Supports ISO 639-1 (two alpha character) neutral language encoding indicated by a name such as "en" for English.
4. Supports MNLS geographically specific language encoding indicated by a name that includes both locale and country/region information. For example, the locale English (United States) has the language name "en-US".
NDC Capability Model: LANGUAGE ENCODING
============
Representation(s)
============
• ISO 639-1 encoding
• Microsoft MNLS geographically specific language encoding
============
Feature(s)
============
• Supports ISO 639-1 (two alpha character) neutral language encoding indicated by a name such as "en" for English.
• Supports MNLS geographically specific language encoding indicated by a name that includes both locale and country/region information. For example, the locale English (United States) has the language name "en-US".
• Language application (e.g. usage context) may be specified (Display, Requested, Spoken, Written, etc.)
============
Metadata
============
• LanguageMetadata
UTM Search Campaign Referral information. Note: Supports marketing channel measurement from trading partner websites that refer shoppers to other NDC-enabled systems. Urchin Tracking Monitoring (UTM) parameters are used to specify referral source and campaign parameters.
UTM Search Campaign Referral definition.
UTM Codes. Notes: 1. This a URL with UTM parameters (snippets of text) added to the end of the URL to enable campaign tracking and performance measurement. 2. This shallow metasearch link may be specified as one string or as individual parameters that will be concatenated by the receiving system.
A complete Referrer URL with all UTM parameters included. Example: http://www.farecompare.com/12q/results.html?c2=n#results?quoteKey=CPIECNYC201406300000R201407170000P1CTF
Other (Custom) Campaign Urchin Tracking Method (UTM) Parameter(s).
UTM Campaign Name parameter. Examples: flightofferreferral, utm_campaign=flightofferreferral Note: This identifies and groups all of the content from one campaign.
UTM Referral Source parameter. Examples: priceline, utm_source=priceline Note: This is the website that initiated the referral.
UTM Medium parameter. Examples: referral, utm_medium=referral Note: This is used to identify the type of marketing medium that the link is featured in.
UTM Content parameter. Examples: sidebarlink, utm_content=sidebarlink Note: This is used to track the different types of content that point to the same URL from the same campaign, source and medium codes. Often used in PPC or with two identical links on the same page.
UTM Term parameter. Examples: flight+offer, utm_term=flight+offer Note: This is used to identify the keywords associated with the campaign.
Referrer-specified localization (i18n) parameters.
Referrer Market Country Code. Examples: US, FR Encoding Scheme: ISO 3166-1 (two character) Country Code Note: This country code may be specified if it differs from point of sale country code.
Referrer Local Currency Code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code Note: This currency code may be specified if it differs from point of sale currency code.
Referrer Local Language Code. Example: en-US Encoding Scheme: Microsoft National Language Support (NLS) Code
Urchin Tracking Monitor(UTM) Parameter definition.
UTM Parameter detail.
UTM Parameter Name. Example: gclid
UTM Parameter Value. Example: ?gclid=123xyz
UTM Parameter Name Definition. Example: Google Adwords Destination URL Auto-Tagging Parameter
UTM Parameter Role or Method. Examples: Campaign, Medium, Source
Message Property Path and Tag Name information.
NODEPATH helper object.
Message property location.
Note: This is typically specified in xpath notation.
Message property tag name.
Bank Account information.
BANK ACCOUNT Payment Form definition.
Customer bank accounts for payments, either for paper checks or electronic funds transfer.
Account Name. Example: JOHN SMITH
Note: This is the name the bank account is held under.
Routing Number. Example: 0260-0959-3
Note: This is the code assigned by authorities to financial institutions; sometimes called bank routing number.
Account Type. Examples: Checking, Savings, Investment
Purchaser bank account number. Example: 067014822
When TRUE, checks are accepted.
Used to indicate payment in cash.
When TRUE, payment is being made in cash.
Cheque Payment
Cheque number
Cheque signed date
Name of the Payee
Direct Billing Arrangement information.
DIRECT BILLING Payment Form definition.
Company name and location for sending invoice for remittances for travel services.
Direct billing Organizaqtion ID. Example: IBM
Remit to Company Name. Example: IBM
Note: This is the company name to whom remittance should be directed.
Direct Billing Contact Name. Example: J THOMAS
Address where remittance should be directed.
Loyalty Redemption Arrangement information.
The quantity of loyalty units being redeemed. Example: 15000
Loyalty Certificates to be Redeemed.
The loyalty redemption certificate number.
An individual airline identifier assigned to a passenger who is a member of an airline's Frequent Flyer Program.
Promotion Code.
Note: Promotion code is the identifier used by the host to link directly with a specific named advertising campaign. By including the required code, the client is able to gain access to special offers which may have been created for a specifically targeted group via a CRM system or for a wider advertising campaign using Television or press adverts.
List of vendor codes associated with the promotion.
Miscellaneous Charge Order (MCO) information.
The ticket number of the miscellaneous charge order (MCO).
Other Form of Payment information.
Payment Card.
Payment Form Information.
Payment Form detail.
PAYMENT CARD definition.
Magnetic striped card type.
Credit card issuer code. Example: MC
Note: This is the 2 character code of the credit card issuer.
The Credit Card Number embossed on the card. Example: 1111222233334444
Debit card issue number
Verification Digits. Example: 123
Note: This is the verification digits printed on the card following the embossed number. This may also accommodate the customer identification/batch number (CID), card verification value (CVV2 ), card validation code number (CVC2) on credit card.
Name of credit card holder. Example: JOHN SMITH
Credit card issuing company.
Issuer Name. Example: Bank of America
Note: This is the name of bank or organization issuing the card (e.g., alumni association, bank, fraternal organization, etc.).
Cardholder Address.
Concealed credit card number, Example: xxxxxxxxxxxx9922
Authorized credit card amount. Example: 500 USD
Surcharge Amount
Authorized credit card amount. Example: 500 USD
Payment Card Effective and/ or Expiration date(s).
Payment Card Effective Date. Example: 0116
Payment Card Expiration Date. Example: 0119
AVS Response Code. Example: Y (Street address and 5-digit ZIP code both match)
Note: This is the address verification response code (AVS) when the ticketing agency performs address verification.
Tokenized card number.
Note: This capability may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. If supported, the technical implementation of this capability is not dictated by this specification.
Approval Code Method. Example: M (Manual)
Note: This is used to specify how the approval code for a credit card sale was obtained.
Encoding Scheme: IATA PADIS Code List for data element 9890.
Information relating to prepayment vouchers.
Voucher ID or Number. Example: XX12345
Voucher Effective and/ or Expiration date(s).
Voucher Effective Date. Example: 2017-01-13
Voucher Expiration date. Example: 2017-06-13
Passenger Name information.
Note: Detailed Name information, such as prefix, title and suffix, are specified in PassengerMetadata.
Family name, last name
Example: SMITH
Given name, first name or names
Name Title. Examples: MR, MRS, DR
Surname Suffixes and / or Letters, Examples:Jr., Sr., III., Ret., Esq., Ph.D., M.D.
Middle name or initial. Examples: G, GEORGE
Penalty Information.
PENALTY definition.
NDC Capability Model: PENALTY
============
Representation(s)
============
• Core Penalty
• Detail Penalty
============
Feature(s)
============
• Penalty Indicators (Cancellation fees apply; Change of Itinerary fees apply; Refundable ticket and/ or fare; Reusable ticket and/ or fare; Upgrade fee applies)
• Applicable Fee Remarks
• Penalty Type (Cancellation, No Show, Upgrade, etc.)
• Penalty Application (IATA Padis Codeset FAT - Fare or Application Penalty Type)
• Penalty Amount, represented as percentage or fixed value, with Amount Application (MinimumPenaltyAmount, MaximumPenaltyAmount, Other) and Applicable Fee Remarks
============
Metadata
============
• PenaltyMetadata
Applicable Fee Remark(s).
Penalty Conditions and Penalty Amount detailed information.
Penalty detail.
Penalty Type.
Examples: Cancellation, Change, NoShow, Upgrade, Other
Penalty application type.
Examples:
ADE (After departure)
NOS (No show)
PDE (Prior to departure)
Encoding scheme: IATA Padis Codeset FAT - Fare or Application Penalty Type
Penalty Amount(s) with Penalty Amount Application and Remarks.
Penalty Amount detail.
Penalty monetary value amount and currency code.
Penalty Amount Application.
Examples: MinimumPenaltyAmount, MaximumPenaltyAmount, Other
Applicable Fee Remark(s).
When TRUE, Cancellation fee(s) may apply.
When TRUE, Change of Itinerary fee(s) may apply.
When TRUE, this is a refundable ticket and/ or fare.
When TRUE, this is a reusable ticket and/ or fare.
When TRUE, Upgrade fee(s) may apply.
PENALTY DETAIL with Application, Description and Amount.
NDC Capability Model: PENALTY
============
Representation(s)
============
• Core Penalty
• Detail Penalty
============
Feature(s)
============
• Penalty indicators (xxxx)
• Free-Text Penalty Remarks
============
Metadata
============
• PenaltyMetadata
Geocoding Location/ Position Metadata Associations.
POSITION AND GEOCODING helper object.
Latitude value. Example: 49.9856
Latitude sign. Example: SOUTH (South of Meridian)
Latitude degree minute value. Example: 45
Latitude degree second value. Example: 30
Longitude value. Example: 9.1220
Longitude sign. Example: EAST (East of Meridian)
Longitude degree minute value. Example: 130
Longitude degree second value. Example: 69
Altitude value. Example: 9.1220
Altitude unit of measure.
Example: Feet, Meters
Other altitude unit of measure context. Example: MyContext
Natural area geocode (NAC). Example: 8KDB PGFD
Geographical search radius.
Search radius application. Example: Driving
A maximum search radius value, e.g. distance from specified location. Example: 20
Distance unit of measure. Examples: Miles, Kilometers
CORE PRICE definition.
When TRUE, this price is approximate.
When TRUE, all price amounts are refundable.
When TRUE, price-associated tax(es) have been specified and included.
When TRUE, price-associated fee(s)/ surcharge(s) have been specified and included in Price.
When TRUE, pricing has been returned from an auto-exchanging application .
A (detailed) CURRENCY-based Price with Price Break-down for Tax and/ or Fee information.
AWARD (Redemption Unit-based) Pricing information.
AWARD/ REDEMPTION PRICE BASIS UNIT definition.
Redemption pricing.
Example: 15000 Miles
PARTIAL CURRENCY and AWARD Pricing Combination information.
COMBINATION PRICE BASIS UNIT: Partial currency and award.
Element outlining payment for frequent flyer redemption transaction where payment has been made partially with money and partially with frequent flyer miles or points. Monetry value followed by currency code, points or miles value followed by unit name.
Currency Pricing information used in combination pricing scenarios (I.e. partial currency and partial airline redemption points)
Monetary value amount and currency code.
Redemption amount and unit.
Example: 15000 Miles
DETAIL CURRENCY PRICE BASIS UNIT: Price with tax and/ or fee break-down or totals.
Total price in currency. Example: 16000 USD
Note: This is the total price INCLUDING base price, taxes and fees/ surcharges.
Used instead of Total when price is not known (for example in case of BT/IT tickets). Example IT.
Details all price break-down item subtotals, which exclude taxes, fees and charges.
Price details.
Note: This price does not include taxes and fee/ surcharges.
Price breakdown sub-total.
Note: This is the total of all price breakdown items, excluding tax and/ or surcharge.
Price application. Example: Base Fare
When TRUE, this price amount is refundable.
Ticket Tax/fee/charge details to indicate taxes that apply to country of commencement of travel and routing.
Individual fee/ surcharge information would appear on the accountable document.
Monetary value amount and currency code.
PRICE with CURRENCY ENCODING definition.
SIMPLE CURRENCY PRICE BASIS UNIT: NO price break-down, taxes and/or fees.
A (simple) CURRENCY-based Price with NO taxes and/ or fees.
Examples: 100.00, 100, 100 (USD)
Redemption information.
REDEMPTION helper object.
Frequent flyer program redemption unit. Example: Miles, Points
Value containing the quantity of frequent flyer program redemption units.
Redemption amount/ unit equivalents.
Unit (Miles, Points) and Quantity (30000). Used on conjunction withNote: A currency value or conversion ratio may be specified.
Currency equivalent of redemption amount. Example: 50000
Redemption unit to currency ratio. Example: 2:1 (two redemption units = one currency unit.)
Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).
Adjustment PERCENTAGE. Example: 20
Penalty monetary value amount and currency code.
Percentage Value relating to acceptable the total amount by which the Order item price can vary; OR the amount of a penalty.
Example: 20 USD, 2 Percent
Promotion(s).
PROMOTION helper object.
Promotion code ID or number. Example: PROMO123. Used in conjunction with Link (Promotion URL), Issuer (Promotion Owner or Sponsor) and Remarks (Promotion remarks).
Promotion url. Example: http://promos.site.com
Promotion Owner or Sponsor.
Used in conjunction with Code (Promotion code ID or number), Link (Promotion URL), and Remarks (Promotion remarks).
A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory .
This is the name of the person holding the voucher."
A data type for Baggage Detail Association.
LOCATION PROXIMITY definition.
Note: This contains either the requested maximum distance search radius values -or- the actual Proximity information, which is typically used to specify the results from the named location radius search.
Proximity Data Application. Example: SearchRadius, ActualProximity, Other
The actual distance value from the named location search. Example: 20
Distance unit of measure. Examples: Miles, Kilometers
Remark(s).
REMARK helper object.
Remark Text.
When TRUE, this remark should be displayed.
Notes:
1. This capability may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. The technical implementation of this capability is not dictated by this specification.
Remark creation timestamp. Example: 2017-01-13T13:59:38Z
Acceptable Price Variance Rule(s).
Note: This is the acceptable amount and/or percentage of the total amount by which the Order item price can vary from the Offer price for Order creation to proceed, for example to cover minor currency exchange rate fluctuations for taxes quoted in a different currency.
Price Variance Rule detail.
ORDER CREATION PRICE VARIANCE RULE definition.
Unique Rule ID. Example: RULE001
Acceptable amount and/or percentage of the total amount by which the Order item price can vary.
Example: 20 USD, 2 Percent
Rule Name. Example: Acceptable Price variance
Entity that owns/ assigned this Rule. Example: BA
Note: If this is an airline, the IATA/ A4A (two or three character) Airline Designator Code should be used.
Rule Effective Period.
Rule(s).
Rule detail.
RULE SET definition.
Unique ID for a set of rules which was applied during transaction processing. Example: PRICERULE001 Note: Optional rule context and name may also be specified.
Rule Set Name. Example: Order Item Price Variance
Rule Set Effective and Expiration Period. Notes: 1.If specified, this applies to all rules within the rule set. 2.Use a Rule Parameter to specify rule-level effective/ expiration periods, e.g.: (Name) EffectiveDate, (Value) 2015-01-15
Entity that owns/ assigned this Rule Set. Example: BA Note: If this is an airline, the IATA/ A4A (two or three character) Airline Designator Code should be used.
Rule(s).
RULE definition.
Unique Rule ID. Example: RULE001
Rule Value(s).
Rule text value.
Implementer-defined rule values.
Rule Name. Example: Acceptable Price variance
Entity that owns/ assigned this Rule. Example: BA
Note: If this is an airline, the IATA/ A4A (two or three character) Airline Designator Code should be used.
Rule Effective Period.
GENERIC/ IATA SPECIAL SERVICE definition.
Special service/ request code value.
Example: UMNR (IATA passenger assistance SSR code)
Encoding Scheme: Use of IATA Special Service Request (SSR) Code encoding is recommended. Any string value up to 15 characters in length is valid.
Note: Although optional in the schema, some SSR codes may require associated description and description codes.
Code description. Example: Unaccompanied Minor
Description context. Examples: WEIGHT, NUMBER, PEDICURE
A collection of shopping session (message response) IDs, including the unique (master) Shopping Response ID, Offer IDs, Offer Item IDs and Service IDs.
Notes: This capability may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. The technical implementation of this capability is not dictated by this specification.
Notes:
1. This capability supports reduced message payload sizes by providing a mechanism that supports references to cached Shopping Transactions and/ or Offer information so only object identifiers (e.g. Offer, Service) need to be exchanged in a subsequent Shopping request message, versus specifying the full object details.
2. This capability may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. The technical implementation of this capability is not dictated by this specification.
SHOPPING RESPONSE object definition.
Designator of Airline that owns/ assigned these IDs. Examples: BA
Encoding Scheme: IATA/ A4A (two or three character) Airline Designator Code
Unique shopping session response ID. Example: 1F126AF1-7FCF-414F-8A3D-E4FFA408F747
Associated Offer Item ID and Service ID collection.
Offer/ Service Collection detail.
ORDER INPUT SHOPPING RESPONSE object definition.
Designator of Airline that owns/ assigned these IDs. Examples: BA Encoding Scheme: IATA/ A4A (two or three character) Airline Designator Code
Unique shopping session response ID. Example: 1F126AF1-7FCF-414F-8A3D-E4FFA408F747
Associated response Offers list.
Associated Offer
Globally unique Offer instance ID. length should not be exceed 64 character and it is recommended to not use dash char in it.Example: QWASZXERDFCVTYGHBNUIJKNMF67D5F9GHR567SWER41SD458F9456FMDIRTN34DF
Associated Order Item(s).
Offer Item ID with passenger association and offer detail including wait list and inventory guarantee.
Passenger(s) associated with the Offer Item. Note: This contains references to Passenger instance(s) defined in the Passengers/Passenger node.
Association to multiple Passenger instance(s). Example: pax1 pax2
The total price for all Travelers associated with this offer.
Associated Service Item(s).
Offer Item ID with optional passenger association.
Passenger(s) associated with the Service Item. Note: This contains references to Passenger instance(s) defined in the Passengers/Passenger node.
Association to multiple Passenger instance(s). Example: pax1 pax2
Offer Item details including wait list indicator and inventory guarantee.
Inventory Guarantee
Unique Inventory Guarantee ID. Examples: INVREF123456, 68E0-675C Note: This is a unique identifier issued by an Airline to reference that inventory for a specified offer will be guaranteed as available for a period.
Time limit by which guaranteed inventory for a specified product offer is guaranteed as available and by which the inventory held must be converted into a completed order before the time limit expires otherwise the guarantee is lost.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
When TRUE, this offer item is waitlisted.
The total price for all Travelers associated with this offer.
State or Province Code. Examples: NY, QUE
State or Province Query information.
State or province code. Examples: NY, QUE
State or Province Code representation.
STATE/PROVINCE RADIUS QUERY representation.
NDC Capability Model: STATE OR PROVINCE QUERY
============
Feature(s)
============
• Query by list of State/ Province Codes
• Query by list of State/ Province Keywords
• Preference Level for all or individual Query ParameterGroups
• Proximity information containing either the requested maximum distance search radius values, or the actual Proximity information (which is typically used to specify the results from the named location radius search.)
============
Metadata
============
• Yes
State Code(s).
State or Province Code. Example: NY
Keyword/ Value Search Criteria.
Notes:
1. This capability may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. If supported, the technical implementation of this capability is not dictated by this specification.
Keyword detail.
State Proximity.
Notes:
1. This contains either the requested maximum distance search radius values -or- the actual Proximity information, which is typically used to specify the results from the named location radius search.
STATE/PROVINCE PROXIMITY representation.
Note: This contains either the requested maximum distance search radius values -or- the actual Proximity information, which is typically used to specify the results from the named location radius search.
State or Province Code. Example: NY
A data type for a Fee/ Surcharge.
Note: Fee/ surcharge information may be specified as:
- A total amount
- A total amount with associated breakdown
Sub-total of all fees and charges. Monetary value and currency code.
When TRUE, all fee/ surcharge amounts are refundable.
Example: TRUE
The fee, charge or surcharge amount information per traveler.
Individual fee/ surcharge information would appear on the accontable document.
Note: Separate structure for individual TAX details is also present.
Fee Amount. Example: 500 USD
Local fee amount. Example: 7 CHF
Fee designator. Example: USC
Fee/ surcharge Description. Example: U.S Customs User Fee
Fee nature.
When TRUE, this fee is approximate.
When TRUE, this fee amount is refundable.
Contains elements with all tax information.
Exempt Tax Amount(s), Exemption Qualifiers and Total.
TAX CORE representation.
When TRUE, this tax is approximate.
When TRUE, this tax must be collected.
When TRUE, all tax amounts are refundable.
TAX DETAIL representation.
Note: Tax information may be specified as:
-A total tax amount
-A total tax amount with associated tax breakdown
-A combination of both
Sub-total of all applicable taxes. Monetary value and currency code.
A collection of detailed taxes.
Tax breakdown detail.
Indicate whether a tax is paid or new etc. , PADIS codeset, 5305
Amount. Example: 15000 USD
Tax Nation or Designator. Example: US, GB
Tax Code. Example: AY, GB
Tax type. Used to specify where the tax was applied. May be nice to have for auditing purposes. Example: 001, 002
Tax data breakdown by collection point for XF(Passenger Facility Fee) and ZP(federal tax segment) taxes.
Amount field bythe airport in the currency applicable to the geographical location of the airport. Example: 2789
Local tax amount. Example: 24 CHF
Tax short description.
Example: $4 per flight segment, per passenger (U.S. domestic segment tax)
Amount conversion
Define a date of the converion amount
The tax filed amount.
The filed ticket tax code assigned by IATA..
A qualifier to the Tax Code to distinguish taxes/fees/charges with the same tax code but with different business uses.
A qualfier to the filed tax code to distinguish taxes/fees/charges with the same tax code but with different business uses.
When true, the tax amount is to be/was refundable.
When TRUE, this tax is approximate.
When TRUE, this tax must be collected.
When TRUE, this tax amount is refundable.
EXEMPT TAX representation.
Sub-total of all exempt taxes. Monetary value and currency code.
Choice between specifying:
- Summary Exemption Information (Company, Country and/ or Territory Codes)
- Detailed Exemption Information
Name of entity to which passenger belongs, indicating an exemption to the application of a tax.
Example: Military, Government
Exempt tax entity name. Example: Military, IBM
Name or code of state or territory used to identify tax exemptions.
Codes are published in Appendix C of IATA AIRIMP.
Exempt tax territory code. Example: QC
Exempt tax country information.
Contains information of all taxes for which passenger is exempt. Includes designator, amount, country code, description etc.
Tax nature. Example: US2
Amount. Example: 15000 USD
Exempt tax country code. Example: US
Encoding Scheme: ISO 3166-1 (two character) Country Code
Tax nature. Example: US2
Local tax amount. Example: 24 CHF
Tax short description.
Example: $4 per flight segment, per passenger (U.S. domestic segment tax)
When TRUE, this tax is approximate.
When TRUE, this tax must be collected.
When TRUE, this tax amount is refundable.
The applicable code as provided for in A4A SIPP Resolution 110.16 or IATA Resolution 728. Further ticket
designators will be reported at the Fare Component level as matched from a Ticket Discount, ATPCO
Category 35, Category 25 or Category 19-22.
AUTO EXCHANGE TICKET object.
Penalty/ change fee amount and allowable commission amount.
Choice between specifying
amount value or percentage.
Commission amount. Example: 20.00 USD
Commission percentage. Example: 20
Penalty or change fee amount.
Example: 100 USD
Total original ticket amount.
Example: 200 USD
Ticket Number(s).
Ticket detail.
Passenger type code.
Example: ADT (ADULT)
Encoding Scheme: IATA (three character) Passenger Type Code (PTC)
Ticket Designator with Application definition.
Ticket Designator application. Examples: Requested, Ticketed
Bilateral Time Limits.
Note: These are bilaterally-agreed upon time limit that is not included in the NDC XML Specification.
Deposit Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Note: This is the time by which a deposit must be paid for an Order.
Time limit by which guaranteed inventory for a specified product offer is guaranteed as available and by which the inventory held must be converted into a completed order before the time limit expires otherwise the guarantee is lost.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Naming Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Note: This is the time by which an Order must be completed with individual passenger names.
Payment Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Notes:
1. This is the deadline by which a commitment to pay must be made for the confirmed items in an offer as agreed witht he airline. The passenger meets this requirement by making complete payment for the order.
2. Payment Time Limit and Ticket Time Limit may be the same in most cases; however, Payment Time Limit expands to include ticketless transactions and other accountable documents.
3. This time limit is at the OFFER-LEVEL and will apply to all (child) Offer Items.
Price Guarantee Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Note: This is the period for which an Offer price is guaranteed. On expiry an Offer may be re-priced up to the point an accountable document is issued. A Price Guarantee cannot extend beyond the Offer Time Limit unless the Order has been created.
Ticketing Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
The time by which passengers must secure tickets (or other accountable documents) for confirmed reservation as agreed with the airline. Passengers meet this requirement by purchasing a ticket (or other accountable document) which indicates the reserved services, or by having previously issued documents revalidated or reissued to reflect the reservation.
Offer/ Offer Item: BILATERAL (Implementer-Assigned) TIME LIMITS definition.
Bilateral Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Note: This is a bilaterally-agreed upon time limit that is not included in the NDC XML Specification.
Bilateral Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Note: This is a bilaterally-agreed upon time limit that is not included in the NDC XML Specification.
Bilateral Time Limit name. Example: Other Time Limit
Bilateral Time Limit name. Example: Other Time Limit
Order/ Order Item: DEPOSIT Time Limit definition.
Deposit Must be Paid By Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Note: This is the time by which a deposit must be paid for an Order.
Order/ Order Item: NAMING Time Limit definition.
Naming Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Note: This is the time by which an Order must be completed with individual passenger names.
Offer/ Offer Item: PAYMENT Time Limit definition.
Payment Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Notes:
1. This is the deadline by which a commitment to pay must be made for the items in an order. This includes ticketless transactions and other accountable documents, such as EMD.
2. Payment Time Limit and Ticket Time Limit may be the same in most cases; however, Payment Time Limit expands to include ticketless transactions and other accountable documents.
Offer/ Order: PRICE GUARANTEE Time Limit definition.
Ticketing Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
The time by which passengers must secure tickets (or other accountable documents) for confirmed reservation as agreed with the airline. Passengers meet this requirement by purchasing a ticket (or other accountable document) which indicates the reserved services, or by having previously issued documents revalidated or reissued to reflect the reservation.
Instructions: Commissions definition.
Instructions: Class of Service Upgrade definition.
Upgrade-eligible Service Class information.
Upgrade-eligible Class of Service. Example: T
Instructions: Free-Text Remark(s).
Offer Instructions: Special Booking Method definition.
Special Need Order booking method.
Examples:
AE (by SSR-Special Service Request)
AF (by OSI-Other Service Information)
Encoding scheme: PADIS Codeset for data element 9750 - Option
A data type for Traveler ACTORS, Core Representation.
Passenger type code and travelers quantity.
Example: ADT
Encoding Scheme: IATA (three character) Passenger Type Code
Number of Traveler(s) for associated passenger type and country of residence.
Example: 2
Residence country code.
Examples: US, FR
Encoding Scheme: ISO 3166-1 (two character) Country Code
Associate an infant in lap to an adult passenger
Age and/or birthdate.
Traveler age value.
Example: 38
Age unit of measure.
Example: Year
Traveler birth date. Example: YYYY-MM-DD
Citizenship country code.
Examples: US, FR
Encoding Scheme: ISO 3166-1 (two character) Country Code
A data type for SUMMARY Traveler representation.
Passenger Name information.
Note: Detailed Name information, such as prefix, title and suffix, are specified in PassengerMetadata.
Family name, last name
Example: SMITH
Given name, first name or names
Name Title. Examples: MR, MRS, DR
Surname Suffixes and / or Letters, Examples:Jr., Sr., III., Ret., Esq., Ph.D., M.D.
Middle name or initial. Examples: G, GEORGE
Traveler profile ID.
A data type for DETAIL Traveler representation.
Traveler Details, including Age/ Birthdate, Gender, FOID, FQTV information, Contact information, Spoken/ Written Languages and General Remarks.
Passenger Gender
Example: Male
Frequent Traveler Program(s).
Forms of identification (FOID).
Spoken or Written Language(s).
A data type for Traveler FORM OF IDENTIFICATION representation.
Passenger Form of Identification detail.
ID form. Examples: PT (passport), CC (credit card), FF (frequent flyer), DL (drivers license)
Encoding Scheme: IATA Padis Codeset - List for data element 7365 - Processing indicator, coded
FOID ID value. Example: NY122345
Owner/ Issuer of FOID. Example: United State Department Of State
ANONYMOUS TRAVELER.
A data type for ANONYMOUS Traveler Role.
Notes:
1. This is a representation of common (role-agnostic) properties associated with this Actor definition.
2. This type is used as (derived) base type for all Roles associated with this Actor.
3. This type is derived from TravelerCoreRepType.
RECOGNIZED (AUTHENTICATED) TRAVELER.
Detail Passenger Information.
Passenger.
Additional Passenger Role(s), including Primary Contact and Payment Contact.
When TRUE, this person is a PRIMARY CONTACT, e.g. for a group, for an order, for an itinerary, etc.
When TRUE, this Passenger is responsible for payment.
A data type for SUMMARY PASSENGER representation.
Traveler Frequent Traveler Program(s).
FQTV Program main information.
FQTV Program information, details.
FQTV Program information summary.
Traveler Frequent Flyer (FQTV) Account Information.
Passenger Gender
Example: Male
Passenger FOID and other documents information.
Passenger Form of Identification.
Note: This is the type of FOID as defined in IATA AIRIMP.
ID form. Examples: PP (passport), CC (credit card), FF (frequent flyer), DL (drivers license)
FOID ID value. Example: NY122345
The vendor code for example for CC issuer
The type of passenger document.
Examples: PT (Passport), VI (Visa), 7TR (Transit visa)
Encoding schema: PADIS 7365, Processing indicator, coded.
Document ID value. Example: NY122345
Country of Birth. Country Name or Code. For Example. Germany, DE
Date of Issue. Example: 2017-01-13
Date of expiration. Example: 2017-01-13
Country name from where the document has been issued.
The location where the document is applicable.
Country where passenger resides.
An indicator, allowing use the document number
When TRUE, passenger authorize the airline to share his/her profile information or send promotional emails.
A data type for DETAIL PASSENGER representation.
Primary Contact Information.
Passenger Name information.
Note: Detailed Name information, such as prefix, title and suffix, are specified in PassengerMetadata.
Family name, last name
Example: SMITH
Given name, first name or names
Middle name or initial. Examples: G, GEORGE
Contact(s).
Summary passenger information, including name details.
Note: Includes core passenger information.
Contains information on a Group, such as Group Name, number in party, and contacts for the group.
Group Name. Example: ABC Tour Club
PassengerCount. Example: 12
NDC XML SPECIFICATION: NDC ACTOR XML OBJECTS
Notice: This is NDC Draft Specification provided for pre-review by the members of the relevant governance groups, it is not provided for implementation in a production environment or considered to be the final schema to support NDC business requirements. The draft schema may, at any time up to final specification submission, undergo changes including, but not limited to, specific elements, element names/labels, annotations or message name as a result of the ongoing quality control process, and comments, which may be received following the pre-review. Implementation of this version is done so at the risk of the implementer or implementing company.
A data type for Partner Company Type contextual list.
Examples: ServiceProvider, ServiceFulfillment, Merchandise
A data type for Partner Company Type.
A data type for Agency Seller Type contextual list.
Examples: TravelAgency, OnlineTravelAgency, TravelManagementCompany
Travel agency.
A data type for Agency Seller Type.
Examples: TravelAgency, OnlineTravelAgency, TravelManagementCompany
A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory .
Unique Retailer ID. Example: LOUNGECO
Encoding Scheme: Note, if this is an Airline retailer, the IATA/ A4A (two or three character) Airline Designator Code should be used.
A data type for Core Airline Representation.
Notes:
1. This type contains the common properties for all defined Airline Supplier Role definitions, e.g. POA, Operating Carrier.
2. This type is derived from SupplierCoreRepType.
Airline Name. Example: British Airways
A data type for MARKETING CARRIER Supplier Role, Core Representation.
Notes:
1. This is a representation of common (role-agnostic) properties associated with this Actor definition.
2. This type is used as (derived) base type for all Roles associated with this Actor.
3. This type is derived from AirlineCoreRepType.
A data type for MARKETING CARRIER Supplier Role with Mandatory Flight Number.
Airline Name. Example: British Airways
The Reservation Booking Designator (booking class) of the Marketing Carrier. Example: Y
The carrier that sells with its own code, and whos code will eventually appear on the relevant coupon on the issued accountable document.
Note: Marketing Carrier may be differnt from an Operating Carrier, if the flight is actually operated by another carrier within a codeshare agreement.
A data type for OPERATING CARRIER Supplier Role with Optional Flight Number.
A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory.
Airline Name. Example: British Airways
The Reservation Booking Designator (booking class) of the Operating Carrier if different from the Marketing Carrier. Example: Y
A data type for MERCHANDISE RETAILER Supplier Role, Core Representation.
Notes:
1. This is a representation of common (role-agnostic) properties associated with this Actor definition.
2. This type is used as (derived) base type for all Roles associated with this Actor.
3. This type is derived from SupplierCoreRepType.
RETAIL PARTNER.
A data type for SUPPLIER GROUP, Core Representation.
Additional supplier identification such as federal tax IDs or registry entries.
Other ID Unique identifier. Examples: 13-015576, 50014517
Other identification description. Examples: Federal Tax ID, TICO ID
A data type for Unique Airline Designator.
A data type for Unique Retailer ID.
Validating Carrier Airline Designator.
A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory . Example: BA
Unique Aggregator ID. Example: F1
INTERMEDIARY: AGGREGATOR
A data type for AGGREGATOR Intermediary Role, Core Representation.
Notes:
1. This is a representation of common (role-agnostic) properties associated with this Actor definition.
2. This type is used as (derived) base type for all Roles associated with this Actor.
3. This type is derived from IntermediaryCoreRepType.
Connection Communication Method. Examples: DirectWithAirline, DirectWithOther, Gateway
INTERMEDIARY: NDC-ENABLED SYSTEM
A data type for SYSTEM Intermediary Role, Core Representation.
Notes:
1. This is a representation of common (role-agnostic) properties associated with this Actor definition.
2. This type is used as (derived) base type for all Roles associated with this Actor.
3. This type is derived from IntermediaryCoreRepType.
A data type for INTERMEDIARY GROUP, Core Representation.
Intermediary Name. Example: Farelogix
Intermediary Category. Example: Aggregator, Consolidator
Encoding Scheme: IATA Padis Codeset - Data element 9972 (Originator Type)
Contact detail.
Email address details, including application (I.e. home, business, etc.).
A data type for Intermediary to Intermediary Role Association.
Association link to Supplier object instance. Example: supplier1
Note: This is the @id specified in a Supplier object instance.
Intermediary association for this (intermediary) role.
Unique System ID. Example: F1
A data type for Unique Aggregator ID.
A data type for Unique NDC-Enabled System ID.
SELLER: Agency User.
Unique Agency Seller ID. Example: CTRV
Agent User ID. Example: ksmith212
A data type for Core Agency (Seller) Group Representation.
Notes:
1. This type contains the common properties for all defined Agency Seller Role definitions, e.g. TravelAgency, Travel Agent.
2. This type is derived from SellerCoreRepType.
Additional Agency (Seller) identification, such as federal tax IDs or registry entries.
Other identifier. Examples: 13-015576, 50014517
Other identification description. Examples: Federal Tax ID, TICO ID
Pseudo City code. Example: AAA2
Defines where the PCC was created. For example 1A, 1P, 1S
Agency Seller IATA number. Example: 98417900
A data type for (AGENCY) AGENT USER Seller Role, Core Representation.
Notes:
1. This is a representation of common (role-agnostic) properties associated with this Actor definition.
2. This type is used as (derived) base type for all Roles associated with this Actor.
3. This type is derived from AgencyCoreRepType.
Agent User ID. Example: ksmith212
Agent role. Example: Authorized User
A data type for Core Seller Actor Group Representation.
Agency Seller Name. Example: Carson Travel
Agency Seller Type. Examples: TravelAgency, OnlineTravelAgency, TravelManagementCompany
SELLER: Travel Agency
Creates shopping requests to Airlines on behalf of a customer and displays the subsequent product responses for review.
Agent role. Example: Authorized User
A data type for TRAVEL AGENCY Seller Role, Core Representation.
Notes:
1. This is a representation of common (role-agnostic) properties associated with this Actor definition.
2. This type is used as (derived) base type for all Roles associated with this Actor.
3. This type is derived from AgencyCoreRepType.
A data type for Agency (Seller) ID.
A data type for Agent User (e.g. Travel Agent) ID.
User ID.
Example: ksmith212
Agent User Name. Example: Karen Smith
Unique Partner Company ID. Example: AIRSTUFF
Fulfillment Partner.
PARTNER ROLE: FULFILLMENT PARTNER, Core Representation.
Notes:
1. This is a representation of common (role-agnostic) properties associated with this Actor definition.
2. This type is used as (derived) base type for all Roles associated with this Actor.
3. This type is derived from PartnerCoreRepType.
Offer and Order Fulfillment(s).
Fulfillment detail.
Fulfillment Period.
Note: This is the start and end date/time period(s) the service may be fullfilled or used.
The EARLIEST date the associated optional service is available or may be used. Example: 2017-01-13
The LATEST date the associated optional service is available or may be used. Example: 2017-03-13
Information about the location where the service will be fulfilled.
PARTNER ACTOR, common properties.
Partner Company Name. Example: Flight Stuff. Inc.
Partner Company Type. Examples: ServiceProvider, ServiceFulfillment, Merchandise
A data type for Unique Partner Company ID.
NDC XML Specification: The appinfo schema provides support for high level data model concepts and additional syntax to support the NDC conceptual model and validation of NDC-compliant instances.
NDC XML SPECIFICATION: XML System/ Application Data Components.
Notice: This is NDC Draft Specification provided for pre-review by the members of the relevant governance groups, it is not provided for implementation in a production environment or considered to be the final schema to support NDC business requirements. The draft schema may, at any time up to final specification submission, undergo changes including, but not limited to, specific elements, element names/labels, annotations or message name as a result of the ongoing quality control process, and comments, which may be received following the pre-review. Implementation of this version is done so at the risk of the implementer or implementing company.
Moile Device information.
A data type for Device identification.
Device Type. Examples: Web Browser, Mobile Device
Encoding Scheme: IATA Padis Codeset - List for data element TDT (Touchpoint Device Type)
Device position and geocoding coordinates.
Provides telephone information, and allows to specify telephone number application (ie Home, Business, etc.). May be used for a simle, unstrucutured number, or, in combination with child attributes allows to create a structured telephone number (ie Country Code number, Area Code numbers, etc.)
Associated IP address.
Examples: 192.0.2.8, 198.51.100.0
Device MAC Address. Example: 00:0a:95:9d:68:16
Named Device ID. Example: Bonnies iPad
A data type for Business Object Parameters.
Requested and/ or Actual Primary and/ or Alternate message content language(s).
Note: Language context is specified in the @application attribute, e.g. Requested, Display.
Requested search processing and results currency information.
Notes:
1. Currency context is specified in the @application attribute, e.g. Requested, Display.
NDC Message Document information.
A data type for Common NDC Message Document Structures.
Document metadata
NDC Implementation Name.
Example: ThisAirline Gateway
NDC Framework Version. Example: SOAP 2015.1
A globally unique identifier for this object instance.
Object association(s) between this object and any object instance(s).
Pre-defined Message Policy information.
Policy information.
Policy detail.
Custom Policy Information augmentation point.
A data type for Policy Notification and Text, e.g. for sensitive data notification and/or handling.
Policy Detail.
When TRUE, data handling policy(s) apply.
Policy Code or ID. Example: DATA1
Policy Type. Examples: Privacy_PII, Payment_PCI, Credentialing
Policy short description.
Message Property Path information for this policy-associated element.
Object association(s) between this object and any object instance(s).
A data type for Augmented Message Policy information.
Policy Augmentation Detail.
Object association(s) between this object and any object instance(s).
Policy Location Link. Example: www.anyairline.com/thispolicy
Point of Sale information.
A data type for Point of Sale.
Point of sale location information.
Point of sale timestamp value. Example: 2017-01-13T13:59:38Z
Note: This may be used if the point of sale time zone differs from the message creation timestamp.
Point of sale time zone.
Example: UTC
Message Touchpoint information, including initiating device and event.
The device from which the request was initiated. Examples: Agent Terminal, Web Browser, Mobile Device
Encoding Scheme: IATA Padis Codeset - List for data element TDT (Touchpoint Device Type)
Device position and geocoding coordinates.
The travel event that triggered the request.
Example: Order/Buy, Check-In, In Flight
Encoding Scheme: IATA Padis Codeset - List for data element TTT (Touchpoint Transaction Type)
A globally unique identifier for this object instance.
Object association(s) between this object and any object instance(s).
Internally define agent authority to request changes.
A data type for AGENT USER Message Party Representation.
Notes:
1. Derived from AgentUserType.
A data type for AGGREGATOR Message Party Representation.
Notes: Derived from AggregatorType.
A data type for Core Airline Message Party Representation. Derived from AirlineCoreRepType.
A data type for NDC-ENABLED SYSTEM Message Party Representation.
Notes:
1. Derived from EnabledSystemType.
A data type for Authentication and Notification of NDC Actors participating in the message/ transaction. Note that information about parties is intended for business use, it is not intended for transaction authentication and routing of the message.
Message Sender information.
Message Participant(s).
Participant detail.
Named Message Recipient.
NDC Message/ Transaction Party(s) information. Note that information about parties is intended for business use, it is not intended for transaction authentication and routing of the message.
A data type for RETAILER Message Party Representation.
Notes:
1. Derived from RetailerType.
Retail Supplier Agent User information.
A data type for TRAVEL AGENCY Message Party Representation.
Notes: Derived from TravelAgencyType.
SUPPLIER: ORA (Offer Originating Airline) Sender.
SUPPLIER: POA (Participating Offer Airline) Sender.
INTERMEDIARY: Aggregator.
This specific data field to be used for an UNAFFILATED AGENT USER, rather than anyone linked directly to an IATA Agent user, which is identified in a different element.
A data type for Aggregator Message Sender Role. Derived from AggregatorMsgPartyCoreType.
SELLER: Agent User.
INTERMEDIARY: NDC-Enabled System.
A data type for Enabled System Message Sender Role. Derived from EnabledSysMsgPartyCoreType.
A data type for Marketing Carrier Sender Role. Derived from AirlineMsgPartyCoreType.
SUPPLIER: Marketing Carrier Sender.
A data type for Operating Carrier Sender Role. Derived from AirlineMsgPartyCoreType.
A data type for ORA (Offer Originating Airline) Sender Role. Derived from AirlineMsgPartyCoreType.
SUPPLIER: Operating Carrier Sender.
A data type for POA (Participating Offer Airline) Sender Role. Derived from AirlineMsgPartyCoreType.
SUPPLIER: Retailer Sender.
A data type for Retailer Message Sender Role. Derived from RetailerMsgPartyCoreType.
SELLER: Travel Agency
A data type for Travel Agency Message Sender Role. Derived from TrvlAgencyMsgPartyCoreType.
INTERMEDIARY: Aggregator Recipient.
SELLER: Agent User Recipient.
A data type for Travel Agency Message Recipient.
Notes:
1. Derived from TrvlAgencyrMsgPartyCoreType.
A data type for Aggregator Message Recipient Role. Derived from AggregatorMsgPartyCoreType.
INTERMEDIARY: NDC-Enabled System Recipient.
A data type for Enabled System Message Recipient Role. Derived from EnabledSysMsgPartyCoreType.
SUPPLIER: Marketing Carrier Recipient.
A data type for Marketing Carrier Recipient Role. Derived from AirlineMsgPartyCoreType.
SUPPLIER: Operating Carrier Recipient.
SUPPLIER: ORA (Offer Originating Airline) Recipient.
A data type for Operating Carrier Recipient Role. Derived from AirlineMsgPartyCoreType.
A data type for ORA (Offer Originating Airline) Recipient Role. Derived from AirlineMsgPartyCoreType.
A data type for POA (Participating Offer Airline) Recipient Role. Derived from AirlineMsgPartyCoreType.
SUPPLIER: POA (Participating Offer Airline) Recipient.
SUPPLIER: Retailer Recipient.
A data type for Retailer Message Recipient Role. Derived from RetailerMsgPartyCoreType.
SELLER: Travel Agency Recipient.
A data type for Travel Agency Message Recipient Role. Derived from TrvlAgencyMsgPartyCoreType.
INTERMEDIARY: Aggregator Participant.
A data type for Aggregator Message Participant Role. Derived from AggregatorMsgPartyCoreType.
The sequence number of this participating Party within the collection of parties.
Example: 1
Notes:
1. A sequence number of 1 indicates that this is the first Participant involved in the transaction.
A data type for Enabled System Message Participant Role. Derived from EnabledSysMsgPartyCoreType.
The sequence number of this participating Party within the collection of parties.
Example: 1
Notes:
1. A sequence number of 1 indicates that this is the first Participant involved in the transaction.
INTERMEDIARY: NDC-Enabled System Participant.
SUPPLIER: Marketing Carrier Participant.
A data type for Marketing Carrier Participant Role. Derived from AirlineMsgPartyCoreType.
The sequence number of this participating Party within the collection of parties.
Example: 1
Notes:
1. A sequence number of 1 indicates that this is the first Participant involved in the transaction.
SUPPLIER: Operating Carrier Participant.
A data type for ORA (Offer Originating Airline) Participant Role. Derived from AirlineMsgPartyCoreType.
The sequence number of this participating Party within the collection of parties.
Example: 1
Notes:
1. A sequence number of 1 indicates that this is the first Participant involved in the transaction.
A data type for Operating Carrier Participant Role. Derived from AirlineMsgPartyCoreType.
The sequence number of this participating Party within the collection of parties.
Example: 1
Notes:
1. A sequence number of 1 indicates that this is the first Participant involved in the transaction.
SUPPLIER: ORA (Offer Originating Airline) Participant.
SUPPLIER: POA (Participating Offer Airline) Participant.
A data type for POA (Participating Offer Airline) Participant Role. Derived from AirlineMsgPartyCoreType.
The sequence number of this participating Party within the collection of parties.
Example: 1
Notes:
1. A sequence number of 1 indicates that this is the first Participant involved in the transaction.
SUPPLIER: Retailer Participant.
A data type for Retailer Message Participant Role. Derived from RetailerMsgPartyCoreType.
The sequence number of this participating Party within the collection of parties.
Example: 1
Notes:
1. A sequence number of 1 indicates that this is the first Participant involved in the transaction.
SELLER: Travel Agency.
A data type for Travel Agency Message Participant Role. Derived from TravelAgencyMsgPartyCoreType.
The sequence number of this participating Party within the collection of parties.
Example: 1
Notes:
1. A sequence number of 1 indicates that this is the first Participant involved in the transaction.
A data type for Marketing Messages in a response message.
Marketing message.
Example: ONE Traveler MAY BE ELIGIBLE FOR A FREE SEAT
Marketing Message Association(s).
A data type for Marketing Message Association Base List.
A data type for Marketing Message Association List.
Marketing Message Associations.
General Marketing Message Association Detail.
Note: Includes an association type choice (e.g. MediaGroup) and an instance association value (e.g. mediagrp1).
Named association type. Examples: Equipment, MediaGroup
Associated object instance value. Example: mediagrp1
Error(s) that prevented message processing.
Message processing information that may include business warnings and marketing messages.
A collection of errors that occurred during the processing of a message.
Standard way to indicate that an error occurred during the processing of an IATA message
The Error element MUST contain the Type attribute that uses a recommended set of values to indicate the error type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown".
An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional contraint which contains the data of the node. This will provide the offending data back to systems that cannot maintain the original message.
Used for codes in the IATA code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
Used for strings, length 1 to 64.
Used to identify an application error by either text, code, or by an online description and also to give the status, tag, and/or identification of the record that may have caused the error.
An error in textual format.
If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to IATA PADIS Code List data element 9321.
If present, this URL refers to an online description of the error that occurred.
If present, recommended values are those enumerated in the IATA_ErrorRS, (NotProcessed | Incomplete | Complete | Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.
If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].
If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records.
Used to specify the owner of the error/warning codelist.
Used for strings, length 1 to 32.
Textual information to provide descriptions and/or additional information.
Identifies language.
Language identification.
A data type for a Fatal Processing Error.
Error detail.
Error type.
Example: Authentication, ExpiredCredential, FieldValidation, Unknown
Error code. Example: NOAUTH
Error Code Definition. Example: Invalid Point of Sale Credentials
URL to an online description of the error.
Example: http://www.airline.com/ErrorCodes
When TRUE, the request message may be resent.
Note: This is typically used for a processing timeout condition.
A data type for Message Processing Results.
May include errors, business warnings, alternate offers indicator, supplemental marketing messages and/ or additional information required to complete a transaction.
Marketing Messages and Information.
Notes: Marketing messages specified here apply to all message results, e.g. they are at a message-wide level.
NDC Transaction Processing Status. Examples: Complete, InComplete, Unknown Note: If the status is "InComplete" the Alerts node should be parsed.
The payload content in this NDC message. Encoding Scheme: IATA Padis Codeset - Data Element [MPS] Response Type, coded
Transaction Processing Alert.
Note: Alerts contain processing results that must be mitigated before transaction processing can continue -or- have resulted in successful, but incomplete transaction processing.
Transaction Processing Alert(s).
Note: Alerts contain processing information have resulted in successful, but incomplete transaction processing and/ or are part of an ongoing transaction.
PROCESSING ALERT definition.
PROCESSING ALERTS definition.
Alert detail.
Payment Authorization Failure information.
Payment Failure Code (and optional definition.)
Encoding Scheme: IATA Padis Codeset - List for data element [9321] Application Error, coded
Payment Remark(s).
When TRUE, this payment form has failed.
Inventory Discrepancy Notice.
Supports notifying seller systems of discrepancy(s) between offered inventory (from a prior shopping response) and available inventory during order processing. If included in a response message, it may also include alternate offers.
Inventory Discrepency Alert definition.
Note: This processing condition occurs when there is a discrepency between offered inventory and available inventory. It may include references to Alternate Offers.
Inventory Availability Status Code.
IATA Padis Codeset - List for data element 9321. Used in conjunction with Association(s) (Passenger, Group, Order Item, Offer Item and Optional Service) AnternateOffers (Alternate Offer(s) and Remarks (Payment remarks(s)).
Inventory Discrepency Alert Association(s), including Order, Order Item, Passenger, Group, Offer Item and Service.
Alternate Offer(s).
The total number of Alternate Offers provided by this Airline. Example: 12
Airline designator of the owner/ assigner of the Offer ID, typically used for offer ordering purposes. Example: UA, BA
Encoding Scheme: IATA/ A4A (two or three character) Airline Designator Code
Airline Alternate Offer Detail.
When TRUE, the inventory for the Offer Item is not available to order.
Shopping and Order Multiple Association definition.
Traveler Authentication Requested.
Notes:
1. This processing condition occurs when additional Traveler authentication is required to complete transaction processing, such as access to secure FQTV information to complete Order pricing.
2. This information contains the authentication scheme request information, e.g. parameters for Pin Phrase factor authentication.
3. Multiple Travelers may be authentication requests may be specified.
Traveler Authentication definition.
Notes:
1. The AuthQuestion is returned as an Alert in a Shopping or Order response message.
2. The AuthAnswer is returned as an Alert in a Shopping or Order request message.
3. Note that the CustomerInputRQ may be used to send an authentication response in lieue of using an alert in a request message.
PIN Phrase Authentication Request.
When TRUE, fulfullment of this Order requires additional Traveler authentication.
When TRUE, the maximum Authentication attempts have been exceeded.
When TRUE, the Authentication transaction should be resent.
PIN Phrase Authentication Response.
Traveler Authentication Challenge Answer definition.
Traveler Authentication process status.
Examples:
Y- Customer authenticated
N- Customer not authenticated
A- An authentication attempt occurred but could not be completed
U- Unable to perform authentication
Authentication Status Context.
PIN Answer.
Example: BTSY
Original Credentialing Question. Example: What is a memorable place?
Pre-defined Account information.
Mobile Device information.
Device Location geocoding information.
The identifier of the original transaction that initiated this Traveler authentication. Example: TRN12345
ID or name of the source of this Transaction ID. Examples: UA, ABC123
Note: If this is an airline ID, use IATA/ A4A (two or three character) Airline Designator Code Encoding Scheme.
Payment Form Issue Alert definition.
Supported Use Cases:
- Incomplete: Payment Failure (pre-authorized hold and payment)
- Incomplete: Payment System Timeout, etc. (with RetryInd)
Payment Form Detail.
URL to an online description of the alert.
Example: http://www.airline.com/AlertPage
The processing status for this Payment Form. Examples: Success With Warnings, More Information Required
Encoding Scheme: IATA Padis Codeset - Data Element [4343] Response Type, coded
Status for this Payment Form. Examples: Canceled, Complete, Incomplete, Partial
Payment Alert Status context.
Payment Authorization Failure information.
Payment Failure Code (and optional definition.)
Encoding Scheme: IATA Padis Codeset - List for data element [9321] Application Error, coded
Payment Remark(s).
When TRUE, this payment form has failed.
Incomplete Payment information.
Incomplete Payment Status Code.
IATA Padis Codeset - List for data element 9321. Used in conjunction with Association(s) (Passenger, Group, Order Item, Offer Item and Optional Service) and Remarks (Payment remarks(s)).
Payment Remark(s).
When TRUE, the payment could not be processed due to a price differential (between the specified Offer Item price and the calculated order price) that exceeds specified rules.
Traveler Authentication Challenge Question definition.
Traveler Authentication process status.
Examples:
Y- Customer authenticated
N- Customer not authenticated
A- An authentication attempt occurred but could not be completed
U- Unable to perform authentication
Authentication Status Context.
Pin Phrase Challenge information, including source URL and challenge parameters.
URL to source location for authentication service, instructions, etc.
End User Parameters, including challenge question and phrase prompt.
Challenge Question.
Example: What is a memorable place?
Answer Characters Prompt.
Example: Please provide the 1st, 3rd, 4th and the last characters from your memorable place.
Requested Character Positions.
Note: This is a character position array that may be used in association with the Prompt.
Character Position. Example: 5
Traveler Authentication Request Association(s), including Order, Order Item, Passenger, Group, Offer Item and Service.
Pre-defined Account information.
Traveler Device information.
Device Location geocoding information.
The identifier of the original transaction that initiated this Traveler authentication. Example: TRN12345
ID or name of the source of this Transaction ID. Examples: UA, ABC123
Note: If this is an airline ID, use IATA 2 character or ICAO 3 letter Airline Designator Code Encoding Scheme.
3D Secure Payment Processing information.
SECURE PAYMENT definiton.
Payer Authentication Request or Response structure.
Payer Authentication Request value.
Example: eNp1UttugzAM/RXE+0gosF5kUkFZtT506rp222sUvJatXBqgtPv6JQzW7WFRIvnY1rF9HJie04NxQlk
meeabtkVNAzO/GAw==
Payer Authentication Response value.
Example: eJzVWFmzosgSfudXdPQ8Gt1sbkzYRhQ7KCjI/sYOsimgoL/+lp7Tp5c5t2d67tMw8yv/WqiluJXS8WyyVFEQT28qz
Note: This is the PARes (Payer Authentication Response) to be POSTed back to the TermURL (the URL to which the user will be directed at the conclusion of 3D secure authentication.)
3D Secure Transaction Type.
Examples:
Authorize: Authorize amount (no funds transferred)
Complete: Complete a previous authorization (funds are transferred)
Purchase: Purchase (funds are transferred immediately)
Refund: Refund (funds transferred immediately)
Validate: Validation Transaction (a small authorized transaction amount to validate card details including expiry date and address)
Transaction Type context.
3D Secure Program Enrollment Status. Examples: CardNotEnrolled, CardEnrolled, CardMayBeEnrolled, Unknown
Enrollment Status context.
Airline 3D Secure Payment Merchant Account information.
Airline Merchant Identification Code or Number. Example: BA123
Airline Merchant ID context.
Merchant Name. Example: SecurePay
Airline Merchant Name context.
Airline Merchant Country Code. Example: GB
Encoding Scheme: ISO 3166-1 (two character) Country Code
Transaction Reference(s).
The identifier of the original transaction that initiated this Traveler authentication. Example: TRN12345
ID or name of the source of this Transaction ID. Examples: UA, ABC123
Note: If this is an airline ID, use IATA/ A4A (two or three character) Airline Designator Code Encoding Scheme.
3DS Transaction Timestamp. Example: 2015-01-13T13:59:38Z
Transaction description. Example: Air Fare Two PAX
Other (free form text) Transaction Data(s).
Other Transaction Data.
Airline and 3DS Merchant URL(s).
3D Secure Payment Details, including 3DS Transaction Client, Customer Device, Input and Settlement Currency, Order Reservation Detail, Transaction Timestamp and Additional Data.
3DS Transaction Timestamp. Example: 2015-01-13T13:59:38Z
3DS TransactionClient Type.
Examples:
InteractiveVoiceResponse (IVR)
Internet
MailOrTelephoneOrder (MOTO)
Recurring
Unattended
Client Type context.
Device upon which the secure transaction will occur.
Browser Accept Header.
Note: This contains MIME types accepted by the device.
User Agent String.
Note: This contains the user agent string.
Device type. Example: Desktop, Mobile
Note: This is the device that the transaction will occur on.
Input and Settlement Currency Code(s).
Input Payment Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
Settlement Payment Currency code. Example: CHF
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
3D Secure Transaction Airline Reservation information.
Other (free form text) Transaction Data(s).
Other Transaction Data.
Secure Payment-related Processing information, including AVS/ CVV Verification Results and Secure Payment Processing Results.
Processing Information detail.
Address Verification Status Response information.
AVS Response Code.
Examples:
X - Match: Street address and 9-digit ZIP code both match
Y - Match: Street address and 5-digit ZIP code both match
A - Partial Match: Street address matches, but both 5-digit and 9-digit ZIP Code do not match
W - Partial Match: Street address does not match, but 9-digit ZIP code matches
Z - Partial Match: Street address does not match, but 5-digit ZIP code matches
N - No Match: Street address, 5-digit ZIP code, and 9-digit ZIP code all do not match
U - System Unavailable: Address information unavailable. Returned if non-US. AVS is not available or if the AVS in a U.S. bank is not functioning properly.
R - System Unavailable: Retry - Issuer's System Unavailable or Timed Out.
E - Invalid: AVS data is invalid
S - Not Supported: U.S. issuing bank does not support AVS
Note: This is the address verification response code (AVS) when the ticketing agency performs address verification.
Additional Response Text from 3DS Provider.
When TRUE, the specified address was invalid.
When TRUE, the specified address could not be matched with issuing bank address on record.
The unique Cardholder Authentication Verification Value (CAVV) associated with the transaction, provided by the card issuer.
Example: Q0FWVkNBVlZDQVZWQ0FWVkNBVlY=
Note: Only returned if card is enrolled and authenticated.
3DS Program ACS Customer Authention Status.
Examples:
Y- Customer authenticated.
N- Customer not authenticated.
A- An authentication attempt occurred but could not be completed.
U- Unable to perform authentication.
Note: Only returned if card is enrolled.
Enrollment Status context.
The ECI (E-Commerce Indicator) security level associated with the transaction.
Example: 05
Note: Only returned if card is enrolled and authenticated.
Unique 3D Secure transaction reference number assigned by Access Control System (ACS).
Example: Qzl3WVc1TVpXNW5kR2crUEcxbGMzTmhaMlZKWkQ1UVFWSmxjUzB4TWpnNUSXcKTmprNU5EWThMMjFsYzNOaFoyVkpRDQ4TDAxRVBqd3ZVVEr
Note: This is typically required for ACS systems that support Status Query.
Transaction Reference context.
The merchant name.
Note: The 3-D Secure specification specifies a maximum length of 25 characters.
3D Secure Transaction Airline Reservation information.
Note: This capability may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. If supported, the technical implementation of this capability is not dictated by this specification.
Unique Secure Payment Merchant (SPM)-assigned transaction reference number. Example: VEw4TkFrakFYMmEreXdoZE5xZUU=
Transaction Reference context.
SECURE PAYMENT AIRLINE RESERVATION definition.
Airline Carrier(s).
A two-character alpha-numeric code assigned by the IATA. Refer to IATA Coding Directory and IATA Resolution 762 for Airlines and 763 for Airports. Application attribute is used to indicate whether the airline is a marketing or an operating carrier.
Airline Carrier Application. Examples: Operating, Marketing
Data and time information used to enrich secure payment details. Used in conjunction with application identification attribute, to indicate date/ time application (I.e. departure, arrival, etc.).
Date, Time and Application.
Date. Example: 2017-01-13
Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)
Time. Example: 09:15
Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)
Date Application. Example: Departure, Arrival, Connection
Class(es) of Service.
Stop Location(s).
Stop Location details including arrival date and time, departure date and time and change of gauge.
A code that gives information regarding the type of fare, class entitlement, minimum and maximum validity, reservations entitlement, seasonality, days of travel and advertising or sales restrictions.
Flight Number(s).
Passenger Name. Example: John Smith
Note: This is the primary contact on the reservation.
Passenger Residence country code. Examples: US, FR
Encoding Scheme: ISO 3166-1 (two character) Country Code
Document Number assigned to this transaction comprised of the following:
• Airline Code - 3-digit Airline identification number (one character reserved for expansion)
• Form Code - A maximum of 3 digits indicating the type of document, the source of issue and the number of coupons it comprises,
• Serial No. - A maximum of 8 digits allocated on a sequential basis, provided that the total number of digits allocated to the Form Code and Serial Number shall not exceed ten.
Travel Agency Information.
Note; This typically contains the seller travel agency ID and/ or Name.
SECURE PAYMENT URL definition.
A data type for Airline and 3DS Merchant URL(s).
3DS Access Control System URL.
Note: This is the URL of the Issuing Bank's ACS, to which the cardholder needs to be re-directed. The browser should simply redirect to this URL.
Airline URL to which the user will be directed in the event of an secure auhorization failure.
Example: http://ba.com/paymentResultFailure
Verification Merchant website URL.
Note: This is the verification source merchant URL.
The URL to which the user will be directed to at the conclusion of 3D secure authentication.
Example: http://ba.com/paymentResultSuccess
A data type for Pre-established Account information.
Account ID. Examples: FQTV1234, [email protected]
Pre-established Account Name. Example: johns
First Name on Account. Example: John
Last Name on Account. Example: Smith
Transaction Processing Marketing Message(s). Note: Marketing messages specified here apply to all message results, e.g. they are at a message-wide level.
Marketing message. Example: ONE Traveler MAY BE ELIGIBLE FOR A FREE SEAT
Business Warning Association(s), including Order, Order Item, Passenger, Group, Offer Item and Service.
Transaction Processing Business Warning(s).
Business Warning(s).
Business warning type code and description. Encoding Scheme: IATA Padis Codeset - Error and Warnings
Business Warning Association(s), including Order, Order Item, Passenger, Group, Offer Item and Service.
Transaction Processing Notice(s). Note: Notices contain information about specific NDC capabilities being utilized during transaction processing.
Notice detail. Note: These capabilities may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. If supported, the technical implementation of the capability is not dictated by this specification.
Price Variance Rule(s) Notice. Note: Supports specifying Payment Processing Rules, including payment failure. Request messages may include defined payment processing rules and an indicator requesting that the rules be applied during payment processing where relevant. Response messages may additionally include notice about if and how payment rule(s) were applied during transaction processing.
Transaction Processing Notice(s). Note: Notices contain information about specific NDC capabilities being utilized during transaction processing.
Inventory Guarantee Notification. Supports requesting a guarantee for inventory-associated offers in a request message. Notification of any guaranteed inventory (e.g. status, reference number, time limit and associations) may be returned in a response message. Note that the inventory guarantee time limit is the time that inventory for a specified product offer is guaranteed as available and the inventory held must be converted into a completed order before the time limit expires otherwise the guarantee is lost. Held Inventory is referenced by an Inventory Guarantee identifier.
Payment Processing Rule(s) Notice. Note: Supports specifying Payment Processing Rules, including payment failure. Request messages may include defined payment processing rules and an indicator requesting that the rules be applied during payment processing where relevant. Response messages may additionally include notice about if and how payment rule(s) were applied during transaction processing.
Price Variance Rule(s) Notice. Note: Supports specifying Payment Processing Rules, including payment failure. Request messages may include defined payment processing rules and an indicator requesting that the rules be applied during payment processing where relevant. Response messages may additionally include notice about if and how payment rule(s) were applied during transaction processing.
Pricing Parameters Notice. Note: Supports specifying transaction pricing parameters. Request messages may include indicators requesting that certain methods be applied during payment processing where relevant. Response messages may additionally include notice about if and how pricing parameters were applied during transaction processing.
Optional Service Filter Notice. Note: Supports specifying optional service filters in request messages to inform a receving system of the category(s) of offers being requested. Response messages may additionally include notification of which (if any) service filters were applied during transaction processing.
Tax/ Fee Exemption Notice. Note: Supports notification to receiving system that tax/ fee exemptions are requested during transaction processing, and, if and how the exemptions were applied to message results.
Inventory Guarantee Notice definition.
Inventory Guarantee Request Notice.
When TRUE, inventory guarantee is requested for offers.
Inventory Guaranteed during transaction processing.
Inventory Guarantee
Unique Inventory Guarantee ID. Examples: INVREF123456, 68E0-675C Note: This is a unique identifier issued by an Airline to reference that inventory for a specified offer will be guaranteed as available for a period.
Inventory Guarantee Association(s), including Order, Order Item, Passenger, Group, Offer Item and Service.
When TRUE, no offers have guaranteed inventory .
Information Policy Notice definition.
Policy Detail.
When TRUE, data policy(s) have been specified for payload content.
Payload Content Localization Notice definition.
Payload Content Language Representation Code(s). Notes: 1. Payload content localized language representation in support of I18N aware systems. 2. Language Code context is specified in the @Application attribute, e.g. Requested, Display.
Payload Content Currency Representation Code(s). Notes: 1. Payload content localized currency representation in support of I18N aware systems. 2. Currency Code context is specified in the @Application attribute, e.g. Requested, Display. 3. This is not the point of sale currency that is specified in the PointOfSale node.
COMMON NOTICES definition.
Payload Content Localization Notice. Note: Supports i18n-enabled systems by notifying seller systems of language and currency preferences in request messages and language and currency application is response messages.
Information Policy Notice(s). Note: Supports specifying information policy notices at the message and/ or schema node level.
Payment Processing Rules Notice definition.
Form of Payment Failure Rules. Rule Application Scope: 1. Order ID (entire order) 2. Order Item ID (e.g. flights and ancillary services)
Payment Order Creation Rule(s).
When TRUE, the Seller wants to proceed with Order creation if one of multiple forms of payment provided fails. Note: This supports multi payment form-enabled systems where one Traveler may provide multiple FOPs, or individual Travelers may each provide their own FOP.
Payment Order Creation Rule Usage during transaction processing.
Payment Failure Code (and optional definition.) Encoding Scheme: IATA Padis Codeset - List for data element [9321] Application Error, coded
When TRUE, one of multiple forms of payment provided failed.
Acceptable Price Variance Rule definition. Note: This is the acceptable amount and/or percentage of the total amount by which the Order item price can vary from the Offer price for Order creation to proceed, for example to cover minor currency exchange rate fluctuations for taxes quoted in a different currency.
Price Variance Order Creation Rule(s).
Price Variance Rule detail.
Rule sequence (or order) number. Example: 1
Unique Rule ID. Example: PRICERULE001 Note: Optional rule context and name may also be specified.
Rule ID Context.
Rule Name. Example: Acceptable Order Item Price Variance
Acceptable amount and/or percentage of the total amount by which the Order item price can vary. Example: 20 USD, 2 Percent
Rule Name. Example: Acceptable Price variance
Entity that owns/ assigned this Rule. Example: BA Note: If this is an airline, the IATA/ A4A (two or three character) Airline Designator Code should be used.
Rule Effective Period.
Price Variance Rule applicable Input and Settlement Currency(s).
Note: This contains one or multiple input and settlement currency codes that this rule applies to. In addition to the specified currency code, an Application of InputCurrency and/ or SettlementCurrency should be specified.
Input Payment Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code
Settlement Payment Currency code. Example: CHF Encoding Scheme: ISO 4217 (three alpha character) Currency Code
When TRUE, price variance rule(s) have been specified.
Price Variance Order Creation Rule(s) Usage during transaction processing.
Applied Price Variance Rule(s).
Unique Rule ID which was applied during transaction processing. Example: PRICERULE001 Note: Optional rule context and name may also be specified.
Rule ID Context.
Rule Name. Example: Acceptable Order Item Price Variance
Applied Price Variance Amount and/or Percentage. Example: 20 USD, 2 Percent
Order ID, Order Item and other associations where a price variance was applied.
When TRUE, a pricing variant was applied to the total order price or one or more priced Order Items.
Pricing Parameters Notice definition.
Requested Pricing Parameter(s).
When TRUE, this request is to be handled by an auto-exchange process.
When TRUE, award eligible in addition to priced offers and fares is requested.
When TRUE, only award eligible offers/ fares are requested.
When TRUE, Simple Pricing for flight offers is requested.
Pricing Parameter application in transaction processing.
When TRUE, this request was handled by an auto-exchange process.
When TRUE, award eligible in addition to priced offers and fares are included in the results.
When TRUE, only award eligible offers/ fares have been returned.
When TRUE, Simple Pricing for flight offers was applied.
Optional Service Filter Notification. Note: Supports ATPCO group and subgroup code(s) that specify the requested categories of Optional Services to be returned in the results.
Alternate Offer Rules.
Optional Service Filter(s).
Alternate Offers created during transaction processing.
Optional Service Filter(s) applied during transaction processing. Note: This is a list of requested optional service filters that apply to returned offers.
Applied Optional Service Filter(s).
Association(s).
Shopping Offer Association(s).
Associated Shoppers. Note: Includes Anonymous, Recognized and/or PTC shopper association.
Associated Flight(s).
Associated Price Class information.
Baggage Detail Associations.
Offer Detail Association(s).
Other Named Association(s). Note: Includes an association type choice (e.g. MediaGroup) and an instance association value (e.g. mediagrp1).
Named Instance Association Type. Examples: CarryOnAllowance, MediaGroup
Associated object instance value. Example: mediagrp1
Order Association(s).
When TRUE, service filters specified in the request message have resulted in offers in this reponse.
Pricing-related Fee and Tax Exemption Notice definition.
Exemption Rule(s).
Named Tax Exemptions, including Country(s), Entity(s), Territory(s) and Tax Code(s).
Exempt tax country information.
Name of entity to which passenger belongs, indicating an exemption to the application of a tax.
Example: Military, Government
Exempt tax entity name. Example: Military, IBM
Name or code of state or territory used to identify tax exemptions.
Codes are published in Appendix C of IATA AIRIMP.
Exempt tax province/ territory name or code. Example: QC
Exempt Tax Code(s). Note: This contains tax exemption(s) based on tax designator and nature.
Tax Code detail.
Tax designator. Example: XY
Tax nature. Example: I
Additional Tax Exemption Rule(s).
When TRUE, all pricing is tax/ fee exempt.
Exemption Rule(s) applied during transaction processing.
Applied Tax Exemption(s).
Unique Rule ID which was applied during transaction processing. Example: PRICERULE001 Note: Optional rule context and name may also be specified.
Rule ID Context.
Rule Name. Example: Acceptable Order Item Price Variance
Order ID, Order Item and other associations where a price variance was applied.
When TRUE, a tax/ fee exemption was applied to the total order price or one or more priced Order Items.
A data type definition for Encoding Scheme.
Encoding Scheme Characteristics, including name, purpose, type, source uri, version and supported domains.
Supported NDC Domains by scheme version.
Supported NDC Domain Name.
Examples: Shopping, OrderManagement, PaymentTicketing, AirlineProfile, Utility
Note: Supports pre-defined enumerated list and/ or bilaterally-agreed upon values.
Associated Encoding Scheme Version(s). Example: 1.7, 1.0 - 1.7
Encoding Scheme Name. Example: Optional Service Encoding
Vocabulary Purpose. Example: Optional Service Encoding
Encoding Scheme Source Location URI.
Encoding Scheme Version. Example: 1.7
Encoding Scheme Metadata, including timestamp and remark.
Note: Information and/ or capabilities specified in Metadata may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. If supported, the technical implementation is not dictated by this specification.
Remark(s).
Scheme Timestamp. Example: 2017-01-13T13:59:38Z
Encoding Scheme globally unique instance/ class Key.
Example: 8wOlMeZCT5+kR+mdfzsRlA
Owner Airline (or other entity) Code. Examples: BA, WIDGETCO
Scheme Owner Type.
Examples: Airline, Filed, ThirdParty
Note: Supports pre-defined enumerated list and/ or bilaterally-agreed upon values.
Scheme Owner Name. Example: British Airways
Encoding Scheme Token, e.g. reference association ID.
Example: jZhJu7SORZeOMNpifElIkA
A data type definition for Policy.
Policy Data Node information.
Note: Describes schema document node location, including node tag name and path, for data with associated policy.
Policy Data Node detail.
Policy Description, including text and link.
Policy Description, including text and link.
Policy Metadata, including policy effective period.
Note: Information and/ or capabilities specified in Metadata may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. If supported, the technical implementation is not dictated by this specification.
Remark(s).
Encoding Scheme information.
Policy Effective and Expiration Period.
Policy Code or ID. Example: DATA1
Policy Type. Examples: Privacy_PII, Payment_PCI, Credentialing
Note: Supports pre-defined enumerated list and/ or bilaterally-agreed upon values.
Policy Version. Example: 2.17
NDC XML SPECIFICATION: NDC DATA LISTS shared by all NDC Domains.
Notice: This is NDC Draft Specification provided for pre-review by the members of the relevant governance groups, it is not provided for implementation in a production environment or considered to be the final schema to support NDC business requirements. The draft schema may, at any time up to final specification submission, undergo changes including, but not limited to, specific elements, element names/labels, annotations or message name as a result of the ongoing quality control process, and comments, which may be received following the pre-review. Implementation of this version is done so at the risk of the implementer or implementing company.
Common NDC Data List choices.
Description Details
List of flight segments.
FlighSegment information. Contains details flight segment information.
List of Flight elements.
Journey information describing the travel between an airport/city where travel commences and an airport/city where travel ultimately terminates. A journey may be comprised of one or more segments. Note: This node will be renamed to journey in future releases.
Flight journey information.
A globally unique identifier for this Flight instance. Example: flight1
List of Origin/Destination elements.
Optional Seat(s) List.
Seat Detail.
Baggage Disclosure(s).
Checked Baggage Allowance.
Carry-On Allowance.
BAGGAGE ALLOWANCE data list definition.
Checked Bag Allowance detail.
US DOT BAGGAGE RULE data list definition.
Select a value from the enumerated list or enter a string value.
=enumerated values=
N = NOT SUBJECT TO US DOT RESERVATION OR DISCLOSURE
Y = SUBJECT TO US DOT RESERVATION AND DISCLOSURE
D = SUBJECT TO DISCLOSURE BUT NOT TO US DOT RESERVATION
Baggage Disclosure detail.
US Department of Transportation (DOT) Reservation or Disclosure baggage rule.
Examples: Y, Disclosure AND US DOT Reservation
CARRY-ON ALLOWANCE data list definition.
Carry-on Allowance detail.
Company(s).
Content Source or Owner.
CONTENT SOURCE data list definition.
XPath to element or attribute in the message.
Encoding Scheme: W3C xPath Notation
Choice of Airline or Other (non-airline) source identifier.
Other source identifier.
Example: DLX
Other ID name.
Example: Datalex
A data type definition for Plain Text with Link Description.
Link(s).
Description Link. Example: thisairline.com/myLink
Link Description(s).
Description detail.
Language Code. Example: en, en-US
Creation Timestamp. Example: 2017-01-13T13:59:38Z
Title. Example: This Title
A data type definition for URI with Formatting.
Link detail.
Link Context.
Link Text. Example: Visit Program Benefits
Link Value. Example: www.thislink.com
Airline and Offer Disclosures.
DISCLOSURE data list definition.
Disclosure Description or Link.
Plain Text or Rich Media Disclosure Description(s).
Element combining Fare Basis Code and Fare Details.
Fare detail.
Fare Basis Code detail.
Fare basis code. Example: Y26
Fare basis application.
Examples: Requested, Ticketed, Other
Includes Class of Service details.
Flight origin/ destination information.
Marketing Carrier information.
Operating Carrier Information.
Operating Carrier is the carrier that operates a flight with a reference to its own prime flight number.
Note: Operating Carrier may be different from a Marketing Carrier(s), if the flight is actually marketed by another carrier(s) within a codeshare agreement.
Operating Carrier may not be the AOC holder, in which case, and wherever required, this will need to be disclosed to the customer.
Flight Details.
A globally unique identifier for this Flight Segment instance. Example: segment1
When TRUE, there are one or more connections for this flight.
When TRUE, an electronic ticket may be issued.
When TRUE, the fare can be purchased without issuing a ticket.
A data type for a list of Classes of Service.
Class of Service.
Class of Service. Example: T
Name. Example: Economy
Class of Service Association(s).
MEDIA data list definition.
Media Choices.
Description-associated MEDIA OBJECT ID or Key. Example: IMG1
Description-associated MEDIA LINK.
Description-associated Media Attachment ID. Example: ATT1.
Multi-Media/ Rich Descriptions.
Offer/ Order Instruction(s).
OFFER/OFFER ITEM INSTRUCTIONS data list definition.
Offer Instruction detail.
OFFER/OFFER ITEM PENALTY data list definition.
Penalty detail.
OFFER/OFFER ITEM TERMS data list definition.
Terms detail.
Offer/ Order Penalty(s).
Offer/ Order Term(s).
PRICE CLASS data list definition.
Price Class List.
OPTIONAL SERVICE Data List definition.
Service Detail.
Service name.Example: Lounge Pass
Service Codes and Reason for Issuance.
Two character generic code to identify ticket level charges, fees and taxes.
SERVICE Description.
Note: Supports plain text, multimedia and code and link references.
Interline Settlement information between airlines, including method of settlement, interline settlement value and currency.
Service settlement method.
Examples:
AD (Internal Airline Document)
DS (Direct Settlement)
EA (EMD Associated or Internal Airline Document)
ES (EMD Standalone )
FI (Fare Integrated)
MA (Flight Associated)
MS (Standalone)
Encoding Scheme: IATA PADIS Codeset SST (Service Settlement Type)
Settlement (Price) Value. Example: 300 (USD)
Note: This represents a Settlement value that is only used between the POA and ORA.
Optional SERVICE PRICE.
Notes: This Price amount may be set to zero if pricing has been applied at the Offer Item level.
Other Service Association(s).
OPTIONAL SERVICE BUNDLE Data List definition.
Individual service items in bundle count. Example: 4
Associated Services.
Minimum and Maximum Bundle Item Selection rules.
MINIMUM quantity of bundle items that must be selected. Example: 2
MAXIMUM quantity of bundle items that may be selected. Example: 4
Unique Bundle ID. Example: BNDL-001
Price for Bundled service
Name of Bundle
Optional Service(s) List.
Optional Service Bundle(s) List.
AnomymousTraveler data list definition.
Recognized Traveler data list definition.
RECOGNIZED (AUTHENTICATED) TRAVELER.
NDC XML SPECIFICATION: FARE XML OBJECT
Notice: This is NDC Draft Specification provided for pre-review by the members of the relevant governance groups, it is not provided for implementation in a production environment or considered to be the final schema to support NDC business requirements. The draft schema may, at any time up to final specification submission, undergo changes including, but not limited to, specific elements, element names/labels, annotations or message name as a result of the ongoing quality control process, and comments, which may be received following the pre-review. Implementation of this version is done so at the risk of the implementer or implementing company.
A data type for Fare Amount Type list
Examples: BT (Bulk); IT (Tour Inclusive)
Additional collection
A data type for Fare Global Indicator contextual list.
FareByRule, All fares included (EH/TS)
Via Atlantic Pacific
Via Atlantic
Within Canada.
Circle trip.
Within Eastern Hemisphere
Far East
FareByRule - For int'l incl.
AT/PA/WH/CT/RW
FareByRule for North America incl
US/CA/TB/PV
Via Pacific
Via Pacific and via North America
Via Polar Route.
Russia - Area 3
Round The World.
South Atlantic only
Via South Polar Route
Trans-border
Via Siberia.
Within the United States.
Within Western Hemisphere
Any Global
A data type for Fare Application.
A data type for Fare Application list constraint.
Examples: Requested, Ticketed, Other
A data type for Fare Basis Application.
Fare Type Code.
Examples:
70J, Published Fares
70K, Dynamic Discounted Fares
749, Negotiated Fares
756, One Way Fare
758, Private Fares
Encoding Scheme: PADIS codeset element 9910 - Fare Qualifier
Fare Basis Code with optional application. Example: Y26
FARE TYPE CODE definition.
Fare type.
Examples:
70J, Published Fares
70K, Dynamic Discounted Fares
749, Negotiated Fares
756, One Way Fare
758, Private Fares
Encoding Scheme: PADIS codeset element 9910 - Fare Qualifier
NDC Capability Model: FARE - FARE CODE
============
Representation(s)
============
• Encoding Scheme: PADIS codeset element 9910 - Fare Qualifier
============
Metadata
============
• FareMetadata
DETAIL FARE BASIS, including code, price class name and application.
NDC Capability Model: FARE - FARE BASIS CODE
============
Feature(s)
============
• Fare Basis Application (usage context) maybe specified (e.g. Requested, Ticketed, Other).
============
Metadata
============
• FareMetadata
Fare basis code. Example: Y26
Fare basis application.
Examples: Requested, Ticketed, Other
Fare information.
FARE definition.
NDC Capability Model: FARE
============
Representation(s)
============
• Core Fare information
• Detail Fare information (Fare Component, Fare Rules)
============
Feature(s)
============
• Fare Indicators for Cat35 Fare, Reissue Pricing, Auto Exchange Pricing
• Fare Code (PADIS codeset element 9910 - Fare Qualifier)
============
Metadata
============
• FareMetadata
Fare Detail, including Fare Component and Fare Rules.
FARE DETAIL definition.
NDC Capability Model: FARE - FARE DETAIL
============
Representation(s)
============
• Fare Component information
• Fare Rules information
============
Feature(s)
============
• Fare Code Indicator to represent pricing method (IATA PADIS Code List for data element 5387 - Price Type Qualifier)
• Price Class association
• Associated Flight Mileage
• Fare Remarks
• Tour Code support (A special code arranged between the travel agency and the sales representative for a particular airline. When the agent enters the tour code into the reservation and ticketing system, it will input certain information onto the ticket. For example, agent commisions, specific fare fules that supercede the published fare rules etc.)
============
Metadata
============
• FareMetadata
Fare code indicator. Example: 1 (SYSTEM PRICED WITHOUT MANUAL INTERVENTION)
Encoding Scheme: IATA PADIS Code List for data element 5387 - Price Type Qualifier
Fare Component information with Price Breakdown.
Associated Price Class.
Advance Purchase Restriction Value. Example: P7D (7 days)
Restriction context. Example: EARLIEST, LATEST, Other
Information relating to published fare rules that define the time prior to the flight departure that a reservation must be made, or a ticket must be issued.
Advance reservation/ ticketing value. Example: P14D
Restriction context. Example: EARLIEST, LATEST, Other
Advance departure value. Example: P3D (3 days)
Restriction context. Example: EARLIEST, LATEST, Other
Corporate Fare information.
Company profile index associated with this special fare. Example: COM1234
Contract ID used for pricing special fares. Example: 675124
Corporate account name or ID used for pricing special fares. Example: 675124
A repeatable field containing a string of data reflecting the fare construction applicable to the transaction and, when applicable, the breakdown for Passenger Facility Charges and U.S. Flight Segment Taxes. This represents the fare calculation as it would appear on a paper flight coupon.
Fare Rules.
FARE RULES definition.
NDC Capability Model: FARE - FARE DETAIL- FARE RULES
============
Feature(s)
============
• Fare Penalty information
• Corporate Fare information
• Advance Ticketing, Purchase, Minimum and Maximum Stay Requirements
• Ticketing Instructions
• Fare Rule Remarks
============
Metadata
============
• FareRuleMetadata
Advance Ticketing, Advance Purchase, Minimum Stay and Maximum Stay.
Ticketing information.
When TRUE, the Fare can be Purchased Without Issuing a Ticket.
Remarks provided to ensure common understanding between the passenger and an Airline when a fare is restricted as to time of travel, period of validity, voluntary rerouting, or where any other restricting conditions are applicable which are not otherwise clearly evident from other entries
Ticket endorsement text.
Example: NONREF
Fare Remark(s).
Minimum Stay Requirement information.
Minimum number of stay days permitted in the fare (offer) rules.
Example: 14
Restriction context. Example: EARLIEST, LATEST, Other
Minimum stay represented as a week day number. Example: 1 (Monday)
Maximum Stay Requirement information.
Maximum number of stay days permitted in the fare (offer) rules.
Restriction context. Example: EARLIEST, LATEST, Other
Maximum stay represented as a week day number. Example: 1 (Monday)
Tour Code. Example: ITGF12
Fare Component information as may be appliable in filed fares scenarios.
FARE COMPONENT definition.
Fare Component-related parameters.
The total number of fare components within the fare component calculation. Example: 2
Fare Component Pricing information.
Price Break-down per Fare Component.
Fare Basis information, including Fare Basis Code, Fare Rule Remarks and Fare Basis City Pair.
Reservation Booking Designator or Booking Class e.g. T
Fare Rule Subset for this Fare Component.
Note: For full fare rule retrieval, use the FareRulesRQ/RS message pair.
NDC Capability Model: FARE - FARE RULES - REMARKS
============
Description
============
Fare Rule collection (group) for an associated Fare Component.
============
Representation(s)
============
• Scheme: IATA PADIS codeset FRC-Fare Rule Category
============
Feature(s)
============
• Fare Basis Code-associated Fare Rule Category Code and Description.
============
Metadata
============
• FareRuleMetadata
Category-Related Fare Rule Subset.
Fare rule category (associated with FareBasisCode.)
Example: ACC (Accompanied Travel)
Encoding Scheme: IATA PADIS codeset FRC-Fare Rule Category
Fare Rule Text.
Identified published fare. Origin and destination city codes and two character designator of fare owning airline associated with Fare Basis Code.
Example: MIANCEDL
Market Name provided by Pricing Engine. Example: Zone45
Mileage Zone Provided by Pricing Engine.
Fare Filing information. As may be applicable in filed fares scenarios
FARE FILING definition.
Filed fare amount.
Example: 2385 USD
Note: This contains the originally filed base fare amount.
Fare neutral unit of construction amount.
Example: 4327
Note: This contains the fare amount expressed in Neutral Units of Construction (NUC) values rather than in any currency for provisional billing purposes by airline revenue accounting departments.
Applicable exchange rate. Example: 1 : 0.895
Ticket masked value. Examples: IT, BT
Filed fare information that may contain specific indicators applicable to the use of filed fares scenarios.
File Fare definition.
Fare global indicator.
Example: AT (Via Atlantic)
When TRUE, this is a Cat35 C-Type Net Fare.
Filed fare information that may contain specific indicators applicable to the use of filed fares scenarios.
Fare Cache Key.
Example: BE06F479-BB6E-4206-837B-BBCE8ABB1F6D
The identifier reflecting the method of pricing for the transaction as entered on the ticket.
0 = Indicates that a fare has been system computer priced and that no change has been made to the
reservation between pricing and ticket issuance with no manipulation of the fare, or any data filed with
the fare, including taxes, fees and charges and applicable standard fare conditions in accordance with
Tariff Resolutions 100 and 101 with the exception of the Tour Code.
1 = Identifies a manually built fare
2 = Identifies a fare that was auto-priced, but baggage and/or TFC data has been manipulated.
Fare Qualifier Code(s).
Unique Fare Reference Key. Example: PQ123456
Fare Rule Category. Example: ACC (Accompanied TravelL)
Encoding Scheme: IATA PADIS code list FRC-Fare Rule Category
Fare Text Indicator. Examples: A (Full Text), B (Mini Rule)
FARE BASE PRICE definition.
Total Base Fare Amount. Example: 200000
Note: This includes surcharges (if applicable).
Applicable Surcharge(s).
Surcharge detail.
AWARD (Redemption Unit-based) Pricing information.
PARTIAL CURRENCY and AWARD Pricing Combination information.
FARE PRICE DETAIL definition.
Ticket Tax/fee/charge details to indicate taxes that apply to country of commencement of travel and routing.
Actual travel date requested by Traveler. Example: 2017-01-13
Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)
Alignment with the actual travel date requested by the Traveler. Example: ADA (AFTER DATE BASED ON ARRIVAL)
Encoding Scheme: IATA PADIS code list CSD-Calendar Shopping Date
Order FARE DETAIL definition.
Fare Component information with Price Breakdown.
Fare Rules.
Order FARE RULES definition.
Advance Ticketing, Advance Purchase, Minimum Stay and Maximum Stay.
Fare Remark(s).
NDC XML SPECIFICATION: FLIGHT XML OBJECT
A data type for Class of Service Optional Associations.
A data type for Class of Service Association Type Name.
A data type for Flight Class of Service encoding constraint.
A data type for Flight Duration Application contextual list.
Examples: FlightTime, ConnectionTime, StopTime, TotalJourneyTime
A data type for Flight Duration Application.
Examples: FlightTime, ConnectionTime, StopTime, TotalJourneyTime
A data type for Flight Segment Type list constraint.
A data type for Flight Mileage Application.
Class of Service Associations.
OtherClass of Service Associations.
Other Association Detail.
Note: Includes an association type choice (e.g. MediaGroup) and an instance association value (e.g. mediagrp1).
Named association type. Examples: Equipment, MediaGroup
Associated object instance value. Example: mediagrp1
Flight Number. Example: 1234, or OPEN, or ARNK
Flight Operational Suffix
Identifies a flight number (1 to 4 numbers) or OPEN or ARNK.
Used in lieu of a flight number when a specific flight number is unknown but service is present.
Used in lieu of a flight number when surface transportation is used when there is a break in the continuity of the flight itinerary.
Class of Service. Example: T
A data type for Class of Service Core.
Class of service code.
Example: B
Class of Service Code. Example: B
Inidcates how many seats are still available in this class of service.
Cabin Class Marketing Name. Example: Premium Economy
Designator code for the cabin. Example: Y
Stop Location(s).
Note: This contains information about the stops for the specified flight number.
FLIGHT STOP LOCATION definition.
Stop Location detail.
Airport Name. Example: Tampa International
Stop Arrival date. Example: 2017-01-14
Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)
Arrival time. Example: 09:15
Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)
Scheduled Departure Date. Example: 2017-01-13
Note: This is the date and time of departure in GMT from the unticketed point.
Departure time. Example: 09:15
Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)
Flight Stop Groundtime.
Example: PT5M (45 minutes)
When TRUE, there has been a Change of Gauge.
Arrival (destination) Airport, Date and Time information.
Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory . Example: TPA
Search Radius for specified Airport or City code.
Departure (origin) Airport, Date and Time information.
Departure (origin) Airport Code.
Search Radius for specified Airport or City code.
Departure Date. Example: 2017-01-11
FLIGHT DEPARTURE definition.
Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory . Example: TPA
Search Radius for specified Airport or City code.
Departure date. Example: 2017-01-13
Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)
Departure time. Example: 09:15
Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)
Airport Name. Example: Tampa International
Airport terminal name and gate.
Refer to IATA SSIM Appendix D for terminal codes and terminal names.
Terminal name or ID. Example: Terminal C
Terminal Gate Number. Example: C39
FLIGHT ARRIVAL definition.
Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory . Example: TPA
Search Radius for specified Airport or City code.
Arrival date. Example: 2017-01-14
Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)
Arrival time. Example: 09:15
Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)
Number of days between arrival and departure. Example: 1
Airport Name. Example: Geneva International Airport
Airport terminal name and gate.
Refer to IATA SSIM Appendix D for terminal codes and terminal names.
Terminal name or ID. Example: Terminal C
Terminal Gate Number. Example: C39
A data type for a Flight.
Flight origin/ destination information.
Flight-related boolean indicators.
When TRUE, this flight OD pair should be priced.
When TRUE, there are one or more connections for this flight.
When TRUE, an electronic ticket may be issued.
When TRUE, the fare can be purchased without issuing a ticket.
Current status of the Order Item and related indicators.
Current Order Item status. Example: OK (Confirmed) Encoding Scheme: IATA Padis Codeset - List for data element 4405 (Status, coded)
When TRUE, the order item cannot be fulfilled due to an aircraft change.
When TRUE, the order item cannot be fulfilled due to a flight schedule change.
Marketing Carrier information.
Notes: This is the carrier that sells with its own code as part of a code share agreement on a flight that is actually operated by another carrier.
Operating Carrier Information.
Operating Carrier is the carrier that operates a flight with a reference to its own prime flight number.
Note: Operating Carrier may be different from a Marketing Carrier(s), if the flight is actually marketed by another carrier(s) within a codeshare agreement.
Operating Carrier may not be the AOC holder, in which case, and wherever required, this will need to be disclosed to the customer.
Flight Details.
FLIGHT DETAIL definition.
Flight Stop Quantity and Location(s).
Stop Quantity. Example: 1
Tour Operator Flight ID.
Note: This is an ID for the flight as represented by a Tour Operator. This flight is not necessarily in the inventory of an airline as it is a code created by tour operators.
A data type for a Flight with no O/D information.
Flight origin/ destination information.
Marketing Carrier information.
Notes: This is the carrier that sells with its own code as part of a code share agreement on a flight that is actually operated by another carrier.
Aircraft Equipment.
Note: Two instances of aircraft equipment may be specified if there is a change of gauge.
Operating Carrier Information.
Operating Carrier is the carrier that operates a flight with a reference to its own prime flight number.
Note: Operating Carrier may be different from a Marketing Carrier(s), if the flight is actually marketed by another carrier(s) within a codeshare agreement.
Operating Carrier may not be the AOC holder, in which case, and wherever required, this will need to be disclosed to the customer.
Flight Details.
Flight Distance with application.
FLIGHT DISTANCE with Application definition.
Flight distance value and distance unit of measure.
Example: 818, 5467
Flight Distance Unit of Measure.
Examples: Kilometers, Miles
Flight Distance Application.
Examples: FlightSegment, TotalJourney
Flight Duration with application.
FLIGHT DURATION with Application definition.
Flight Segment Duration.
Example: PT6H45M (six hours and forty-five minutes)
Note: This is the in-flight time duration associated with this segment. Stop duration is specified in the Stops node.
Flight Duration Application.
Examples: FlightTime, ConnectionTime, TotalJourneyTime
Total Journey time duration and flight distance.
TOTAL JOURNEY TIME/ DISTANCE definition.
Total Journey Time. Example: PT7H45M (7 hours and 45 minutes)
Note: Total journey time includes the combined air time, connection time and/ or stop information for all specified flight segments.
Total Journey distance value and distance unit of measurement.
Note: Total Journey distance includes the combined distances for all specified flight segments.
Total Flight Distance Value and distance unit of measure. Example: 8,5467
Flight Distance Unit of Measure. Examples: Kilometers, Miles
Flight Status.
Examples: SO, Flight Canceled
Encoding Scheme: IATA Padis Codeset - List for data element 1245 - Status Indicator
FLIGHT STATUS definition.
FLIGHT MEALS SERVED definition.
Meal(s) Served type. Example: B (Breakfast)
Encoding Scheme: IATA Padis Codeset - List for data element 7161 - Special Service, Coded
Day of the week when a Flight operates
Examples:
1234567 (MON through SUN)
123 (MON, TUE, WED)
467 (THU, FRI, SAT)
FLIGHT OPERATION FREQUENCY definition.
FLIGHT ON-TIME PERFORMANCE definition.
On-time Percentage Low Value. Example: 70 (70 Percentage)
On-time Percentage High Value. Example: 79 (79 Percentage)
When TRUE, this is a new flight and no performance information is available.
When TRUE, no flight performance information is available.
When TRUE, this is an international flight or location where no performance reporting is required.
On-time performance for this flight Segment.
Accuracy percentage of on time performance of a leg.
Month and year for which the on-time performance has been calculated.
Used if unable to provide information or is not applicable.
The percentage of arrivals that were more than 30 minutes late.
The percentage of cancellations.
When true, the flight was late more than 30 minutes of scheduled arrival more than 50 percent of the time.
Used for percentage values
Flight Mileage with application.
FLIGHT MILEAGE QUANTITY with Application definition.
Flight Mileage Value. Example: 2143
Flight Mileage Application.
Examples: Segment, Trip, Other
Flight Display Pricing Method.
Examples:
OriginDestinationPair - Pricing is assigned for the outbound segment of the O/D pair level and applies to all associated flight segment(s).
Segment - Pricing is assigned at an individual flight segment level and applies to the associated O/D pair and any associated flight segment(s).
Bilateral - Pricing is assigned per bilateral agreement.
Note: This is the method used for display pricing, e.g. how prices have been represented for O/D and flight segments.
Flight Reservation (booking/ order) date and time.
Reservation (order/ booking) timestamp. Example: 2017-01-13T13:20:00
Reservation (order/ booking) Date. Example: 2017-01-13
Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)
Order Reservation (booking) Time. Example: 13:20
Flight segment type. Example: P (PASSIVE)
Encoding Scheme: IATA PADIS 1.4 Codeset FST - Flight Segment Type
Married segment type. Example: B (Beginning of Married Segment Group)
Encoding Scheme: IATA PADIS Codeset for data element 1050 - Sequence Number
Married Segment Group Number. Example: 1
The IATA aircraft type 3 character code; use SSIM Appendix A. Example:318.
The IATA aircraft type 3 character code; use SSIM Appendix A. Example:318.
CORE Aircraft Equipment information.
SUMMARY Aircraft Equipment information.
AIRCRAFT CORE representation.
Equipment Code. Example: 737
Encoding Scheme: IATA/ A4A Equipment Code
When TUE, this aircraft equipment information is associated with a flight change of gauge.
AIRCRAFT SUMMARY representation.
Equipment name. Example: Boeing 737-800
Airline-specific aircraft equipment code.
Example: 737-800
Aircraft Equipment.
Aircraft Equipment Code Query.
Aircraft Features Query.
AIRCRAFT EQUIPMENT CODE QUERY representation.
The IATA aircraft type 3 character code; use SSIM Appendix A. Example:318.
AIRCRAFT EQUIPMENT CODE QUERY representation.
Aircraft Equipment Tail Number.
AIRCRAFT FEATURES QUERY representation.
Aircraft feature detail.
Encoding Scheme: IATA PADIS Codeset AFT (Aircraft Feature Type)
AIRCRAFT CABIN representation.
Aircraft Compartment/Class of service as defined in IATA SSIM and AIRIMP (RBD).
Encoding Scheme: PADIS codeset element 9800 - Reservation Booking Designator.
Examples: 1 (All Cabin Classes), C (Business Class), F (First Class), Y (Coach Economy)
AIRCRAFT CABIN representation.Aircraft Compartment/Class of service as defined in IATA SSIM and AIRIMP (RBD).
Encoding Scheme: PADIS codeset element 9800 - Reservation Booking Designator.
Examples: 1 (All Cabin Classes), C (Business Class), F (First Class), Y (Coach Economy)
Cabin type. Examples: First Class, Business Class
Encoding Scheme: PADIS codeset element 9873 - Cabin Class of Service
Cabin class marketing name. Example: Premium Economy
A data type for Cabin Core.
Cabin code.
Example: F
Designator code for the cabin. Example: Y
When TRUE indicates that it applies to all Cabins, otherwise the specified Cabin applies.
Cabin Marketing Name. Example: Premium Economy
Aircraft Cabin information.
Itinerary Data.
ITINERARY - Existing (known) Flight Information.
Origin/ Destination information. Contains a list of all Flight element that are part of that OD.
ORIGIN/ DESTINATION definition.
Departure Airport Location code. Example: TPA
Encoding Scheme: IATA/ A4A (three character) Airport or City Code
Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory . Example: TPA
A globally unique identifier for this OriginDestination instance. Example: origDest1
NDC XML SPECIFICATION: XML Object Keys and Associations shared by all NDC Domains.
Notice: This is NDC Draft Specification provided for pre-review by the members of the relevant governance groups, it is not provided for implementation in a production environment or considered to be the final schema to support NDC business requirements. The draft schema may, at any time up to final specification submission, undergo changes including, but not limited to, specific elements, element names/labels, annotations or message name as a result of the ongoing quality control process, and comments, which may be received following the pre-review. Implementation of this version is done so at the risk of the implementer or implementing company.
The airline-assigned unique Offer Item ID. Example: OFFER769-A850-4EC4-8F46-02293F72D7E6
The airline-assigned unique Order Item ID. Example: ORD769-A850-4EC4-8F46-02293F72D7E6
A data type for an order or offer related ID.
Example: ORDER-c98c-4759-a20b-01
Airline designator or CRS code of the owner/ assigner of the Offer ID, typically used for offer ordering purposes. Example: UA, BA
Encoding Scheme: IATA/ A4A (two or three character) Airline or CRS Designator Code
Deep linking into another site to complete the transaction.
A globally unique identifier for this Aircraft Equipment instance. Example: equip1
Reference to one Aircraft Equipment instance. Example: equip1
A globally unique identifier for this Airport instance. Example: airport1
Association to one Airport instance. Example: airport1
Association to Carry-on Allowance, Checked Bag Allowance and/or Baggage Disclosure.
A globally unique identifier for this Baggage Disclosure instance. Example: bdisclosure1
Association to one Baggage Disclosure instance. Example: bdisclosure1
Association to multiple Baggage Disclosure instance(s). Example: bdisclosure1 bdisclosure2
A globally unique identifier for this Checked Baggage Allowance instance. Example: checked1
Association to one Checked Bag Allowance instance. Example: checked1
Association to multiple Checked Bag Allowance instance(s). Example: checked1 checked2
A globally unique identifier for this Carry-On Allowance instance. Example: carryon1
Association to one Carry-On Allowance instance. Example: carryon1
Association to multiple Carry-On Allowance instance(s). Example: carryon1 carryon2
A globally unique identifier for this Content Source. Example: source1
Association to one Content Source instance. Example: source1
Association to multiple Content Source instance(s). Example: source1 source 4
A globally unique identifier for this Data List instance. Example: list1
A globally unique identifier for this Disclosure instance. Example: disclosure1
Association to one Disclosure instance. Example: disclosure1
Association to multiple Disclosure instances. Example: disclosure1 disclosure2
A globally unique identifier for this Equivalent ID instance. Example: equiv1
Note: This is an equivalent (third-party) ID for the Airline-specified ID.
Association to one Equivalent Identifier instance. Example: equiv1
A globally unique identifier for this Exit Row Position instance. Example: exit1
Association to one Exit Row Position instance. Example: exit1
Association to multiple Exit Row Position instance(s). Example: exit1 exit2
A globally unique identifier for this Fare instance. Example: fare1
Association to Fare instance(s). Example: fare1
A globally unique identifier for this Fare Basis instance. Example: fbasis1
Association to one Fare Basis instance. Example: fbasis1
Association to multiple Fare Basis instance. Example: fbasis1 fbasis2
Association to multiple Object Metadata instance(s). Example: offermeta1 flightmeta2
A globally unique identifier for this Flight Class of Service instance. Example: cos1
Association to one Flight Class of Service instance. Example: cos1
Association to multiple Flight Class of Service instance(s). Example: cos1 cos2
A globally unique identifier for this Origin/Destination instance. Example: od1
Association to one Origin/Destination instance. Example: od1
Association to multiple Origin/Destination instance(s). Example: od1 od2
Association to multiple Flight instance(s). Example: flight1 flight2
Note: Flight Slice On and Off Board Points may also be specified.
Flight slice on point. Example: TPA
Encoding Scheme: IATA/ A4A (three character) Airport or City Code
Flight slice off point. Example: LHR
Encoding Scheme: IATA/ A4A (three character) Airport or City Code
Association to multiple FlightS Segment instance(s). Example: seg1 seg2.
Association to to single Flight segment instance(s). Example: segment1
Object association(s) between this object and any other object or metadata instance(s).
A globally unique identifier for this Flight Segment instance. Example: segment1
Association to one Flight Segment instance. Example: segment1
Note: Flight Slice On and Off Board Points may also be specified.
Flight Slice ON Point. Example: ORD
Encoding Scheme: IATA/ A4A (three character) Airport or City Code
Flight Slice OFF Point. Example: NYC
Encoding Scheme: IATA/ A4A (three character) Airport or City Code
Association to multiple Flight Segment instance(s). Example: segment1 segment2
Note: Flight Slice On and Off Board Points may also be specified.
Flight slice on point. Example: TPA
Encoding Scheme: IATA/ A4A (three character) Airport or City Code
Flight slice off point. Example: LHR
Encoding Scheme: IATA/ A4A (three character) Airport or City Code
Association to one Group instance. Example: group1
A globally unique identifier for this Media ID or Link instance. Example: media1
A globally unique identifier for this Media Group (collection) instance. Example: mediagrp1
Association to one Media Group instance. Example: mediagrp1
Association to one Media ID or Link instance. Example: media1
Association to multiple Media Item instance(s). Example: media1 media2
Note: Media ID and Media Link.
A globally unique identifier for this Offer instance. Example: offer1
Association to one Offer instance. Example: offer1
Association to multiple Offer instance(s). Example: offer 1 offer2
A globally unique identifier for this Offer Item Instruction instance. Example: instruction1
Association to one Offer/ Offer Item Instruction instance. Example: instruction1
Association to multiple Offer/ Offer Item Instruction instance(s). Example: instruction1 instruction2
A globally unique identifier for this Offer/ Offer Item Penalty instance. Example: penalty1
Association to one Offer/ Offer Item Penalty instance. Example: penalty1
Association to multiple Offer/ Offer Item Penalty instance(s). Example: penalty1 penalty2
A globally unique identifier for this Offer/ Offer Item Term instance. Example: term1
Association to one Offer/ Offer Item Term instance. Example: term1
Association to multiple Offer/ Offer Item Term instance(s). Example: term 1 term2
A globally unique identifier for this Order instance. Example: order1
Association to one Order instance. Example: order1
Association to multiple Order instance(s). Example: order1 order2
A globally unique Order Item Key (instance id.) Example: oitem1
Association to one Order Item instance. Example: oitem1
Association to multiple Order Item instance(s). Example: oitem1 oitem2
A globally unique identifier for this Order/ Order Item Instruction instance. Example: instruction1
Association to one Order/ Order Item Instruction instance. Example: instruction1
Association to multiple Order/ Order Item Instruction instance(s). Example: instruction1 instruction2
A globally unique identifier for this Order/ Order Item Penalty instance. Example: penalty1
Association to one Order/ Order Item Penalty instance. Example: penalty1
Association to multiple Order/ Order Item Penalty instance(s). Example: penalty1 penalty2
A globally unique identifier for this Passenger instance. Example: pax1
Association to one Passenger instance. Example: pax1
Association to multiple Passenger instance(s). Example: pax1 pax2
A globally unique identifier for this Price Class instance. Example: pclass1
Association to one Price Class instance. Example: pclass1
Association to multiple Price Class instance(s). Example: pclass1 pclass2
A globally unique identifier for this Seat instance. Example: seat1
Association to one Seat instance. Example: seat1
Association to multiple Seat instance(s). Example: seat1 seat2
A globally unique identifier for this Seat Display instance. Example: seatdisplay1
Association to one Seat Map Display. Example: seatdisplay1
Association to multiple Seat Display instance(s). Example: seatdisplay1 seatdisplay2
A globally unique identifier for this Seat Map Component instance. Example: component1
Association to one Seat Map Component instance. Example: component1
Association to multiple Seat Map Component instance(s). Example: component1 component2
A globally unique identifier for this Seat Map Message instance. Example: seatmsg1
Association to one Seat Map Message instance. Example: seatmsg1
Association to multiple Seat Map Message instance(s). Example: seatmsg1 seatmsg2
A globally unique identifier for this Service instance. Example: srvc1
Association to one Service instance. Example: srvc1
Association to multiple Optional Service instance(s). Example: srvc1 srvc2
A globally unique identifier for this Service Bundle instance. Example: sbundle1
Association to one Service Bundle instance. Example: sbundle1
Association to multiple Service Bundle instance(s). Example: sbundle1 sbundle2
A globally unique identifier for this Traveler instance. Example: Traveler1
Note: This may be a reference to a Recognized or Anonymous Traveler.
Association to one Traveler instance. Example: Traveler1
Note: May be Recognized or Anonymous Traveler instance.
Association to multiple Traveler instance(s). Example: Traveler1 Traveler2
Note: May be Recognized or Anonymous Traveler (by PTC) instance(s).
A globally unique identifier for this State/Province instance. Example: state1
Reference to one State/Province instance. Example: state1
Association to multiple State/Province instance(s). Example: state1 prov2
A globally unique identifier for this Wing Position instance. Example: wing1
Association to one Wing Position instance. Example: wing1
Association to multiple Wing Position instance(s). Example: wing1 wing2
NDC XML SPECIFICATION: METADATA ASSOCIATED WITH XML BUSINESS OBJECTS
Notice: This is NDC Draft Specification provided for pre-review by the members of the relevant governance groups, it is not provided for implementation in a production environment or considered to be the final schema to support NDC business requirements. The draft schema may, at any time up to final specification submission, undergo changes including, but not limited to, specific elements, element names/labels, annotations or message name as a result of the ongoing quality control process, and comments, which may be received following the pre-review. Implementation of this version is done so at the risk of the implementer or implementing company.
Pre-defined and Augmented ADDRESS Metadata.
ADDRESS Metadata.
ADDRESS Metadata.
Pre-defined and Augmented AIRCRAFT Metadata.
AIRCRAFT Metadata.
AIRCRAFT Metadata.
Pre-defined and Augmented AIRPORT Metadata.
AIRPORT Metadata.
Pre-defined and Augmented CITY Metadata.
CITY Metadata.
Pre-defined and Augmented CODESET Metadata.
PADIS/ CODESET Metadata.
Pre-defined and Augmented CONTACT Metadata.
CONTACT Metadata.
Pre-defined and Augmented CONTENT Metadata.
CONTENT SOURCE Metadata.
Pre-defined and Augmented COUNTRY Metadata.
COUNTRY Metadata.
Pre-defined and Augmented CURRENCY Metadata.
CURRENCY Metadata.
Pre-defined and Augmented DESCRIPTION Metadata.
DESCRIPTION Metadata.
Pre-defined and Augmented EQUIVALENT ID Metadata.
EQUIVALENT IDENTIFIER Metadata.
Pre-defined and Augmented LANGUAGE Metadata.
LANGUAGE Metadata.
Pre-defined and Augmented MEDIA Metadata.
MEDIA Metadata Detail
MEDIA Metadata.
Pre-defined and Augmented PAYMENT CARD Metadata.
PAYMENT CARD Metadata.
Pre-defined and Augmented PAYMENT FORM Metadata.
PAYMENT FORM Metadata.
Pre-defined and Augmented PRICE Metadata.
PRICE Metadata.
Pre-defined and Augmented RULE Metadata.
RULE Metadata.
Pre-defined and Augmented STATE/ PROVINCE Metadata.
STATE/ PROVINCE Metadata.
Pre-defined and Augmented ZONE Metadata.
ZONE Metadata.
A data type for ADDRESS Metadata.
A data type for AIRCRAFT Metadata.
Aircraft tail number. Example: N387SW
Aircraft name.Example: N387SW
A data type for AIRPORT Metadata.
Direction(s).
A data type for CITY Metadata.
A data type for PADIS/ CODESET Metadata.
Codeset Source.
Owner Entity ID. Example: BA
Owner Name. Example: British Airways
Codeset file or resource name. Example: PADIS Codeset
Codeset version. Example: 14
Other (alternate) Language Encoding and Code Description.
Codeset table or list name. Example: Data Element 9972-Originator Type
A data type for CONTACT Metadata.
A data type for CONTENT SOURCE Metadata.
A data type for COUNTRY Metadata.
ICAO location code.
Example: K (CONTIGUOUS UNITED STATES)
Country name.
Example: United States
A data type for CURRENCY Metadata.
Currency application. Example: Actual Pricing, Display Currency, Requested Pricing
Number of decimal places. Example: 2
Note: This is used for amount values. For example, if the associated number of decimal places is 2, a currency value of 10000 is equal to 100.00
Currency name. Example: US Dollars
A data type for DESCRIPTION Metadata.
Description Application. Examples: Marketing, TermsAndConditions
Description topic. Example: Relax in the Lounge
Hint. Example: Relax in the Lounge
Description copyright. Example: (c) ABC CO
Description Sequence (order) Number. Example: 1
A data type for EQUIVALENT IDENTIFIER Metadata.
Equivalent Identifier detail.
Equivalent ID value. Example: MYSRVC123
Airline designator or CRS code of the owner/ assigner of the Offer ID, typically used for offer ordering purposes. Example: UA, BA
Encoding Scheme: IATA/ A4A (two or three character) Airline or CRS Designator Code
A data type for LANGUAGE Metadata.
Language application. Examples: Display, Requested, Spoken, Written
Language encoding. Examples: fr
Encoding Scheme: ISO 639-1 Language Code
NLS Language encoding. Examples: en-US
Encoding Scheme: Microsoft National Language Support (NLS) Code
Language name. Example: English, United States
A data type for PAYMENT CARD Metadata.
Customer Commercial Account.
Note: This is a reference number to a commercial account used to further identify the holder of the credit card.
Extended Payment Month Quantity. Example: 3
Notes:
1. This is a code to indicate the number of months over which the customer wishes to pay where the credit card issuer permits.
2. This capability may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. If supported, the technical implementation of this capability is not dictated by this specification.
Unique Transaction Information.
Note: This may contain unique transaction information supplied to the airline/system provider by the credit card company.
Corporate Contract Code. Example: IBM1234
Note: This is used to indicate whether the purchase is on behalf of a corporate client that has a contract ith the ticketing agency for the purchase of transportation and related services.
A data type for PAYMENT FORM Metadata.
Customer Commercial Account.
Note: This is a reference number to a commercial account used to further identify the holder of the credit card.
Extended Payment Month Quantity. Example: 3
Notes:
1. This is a code to indicate the number of months over which the customer wishes to pay where the credit card issuer permits.
2. This capability may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. If supported, the technical implementation of this capability is not dictated by this specification.
Unique Transaction Information.
Note: This may contain unique transaction information supplied to the airline/system provider by the credit card company.
Corporate Contract Code. Example: IBM1234
Note: This is used to indicate whether the purchase is on behalf of a corporate client that has a contract ith the ticketing agency for the purchase of transportation and related services.
A data type for PENALTY Metadata.
A data type for PRICE Metadata.
A data type for RULE Metadata.
Unique Rule ID which was applied during transaction processing. Example: PRICERULE001 Note: Optional rule context and name may also be specified.
Rule name. Example: Rule001
Rule status. Examples: ActionRequired, RuleExecuted, Other
Rule Value(s).
Rule value detail.
Business rule instruction.
Example: [NodePath.r1] {EQ('FR')} [NodePath.r2]{EQ(TRUE)}
A data type for STATE/ PROVINCE Metadata.
A data type for ZONE Metadata.
Baggage-related Metadata, including Checked Bag, Carry-on Baggage, Baggage Disclosure, Baggage Detail and Baggage Query.
Flight-related Metadata, including Flight and Itinerary.
Location-related Metadata, including Directions.
Offer-related Metadata, including Disclosure, General, Instructions, Penalty, Status and Terms.
Pricing-related Metadata, including Discount.
Shopping Qualifier-related Metadata, including Air Pass, Shopping Qualifier.
Qualifier choices.
These capabilities may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. If supported, the technical implementation of the capability is not dictated by this specification.
Contains card type, and Issuer Identification Number.
Contains elements identifying eligibility for special pricing, which may be private or negotiated.
Notes:
1. Supports pricing discounts and/ or other benefits for Travelers affiliated with companies with private fare and/ or negotiated rate contracts.
2. Private Fares apply to ALL Travelers.
Seat-related Metadata, including Seat and Seat Map.
Shopping Metadata choices.
Location-related Metadata, including Directions.
Pricing-related Metadata, including Discount.
Traveler-related Metadat.
BAGGAGE DETAIL Metadata.
Pre-defined and Augmented BAGGAGE DISCLOSURE Metadata.
BAGGAGE DISCLOSURE Metadata.
BAGGAGE QUERY Metadata.
Pre-defined and Augmented CARRY-ON BAGGAGE ALLOWANCE Metadata.
CARRY-ON BAGGAGE ALLOWANCE Metadata.
Pre-defined and Augmented CHECKED BAG ALLOWANCE Metadata.
CHECKED BAG ALLOWANCE Metadata.
Pre-defined and Augmented FLIGHT Metadata.
FLIGHT Metadata.
Pre-defined and Augmented ITINERARY Metadata.
Pre-defined and Augmented DIRECTIONS Metadata.
DIRECTIONS Metadata.
Pre-defined and Augmented DISCLOSURE Metadata.
DISCLOSURE Metadata Detail
DISCLOSURE Metadata.
Pre-defined and Augmented OFFER ITEM INSTRUCTION Metadata.
OFFER ITEM INSTRUCTION Metadata.
Pre-defined and Augmented OFFER ITEM Metadata.
OFFER ITEM Metadata.
OFFER ITEM Metadata.
Pre-defined and Augmented OFFER ITEM PENALTY Metadata.
OFFER ITEM PENALTY Metadata.
Pre-defined and Augmented OFFER ITEM TERMS Metadata.
OFFER ITEM TERMS Metadata.
Pre-defined and Augmented DISCOUNT Metadata.
DISCLOSURE Metadata Detail
DISCOUNT Metadata.
Pre-defined and Augmented SEAT Metadata.
SEAT Metadata.
Pre-defined and Augmented SEAT MAP Metadata.
SEAT MAP Metadata.
Pre-defined and Augmented PENALTY Metadata.
PENALTY Metadata.
CARRY-ON BAG Metadata definition.
CHECKED BAG Metadata definition.
BAGGAGE DETAIL Metadata definition.
Tariff.
Example: PF17
Fare Type.
Fare rule code.
Example: EU (ECONOMY UNRESTRICTED)
Fare category.
Example: CATEGORY 35
BAGGAGE DISCLOSURE Metadata definition.
BAGGAGE QUERY Metadata definition.
PNR ownership.
CRS or carrier department code. Example: BA
Ticket issuing aggregator or agency. Example: AMADEUS
Ticket issue location.
Example: MIA
For maximum interoperability, it is recommended that IATA (three character) Airport/ City Code values be used. Use an IATA code or a proprietary string value.
http://www.iata.org/publications/Pages/code-search.aspx
Ticket issue country.
Example: CA
Total number of passengers of all types for the entire itinerary. Example: 4
Total price for the entire itinerary for all passengers of all types. Example: 320000
DIRECTIONS Metadata definition.
DISCLOSURE Metadata definition.
Disclosure creation timestamp. Example: 2017-01-13T13:59:38Z
FLIGHT Metadata definition.
Reservation system action code. Example: HK
A unique flight segment reference that may be used when binding request/ response messages.
Meal(s) Served.
Meal served code. Example: B (Breakfast)
Encoding Scheme: IATA Padis Codeset - List for data element 7161 - Special Service, Coded
ITINERARY Metadata definition.
Reservation system action code. Example: HK
MEDIA Metadata definition.
Media application. Example: Marketing
Media object caption. Examples: (image) PREMIUM SEAT, (video) See the New Terminal
(file) Download Terminal Map, (link) Baggage Information
Media object tip. Example: Envoy Class Seat
Note: This is typically used in a client GUI, e.g. a mouseover tip.
Media Dimensions metadata.
Dimension Unit of Measure. Example: Pixels
Height in specified units. Example: 120
Width in specified units. Example: 120
Media Source metadata.
Media Code. Example: IMG123
Media version. Example: 14
The media object file name. Example: ThisPlane.swf
Image barcode symbology applied. Example: PDF417
Media object copyright. Example: © COPYRIGHT IATA 2014
OFFER ITEM METADATA definition.
Attributes and S5/ S7 Diagnostics.
Offer Incentive(s).
Offer Match(s).
Offer Match detail.
Offer Terms.
Offer Time Limits.
Offer Rules.
Offer Status. Example: NN (Requested)
OFFER ITEM INSTRUCTIONS Metadata definition.
OFFER ITEM TERMS Metadata definition.
SEAT Metadata definition.
Seat status.
Examples:
SA (Seats are available)
WO (Seats waitlist open for segment)
WC (Seats waitlist closed for segment)
OR (Seats on request only to airline)
Encoding Scheme: IATA PADIS Code List for data element 9865 - Seat Occupation
SEAT MAP Metadata definition.
Pre-defined PASSENGER Metadata.
Pre-defined Traveler Metadata.
PASSENGER Metadata definition.
Traveler Name Detail, including Given Name Prefix, Title Suffix, Surname Prefix and Surname Suffix.
Given name prefix. Example: MR
Title degree or honors. Examples: Ph.D., M.D.
Surname prefix. Examples: van der, von, de
Surname suffixes and letters. Examples: Jr., Sr., III, Ret., Esq.
Traveler Metadata definition.
Traveler Name Detail, including Given Name Prefix, Title Suffix, Surname Prefix and Surname Suffix.
Given name prefix. Example: MR
Title degree or honors. Examples: Ph.D., M.D.
Surname prefix. Examples: van der, von, de
Surname suffixes and letters. Examples: Jr., Sr., III, Ret., Esq.
NDC XML SPECIFICATION: OFFER XML OBJECT
Notice: This is NDC Draft Specification provided for pre-review by the members of the relevant governance groups, it is not provided for implementation in a production environment or considered to be the final schema to support NDC business requirements. The draft schema may, at any time up to final specification submission, undergo changes including, but not limited to, specific elements, element names/labels, annotations or message name as a result of the ongoing quality control process, and comments, which may be received following the pre-review. Implementation of this version is done so at the risk of the implementer or implementing company.
A data type for Offer Match Application.
A data type for Offer Match Results.
Examples: Full, None, Partial, Others
A data type for Offer Match Results.
A data type for Offer Match Results.
Examples: Full, None, Partial, Others
A data type for Other Offer Optional Associations.
A data type Other Offer Association Type Name.
Applicable Flight(s).
Associated Optional Service(s).
Associated Travelers.
Note: Includes Anonymous, Recognized and/or PTC Traveler association.
Flight that the offer applies to.
When TRUE, this Simple Fare Offer applies to all specified flights.
When TRUE, this Baggage Offer applies to all specified flight Origin/ Destination Pairs.
When TRUE, this Simple Fare Offer applies to all specified flight Segments.
Baggage Offer Association definition.
Optional Service(s) included with Fare.
Associated Media definition.
Media Item detail.
Associated Media URL.
Offer Detail Association(s).
Other Association(s).
Shopping Offer Association(s).
Shopping Offer Association(s) definition.
Associated Shoppers. Note: Includes Anonymous, Recognized and/or PTC shopper association.
Associated Flight(s).
Associated Price Class information.
Baggage Detail Associations.
Offer Detail Association(s).
Associated Service(s).
Associated Service.
Associated Media.
Other Association(s).
Associated Offer Detail definition.
Other, Implementer-specified, Offer Associations.
Other Association Detail.
Note: Includes an association type choice (e.g. MediaGroup) and an instance association value (e.g. mediagrp1).
Named association type. Examples: CarryOnAllowance, MediaGroup
Associated object instance value. Example: mediagrp1
Priced Flight Offer Association definition.
Associated Price Class information.
Included Optional Service(s).
Seat Offer Association definition.
Offer-Associated Optional Services definition.
Specific structure for providing flight associations, would typically associate to flights from a Data List.
Associated Shopper(s) definition.
When TRUE, this Offer applies to all specified shoppers.
Associated Traveler(s) definition.
When TRUE, this Offer applies to all specified Travelers.
Association to multiple Traveler instance(s). Example: Traveler1 Traveler2
Note: May be Recognized or Anonymous Traveler (by PTC) instance(s).
A BAGGAGE Offer.
Note: A Baggage Offer may contain additional Validating Carrier and Bag Detail, including Checked and Carry-on Baggage Allowance and Baggage Disclosure(s).
Fare Price Detail.
Fare Lead Pricing which may be used in calendar shopping, and may relate to the filed fare scenarios.
A GENERIC OPTIONAL SERVICE Offer.
Note: A Generic Optional Service Offer may contain
seat details, including Marketing Name; Seat Features; Seat Descriptive Keywords; and Seat Dimensions.Other Optional Service Offer type, e.g. Lounge Pass and Expedited Boarding.
A PRICED FLIGHT Offer.
Notes:
1. A Priced Flight Offer may contain Branded Fare information. If it is a Branded Fare, Price Class-association will be specified.
2. Additionally, Lead Pricing Calendar fares (prior to and/ or after the specified departure date) may be specified by passenger type.
A SEAT Offer.
Note: A Seat Offer may contain seat details, including Marketing Name; Seat Features; Seat Descriptive Keywords; and Seat Dimensions.
Seat Features, including size.
Baggage Offer with Association definition.
Total baggage price for a specific offer, excluding taxes and charges. Monetary value and currency code.
Baggage Offer Association(s), including Traveler, Flight, Baggage Details, Optional Services and other miscellaneous association.
Note: If specified, these Baggage Offer Association(s) apply to all Baggage Offers. Note that they may be overidden at the Bag Detail level.
Validating Carrier Code. Example: BA
Notes:
1. This is the carrier whose air waybill or ticket is issued (see Resolution 780).
2. If specified, this Validation Carrier applies to all flight(s) unless overridden at the BagDetail level.
Baggage Details.
Baggage detail.
Validating Carrier Airline Designator.
A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory . Example: BA
Baggage Offer Association(s), including Traveler, Flight, Baggage Details, Optional Services and other miscellaneous association.
Baggage Disclosure information.
Elements relating to baggage charges.
Other Offer with Association definition.
Other Offer Pricing.
Other Offer Association(s).
Priced Flight Offer with Association definition.
Fare Offer and Lead Calendar Pricing information.
Priced Flight Offer Association(s), including Traveler, Flight, Baggage, Included Optional Services, Associated Optional Services, Price Class and other miscellaneous association.
Seat Offer with Association definition.
Seat Offer Pricing.
Seat Offer Association(s).
Offer definition.
CORE OFFER definition.
Offer-wide parameters, including Traveler Applicability; Total Offer Quantity; Passenger Pricing Method; Inventory Guarantee.
Total Offer Items in this Offer. Example: 3
Requested and Priced PTC (passenger type code) and associated Traveler quantity.
When TRUE, this Offer applies to all Travelers.
When TRUE, this Offer must be redeemed, e.g. it cannot be purchased.
Note: Taxes may still apply.
Globally unique Offer instance ID. length should not be exceed 64 character and it is recommended to not use dash char in it.Example: QWASZXERDFCVTYGHBNUIJKNMF67D5F9GHR567SWER41SD458F9456FMDIRTN34DF
Offer-Level Time Limits, including Offer Expiration, Payment and Bilateral Time Limits.
Note: If specified, these time limits are at the OFFER-LEVEL and will apply by default to any relevant (child) Offer Items. These time limits may also be specified at a (child) OFFER ITEM-level where it will apply to that one instance of the Offer Item (and override the Offer-level time limit if one has been specified.)
The total price for all Travelers associated with this offer.
Disclosure information.
Penalty information.
Indicator to specify if the offer relates to requested date. For example in calendar search, this indicator will be set to 'true' if this airline offer is for a requested date and will not be present (or will be set to 'false' if airline offer is for another date than requested one.
DETAIL OFFER definition.
Core Baggage Offer definition.
Total baggage price for a specific offer, excluding taxes and charges. Monetary value and currency code.
Validating Carrier Airline Designator.
A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory . Example: BA
Baggage Details.
Baggage detail.
Validating Carrier Airline Designator.
A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory . Example: BA
Baggage Offer Association(s), including Shopper, Flight, Baggage Details, Optional Services and other miscellaneous association.
Baggage Disclosure information.
Elements relating to baggage charges.
AWARD (Redemption Unit-based) Pricing information.
PARTIAL CURRENCY and AWARD Pricing Combination information.
A (detailed) CURRENCY-based Price with Price Break-down for Tax and/ or Fee information.
Monetary value amount and currency code.
A (simple) CURRENCY-based Price with NO taxes and/ or fees.
Examples: 100.00, 100, 100 (USD)
Core Other Offer definition.
Other Offer Pricing.
AWARD (Redemption Unit-based) Pricing information.
PARTIAL CURRENCY and AWARD Pricing Combination information.
A (detailed) CURRENCY-based Price with Price Break-down for Tax and/ or Fee information.
Monetary value amount and currency code.
A (simple) CURRENCY-based Price with NO taxes and/ or fees.
Examples: 100.00, 100, 100 (USD)
Core Priced Flight Offer definition.
Fare Offer and Lead Calendar Pricing information.
When TRUE, this is a lead pricing generated priced flight offer.
When TRUE, additional lead pricing offers are included with this proced flight offer.
Core Seat Offer definition.
Seat Offer Pricing.
Offer Instructions.
A data type for Offer Instructions.
Upgrade-eligible Class(es) of Service.
Free-text Instruction Remark(s).
Special Need Order booking method.
Examples:
AE (by SSR-Special Service Request)
AF (by OSI-Other Service Information)
Encoding scheme: PADIS Code List for data element 9750 - Option
Upgrade-eligible Class(es) of Service.
Free-text Instruction Remark(s).
Offer Instructions: Free-Text Remark(s).
CLASS OF SERVICE UPGRADE definition.
Offer Instructions: SPECIAL BOOKING METHOD definition.
Special Need Order booking method.
Examples:
AE (by SSR-Special Service Request)
AF (by OSI-Other Service Information)
Encoding scheme: PADIS Code List for data element 9750 - Option
Offer/ Offer Item: INVENTORY GUARANTEE definition.
Time limit by which guaranteed inventory for a specified product offer is guaranteed as available and by which the inventory held must be converted into a completed order before the time limit expires otherwise the guarantee is lost.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Unique Inventory Guarantee ID.
Examples: INVREF123456, 68E0DB2F-675C-44F7-BC1E-653106099FF9
Note: This is a unique identifier issued by an Airline to reference that inventory for a specified offer will be guaranteed as available for a period.
Association(s) to one or more Offers or Offer Items for which the inventory guarantee applies.
Inventory Guarantee information, including Inventory Guarantee Time Limit, Unique ID and Offer/ Offer Item association(s).
Notes:
1. This is the time that inventory for a specified product offer is guaranteed as available. The inventory held must be converted into a completed order before the time limit expires otherwise the guarantee is lost.
2. If specified, an association to one or more Offers or Offer Items may be specified in the Associations node. If no associations are specified, the inventory guarantee is assumed to apply to the entire Offer.
3. This capability may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. If supported, the technical implementation of this capability is not dictated by this specification.
LEAD PRICING CALENDAR Pricing definition.
Price information for alternate dates.
Notes:
1. This is based on lead pricing specified in the AirShoppingRQ/ AttributeQuery/Flight node Arrival and/ or Departure elements.
2. This capability may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only.The technical implementation of this capability is not dictated by this specification.
3. If implemented, the client application will typically send new a new shopping request if any of these window shopping dates are selected.
Fare Price for the Requested Date.
Fare Offer Associations.
Globally unique OfferItem instance ID. Length should be 64 chars and it is recommended to not use dash char in it.Example: QWASZXERDFCVTYGHBNUIJKNMF67D5F9GHR567SWER41SD458F9456FMDIRTN34DF
Lead Pricing Price Detail definition.
Price Detail, including total amount, base fare amount and other details.
Total price amount.
Notes:
1. This is typically the lowest price for this alternate lead shopping date.
2. If expressed in currency, this price should include base price, taxes and fees/ surcharges.
Total Base Fare Amount. Example: 200000
Note: This includes surcharges (if applicable).
Discount Information
Applicable Surcharge(s).
Surcharge detail.
Ticket Tax/fee/charge details to indicate taxes that apply to country of commencement of travel and routing.
AWARD (Redemption Unit-based) Pricing information.
PARTIAL CURRENCY and AWARD Pricing Combination information.
Lead Price detail.
Lead Pricing (alternate) Date. Example: 2017-01-10
Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)
Actual travel date requested by Traveler. Example: 2017-01-13
Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)
Total price amount.
Notes:
1. This is typically the lowest price for this alternate lead shopping date.
2. If expressed in currency, this price should include base price, taxes and fees/ surcharges.
Total Base Fare Amount. Example: 200000
Note: This includes surcharges (if applicable).
Applicable Surcharge(s).
Surcharge detail.
Ticket Tax/fee/charge details to indicate taxes that apply to country of commencement of travel and routing.
AWARD (Redemption Unit-based) Pricing information.
PARTIAL CURRENCY and AWARD Pricing Combination information.
Offer Match to shopping criteria. Examples: Full, None, Partial, Other
Notes: An additional percentage qualifier, such as 50%, may be specified for a Partial match.
A data type for Search Query to Results Match.
Offer match to shopping criteria. Examples: Full, None, Partial, Other
Note: An additional percentage qualifier, such as 50%, may be specified for a Partial match.
Match Application. Examples: ATTRIBUTE, AFFINITY, Other
Offer Match Result. Examples: Full, None, Partial, Other
Match percentage. Example: 60
Note: This value may be used to indicate a percentage of a Partial match.
Quantity (number) of travelers of the same Passenger Type Code
Requested to be priced, and actually Priced PTC (Passenger Type Code) and associated Traveler(s) quantity.
PASSENGER TYPE CODE/ QUANTITY definition.
Passenger type code and Traveler quantity. Example: ADT
Encoding scheme: IATA (three character) Passenger Type Code
Number of Traveler(s) for associated passenger type and country of residence. Example: 2
A data type for Requested and Priced Passenger Type Code(s) and Quantity.
Passenger type code and Traveler quantity. Example: ADT
Encoding scheme: IATA (three character) Passenger Type Code
Requested passenger type code for pricing. Example: CHD
Encoding scheme: IATA (three character) Passenger Type Code
Actual passenger type code used for for pricing. Example: ADT
Encoding scheme: IATA (three character) Passenger Type Code
Offer Penalty information.
OFFER PENALTY definition.
OFFER INCENTIVE information definition.
Offer Incentive detail.
Rules engine offer ID.
Example: 0AR123
Offer expiration date.
Example: 2017-01-13
Offer subcode generated on creation by SQL.
Quantity of available units. Example: 4
Distinguishes between choice of discount amount or discount percentage.
An Offer Pricing snapshot that applies to All OFFER (results) from ALL AIRLINES.
Note: Includes pricing indicators; sub-totaled price for all offer items; and highest/ lowest priced offer amounts. Supports Currency, Redemption, and Combination Pricing.
An Offer Pricing snapshot that applies to ALL OFFER (results) from THIS AIRLINE.
Note: Includes pricing indicators; sub-totaled price for all offer items; and highest/ lowest priced offer amounts.
A data type for Aggregated Optional Service Offers Snapshot.
Total number of Travelers priced for all passenger types (PTC). Example: 2
Sub-totaled Price for all Travelers (of all types) and all Offer Item(s).
Highest Price for all Travelers (of all types) and all Offer Item(s).
Lowest Price for all Travelers (of all types) and all Offer Item(s).
A data type for Aggregated Optional Service Offer Information for One Airline.
Total number of Travelers (of the same passenger type) included in this offer.
Sub-totaled Price for all Travelers (of all types) and all Offer Item(s).
Highest Price for all Travelers (of all types) and all Offer Item(s).
Lowest Price for all Travelers (of all types) and all Offer Item(s).
Total Quantity of Offers that Matched search criteria. Example: 3
Note: This capability may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. If supported, the technical implementation of this capability is not dictated by this specification.
Fare code indicator. Example: 1 (SYSTEM PRICED WITHOUT MANUAL INTERVENTION)
Encoding Scheme: IATA PADIS Code List for data element 5387 - Price Type Qualifier
Offer Item Status. Example: HK (Confirmed)
OFFER/ OFFER ITEM STATUS definition.
Status. Examples: NN (Requested); HK (Confirmed)
Note: This Offer Status may contain any bilaterally-agreed upon status information.
OFFER TERMS definition.
Earliest and Latest Period that an Option is Available or May be Used.
Offer Terms Description(s).
Minimum and Maximum Group Size, e.g. Traveler quantities, associated with the Offer.
Minimum/ Maximum Option Ordering Quantity(s).
MINIMUM/ MAXIMUM GROUP SIZE definition.
The MINIMUM Group Size (e.g. Traveler quantity) required for the Offer. Example: 2
The MAXIMUM Group Size (e.g. Traveler quantity) required for the Offer. Example: 6
EARLIEST/LATEST Option Available/ Use definition.
Offer/ Order term (condition) for the Earliest time an item is Available or May be Used.
Examples: 2017-01-03T13:20:00, 2017-01-13T13:59:38Z
Offer/ Order term (condition) for the Latest time an item is Available or May be Used.
Examples: 2017-01-03T13:20:00, 2017-01-13T13:59:38Z
MINIMUM/ MAXIMUM Offer Ordering Quantity definition.
The MINIMUM Quantity of the Option that may be ordered. Example: 2
The MAXIMUM Quantity of the Option that may be ordered. Example: 4
OFFER TIME LIMIT SET (collection) definition.
Offer Expiration Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Notes:
1. This is the time within which offers must be converted into completed Orders.
2. On expiry, a new shopping transaction is required.
3. This time limit is at the OFFER-LEVEL and will apply to all (child) Offer Items.
Offer Time Limit object instance id and metadata instance(s) association.
Payment Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Notes:
1. This is the deadline by which a commitment to pay must be made for the confirmed items in an offer as agreed witht he airline. The passenger meets this requirement by making complete payment for the order.
2. Payment Time Limit and Ticket Time Limit may be the same in most cases; however, Payment Time Limit expands to include ticketless transactions and other accountable documents.
3. This time limit is at the OFFER-LEVEL and will apply to all (child) Offer Items.
Other Offer Time Limit(s).
Other Offer Time Limit detail.
Offer Time Limit object instance id and metadata instance(s) association.
OFFER ITEM TIME LIMIT SET (collection) definition.
Offer Item Time Limit detail.
Price Guarantee Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Notes:
1. This is the period for which an Offer price is guaranteed.
2. On expiry an Offer may be re-priced up to the point an accountable document is issued.
3. A Price Guarantee cannot extend beyond the Offer Expiration Time Limit unless an Order has been created.
Offer/ Offer Item: PRICE GUARANTEE Time Limit definition.
Price Guarantee Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Notes:
1. This is the period for which an Offer price is guaranteed.
2. On expiry an Offer may be re-priced up to the point an accountable document is issued.
3. A Price Guarantee cannot extend beyond the Offer Expiration Time Limit unless an Order has been created.
Ticketing By Time Limit.
DEPRECATON NOTICE: This element will be deprecated in the 2015.1 publication.
Notes: This is not the Offer Expiration Time Limit that applies to offers in a shopping response. This is the date/ time when a ticket-associated offer must be purchased/ ticketed, e.g. applicable to booking versus shopping. It has been left in the specification for backwards compatibility.
Offer/ Offer Item: TICKET BY Time Limit definition.
Ticketing By Time Limit.
Example: 2017-05-30T09:00:00
DEPRECATON NOTICE:
This element will be deprecated in the 2015.1 publication.
Notes: This is not the Offer Expiration Time Limit that applies to offers in a shopping response. This is the date/ time when a ticket-associated offer must be ticketed, e.g. applicable to booking versus shopping. It has been left in the specification for backwards compatibility
NDC XML SPECIFICATION: ORDER XML OBJECT
Notice: This is NDC Draft Specification provided for pre-review by the members of the relevant governance groups, it is not provided for implementation in a production environment or considered to be the final schema to support NDC business requirements. The draft schema may, at any time up to final specification submission, undergo changes including, but not limited to, specific elements, element names/labels, annotations or message name as a result of the ongoing quality control process, and comments, which may be received following the pre-review. Implementation of this version is done so at the risk of the implementer or implementing company.
A data type for Other Order Optional Associations.
A data type Other Order Association Type Name.
Association(s), including Passenger, Group, Order Item, Offer Item and Optional Service.
Other Order Associations.
Other Association Detail.
Note: Includes an association type choice (e.g. MediaGroup) and an instance association value (e.g. mediagrp1).
Named association type. Examples: CarryOnAllowance, MediaGroup
Associated object instance value. Example: mediaGroup1
Order Association(s), including Passenger, Group, Order Item, Offer Item and Optional Service.
Order Item association(s).
Passenger(s).
Associated Passenger detail.
Associated Group detail.
Flight that the offer applies to.
When TRUE, this Baggage Offer applies to all specified flights.
When TRUE, this Baggage Offer applies to all specified flight Origin/ Destination Pairs.
When TRUE, this Baggage Offer applies to all specified flight Segments.
Associated Order Item(s).
Associated Offer Item(s).
Associated Order Item(s).
Other optional association(s).
When TRUE, this applies to all passengers.
When TRUE, this applies to the whole itinerary, including all passengers.
Additional Order Item Details, including instructions.
Order detail.
Details of the commission claimed by a Travel Agent for selling air transportation/services on behalf of an airline.
Order Instructions.
Special Need Order booking method.
Examples:
AE (by SSR-Special Service Request)
Encoding scheme: PADIS Code List for data element 9750 - Option
A data type for Order Instructions.
Details of the commission claimed by a Travel Agent for selling air transportation/services on behalf of an airline.
Order Instructions: Commission type
A data type for Shopping Request Business Object: EXISTING ORDER Qualifiers.
Order Keys. Contains One Order ID with associated Order Item ID(s).
Notes: These are Orders that were created from Offers that have already been purchased, booked and/or are being held for a Traveler.
Order ID and Child Order Item Collection definition.
Shopping CR: This fulfills the requirement to allow previously ordered items to be used as a shopping session qualifiers.
Associated Order Item(s), Offer Item(s) and Optional Service(s).
Associated ID detail.
The airline-assigned unique Order ID. Example: ORDER-c98c-4759-a20b
A data type for an Order ID.
The airline-assigned unique Order ID. Example: ORDER-c98c-4759-a20b
Policy, object and metadata association.
Note: Equivalent Keys are specified in Metadata.
Airline Designator of airline that owns/ assigned this ID. Example: BA
Encoding Scheme: IATA/ A4A (two or three character) Airline Designator Codes
Deep linking into another site to complete the transaction.
CORE ORDER definition.
This may be used when an Order has been sub-divided into associated Orders (eg because a change creates non-homogeneity in a PNR), and serves as a cross reference for the original Order ID.
The Original airline-assigned unique Order ID. Example: ORDER-q988-ac01-a20b
This is pertinent information for an order change involving re-pricing as it provides the order pricing history e.g. indicating that an order has already been priced a number of times and the pricing source and history.
Payment Amount
ID or name of the source of this Transaction ID. Examples: UA, ABC123
Note: If this is an airline ID, use IATA 2 character or ICAO 3 letter Airline Designator Code Encoding Scheme.
Airline designator or CRS code of the owner/ assigner of the Offer ID, typically used for offer ordering purposes. Example: UA, BA
Encoding Scheme: IATA/ A4A (two or three character) Airline or CRS Designator Code
Order creation timestamp.
Example: 2015-01-13T13:59:38Z
Total Order Price. Example: 3400 USD
Note: This is a sub-total of all associated Order Item prices.
Currency, Redemption and Partial Pricing
Payment Processing information.
Note: This payment information applies to the entire Order. Note that it may also be specified at the Order Item level.
Payment Processing detail.
Order-Level Time Limits.
Payment Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Notes:
1. This is the deadline by which a commitment to pay must be made for the confirmed items in an offer as agreed witht he airline. The passenger meets this requirement by making complete payment for the order.
2. Payment Time Limit and Ticket Time Limit may be the same in most cases; however, Payment Time Limit expands to include ticketless transactions and other accountable documents.
3. This time limit is at the OFFER-LEVEL and will apply to all (child) Offer Items.
Although specified as mandatory in the BRD, there may be a case where Payment is already provided in the Order information.
The total number of Order Items included in this Order. Example: 3
CORE ORDER CHANGE definition.
The total number of Order Items included in this Order. Example: 3
Total Order Price. Example: 3400 USD Note: This is a sub-total of all associated Order Item prices.
Currency, Redemption and Partial Pricing
Order-Level Time Limits.
Order Association(s).
Associated Order Item ID(s). Example: ORD7333-001
Passenger(s)/ Group associated with the Offer Item. Note: This contains references to Passenger and Group instance(s) defined in the Passengers node.
Association to multiple Passenger instance(s). Example: pax1 pax2
Other Named Association(s). Note: Includes an association type choice (e.g. MediaGroup) and an instance association value (e.g. mediagrp1).
Named Instance Association Type. Examples: CarryOnAllowance, MediaGroup
Associated object instance value. Example: mediagrp1
Order details, including original order ID and original shopping response ID.
The Original airline-assigned unique Order ID. Example: ORDER-q988-ac01-a20b Note: This may be used when an Order has been sub-divided into associated Orders (eg because a change creates non-homogeneity in a PNR), and serves as a cross reference for the original Order ID.
Original Shopping Response ID(s), used to reference previously received shopping responses in order change transactions
Designator of Airline that owns/ assigned these IDs. Examples: BA Encoding Scheme: IATA/ A4A (two or three character) Airline Designator Code
Unique shopping session response ID. Example: 1F126AF1-7FCF-414F-8A3D-E4FFA408F747
The airline-assigned unique Offer Item ID. Example: OFFER769-A850-4EC4-8F46-02293F72D7E6
Associated Offer Item(s) and Optional Service(s).
Offer Item ID with optional Service ID(s).
Order Amendment information.
Amendment Detail.
Amendement Action Type. Examples: Add, Change, Delete, Reissue, Reprice
Action Type Context.
Ticket/document information.
Booking and Servicing Agent information.
Place of Issue of the agency or airline issuing the document followed by the name of the agency or airline issuing the document.
Passenger(s)/ Group associated with the Offer Item. Note: This contains references to Passenger and Group instance(s) defined in the Passengers node.
Association to multiple Passenger instance(s). Example: pax1 pax2
Order Item ID with optional Offer Item ID(s) and Service ID(s).
Offer Item ID with optional Service ID(s).
Passenger(s)/ Group associated with the Offer Item. Note: This contains references to Passenger and Group instance(s) defined in the Passengers node.
Association to multiple Passenger instance(s). Example: pax1 pax2
Associated Optional Service(s).
Passenger(s)/ Group associated with the Offer Item. Note: This contains references to Passenger and Group instance(s) defined in the Passengers node.
Association to multiple Passenger instance(s). Example: pax1 pax2
Other Named Association(s). Note: Includes an association type choice (e.g. MediaGroup) and an instance association value (e.g. mediagrp1).
Named Instance Association Type. Examples: CarryOnAllowance, MediaGroup
Associated object instance value. Example: mediagrp1
Passenger(s)/ Group associated with the Offer Item. Note: This contains references to Passenger and Group instance(s) defined in the Passengers node.
Association to multiple Passenger instance(s). Example: pax1 pax2
Other Named Association(s). Note: Includes an association type choice (e.g. MediaGroup) and an instance association value (e.g. mediagrp1).
Named Instance Association Type. Examples: CarryOnAllowance, MediaGroup
Associated object instance value. Example: mediagrp1
Order Action. Examples: Cancel, Create, Update, Delete, Reissue, Reprice
Action Type Context.
CORE ORDER ITEM definition.
Order Item details.
Order item-associated Time Limit(s).
Inventory Guarantee
Unique Inventory Guarantee ID. Examples: INVREF123456, 68E0-675C Note: This is a unique identifier issued by an Airline to reference that inventory for a specified offer will be guaranteed as available for a period.
Order Association(s).
Associated Order ID Example: ORDER7333
Associated Order Item ID(s). Example: ORD7333-001
Passenger(s)/ Groups associated with the Offer Item. Note: This contains references to Passenger and Group instance(s) defined in the Passengers node.
Association to multiple Passenger instance(s). Example: pax1 pax2
Other Named Association(s). Note: Includes an association type choice (e.g. MediaGroup) and an instance association value (e.g. mediagrp1).
Named Instance Association Type. Examples: CarryOnAllowance, MediaGroup
Associated object instance value. Example: mediagrp1
Penalty information.
DETAIL OFFER ITEM definition.
REPRICED ORDER ITEM definition.
Order Item details.
Inventory Guarantee
Unique Inventory Guarantee ID. Examples: INVREF123456, 68E0-675C Note: This is a unique identifier issued by an Airline to reference that inventory for a specified offer will be guaranteed as available for a period.
Order-associated Time Limit(s).
Current Order Item status. Example: OK (Confirmed) Encoding Scheme: IATA Padis Codeset - List for data element 4405 (Status, coded)
Penalty information.
Order Action. Examples: Cancel, Create, Update, Delete, Reissue, Reprice
Action Type Context.
Baggage Order Item.
Baggage Offer Item.
A BAGGAGE OFFER with additional Significant Carrier, Baggage Characteristics (e.g. dimensions/ weight) and Disclosures.
Price.
Validating Carrier Airline Designator.
A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory . Example: BA
Baggage Details.
Baggage detail.
Validating Carrier Airline Designator.
A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory . Example: BA
Baggage Disclosure information.
Elements relating to baggage charges.
Flight Offer Item.
FLIGHT Order Offer Item.
Contains all pricing information related to a flight.
Flight origin/ destination information.
Marketing Carrier information. Notes: This is the carrier that sells with its own code as part of a code share agreement on a flight that is actually operated by another carrier.
The carrier that operates a flight with a reference to its own prime flight number.
Note: Operating Carrier may be different from a Marketing Carrier(s), if the flight is actually marketed by another carrier(s) within a codeshare agreement.
Operating Carrier may not be the AOC holder, in which case, and wherever required, this will need to be disclosed to the customer.
Flight Details.
When TRUE, this flight OD pair should be priced.
When TRUE, there are one or more connections for this flight.
When TRUE, an electronic ticket may be issued.
When TRUE, the fare can be purchased without issuing a ticket.
Aircraft Equipment information, e. g. 733, 346. Refers to details and codes listed in Standard Schedules Information Manual (SSIM), Appendix A.
Aircraft Equipment Code. Example: 737 Encoding Scheme: IATA/ A4A Aircraft Equipment Code
Airline-specific aircraft equipment code. Example: 737-800
Aircraft name. Example: Boeing 737-800
Fare Detail.
Passenger(s)/ Group associated with the Offer Item. Note: This contains references to Passenger and Group instance(s) defined in the Passengers node.
Association to multiple Passenger instance(s). Example: pax1 pax2
Offer Item details including wait list indicator and inventory guarantee.
Inventory Guarantee
Unique Inventory Guarantee ID. Examples: INVREF123456, 68E0-675C Note: This is a unique identifier issued by an Airline to reference that inventory for a specified offer will be guaranteed as available for a period.
When TRUE, this offer item is waitlisted.
FLIGHT Order Item.
Flight Pricing.
Flight Origin/ Destination information.
Fare Detail.
Flight Item.
Other Order Item type, e.g. Lounge Pass and Expedited Boarding.
OFFER ITEM IN ORDER definition.
Time Limits, including mandatory Offer Expiration and Payment Time Limits.
Offer Item Type.
Flight Offer Item.
Other Offer Item type, e.g. Lounge Pass and Expedited Boarding.
OTHER ORDER ITEM definition.
Price.
Payment Status.
PAYMENT STATUS definition.
Overall Order payment Status Code.
In-complete Payment information, including partially completed payments, payment verification required and failed payments.
In-complete Payment Status Code.
Encoding Scheme: IATA Padis Codeset - List for data element 9321 (Application error, coded)
Note: This status includes partially completed payments, payment verification required and failed payments.
A Premium Seat Order Item, with seat characteristic details.
A Premium Seat Offer Item, with seat characteristic details.
A SEAT OFFER with additional Seat Characteristics information.
Price
Seat Description.
Seat Detail, including Marketing Name, Features, Size and Keywords.
Seat Location information.
Current status of the Order Item. Example: OK (Confirmed)
Encoding Scheme: IATA Padis Codeset - List for data element 4405 (Status, coded)
Order Item-Level Time Limits.
Payment Time Limit value.
Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z
Notes:
1. This is the deadline by which a commitment to pay must be made for the confirmed items in an offer as agreed witht he airline. The passenger meets this requirement by making complete payment for the order.
2. Payment Time Limit and Ticket Time Limit may be the same in most cases; however, Payment Time Limit expands to include ticketless transactions and other accountable documents.
3. This time limit is at the OFFER-LEVEL and will apply to all (child) Offer Items.
Although specified as mandatory in the BRD, there may be a case where Payment is already provided in the Order information.
Bank Account payment.
BANK ACCOUNT Payment Method definition.
Account Name. Example: JOHN SMITH
Note: This is the name the bank account is held under.
Check or draft number. Example: 1234
Cash payment.
CASH Payment Method definition.
Cash amounts with currency encoding.
Note: Supports multiple form of cash payments.
Cash Amount. Example: 67.95
Terminal ID where cash was collected. Example: QP776611
Cash receipt ID. Example: 121717H47S
Agent ID that collected the cash. Example: TOM123
Location where cash was collected.
DIRECT BILLING Payment Method definition.
Direct billing Organizaqtion ID. Example: IBM
Remit to Company Name. Example: IBM
Note: This is the company name to whom remittance should be directed.
Direct Billing Contact Name. Example: J THOMAS
Address where remittance should be directed.
Direct Bill payment.
Miscellaneous Charge Order (MCO) payment.
MCO Payment Method definition.
The ticket number of the miscellaneous charge order (MCO).
Other payment.
OTHER Payment Method definition.
PAYMENT PROCESSING Information definition.
Association(s), including Passenger and Group.
Payment Status information.
When TRUE, payment for this Order has failed.
Note: Payment Failure status is specified in the PaymentStatus node.
When TRUE, this Order has been partially paid.
Note: Partial Payment status and information is specified in the PaymentStatus node.
When TRUE, payment for this Order requires additional authentication.
Note: Payment Verification status and information is specified in the PaymentStatus node.
When TRUE, a price variance was applied.
Payment Amount.
Payment Method information.
Price variance actually applied during payment processing.
Price Variance Amount. Example: .67 USD
Association(s), including Passenger and Group.
Price Variance Rule Applied.
Applied Promotion(s).
Promotion Detail.
Association(s), including Passenger and Group.
PAYMENT CARD Payment Method definition.
Magnetic striped card type.
Credit card issuer code. Example: MC
Note: This is the 2 character code of the credit card issuer.
Concealed credit card number, Example: xxxxxxxxxxxx9922
Tokenized card number.
Note: This capability may not be supported by all NDC-enabled systems or may be supported by bilateral agreement only. If supported, the technical implementation of this capability is not dictated by this specification.
Name of credit card holder. Example: JOHN SMITH
Credit card issuing company.
Issuer Name. Example: Bank of America
Note: This is the name of bank or organization issuing the card (e.g., alumni association, bank, fraternal organization, etc.).
Cardholder Address.
Payment Card Effective and/ or Expiration date(s).
Payment Card Effective Date. Example: 0116
Payment Card Expiration Date. Example: 0119
Approval Code Method. Example: M (Manual)
Note: This is used to specify how the approval code for a credit card sale was obtained.
Encoding Scheme: IATA PADIS Code List for data element 9890.
Payment Card payment.
Loyalty Redemption payment.
REDEMPTION Payment Method definition.
Loyalty Certificates Redeemed.
The loyalty redemption certificate number.
An individual airline identifier assigned to a passenger who is a member of an airline's Frequent Flyer Program.
The quantity of loyalty units redeemed. Example: 15000
Promotion Code.
Note: Promotion code is the identifier used by the host to link directly with a specific named advertising campaign. By including the required code, the client is able to gain access to special offers which may have been created for a specifically targeted group via a CRM system or for a wider advertising campaign using Television or press adverts.
List of vendor codes associated with the promotion.
Voucher payment.
VOUCHER Payment Form definition.
Voucher ID or Number. Example: XX12345
Voucher Effective and/ or Expiration date(s).
Voucher Effective Date. Example: 2017-01-13
Voucher Expiration date. Example: 2017-06-13
Remaining Amount on Voucher.
Alternate Baggage Offer with Order Association definition.
Offer Association(s), including Order, Order Item, Passenger, Group, Offer Item and Service.
Alternate Other Offer with Order Association definition.
Offer Association(s), including Order, Order Item, Passenger, Group, Offer Item and Service.
Alternate Priced Flight Offer with Order Association definition.
Offer Association(s), including Order, Order Item, Passenger, Group, Offer Item and Service.
Alternate Seat Offer with Order Association definition.
Offer Association(s), including Order, Order Item, Passenger, Group, Offer Item and Service.
An Alternate Baggage Offer. Note: A Baggage Offer may contain additional Validating Carrier and Bag Detail, including Checked and Carry-on Baggage Allowance and Baggage Disclosure(s).
An Alternate Priced Flight Offer. Notes: 1. A Priced Flight Offer may contain Branded Fare information. If it is a Branded Fare, Price Class-association will be specified. 2. Additionally, Lead Pricing Calendar fares (prior to and/ or after the specified departure date) may be specified by passenger type.
A Generic Optional Service Offer. Note: A Generic Optional Service Offer may contain seat details, including Marketing Name; Seat Features; Seat Descriptive Keywords; and Seat Dimensions.Other Optional Service Offer type, e.g. Lounge Pass and Expedited Boarding.
An Alternate Seat Offer. Note: A Seat Offer may contain seat details, including Marketing Name; Seat Features; Seat Descriptive Keywords; and Seat Dimensions.
Order Penalty information.
ORDER PENALTY definition.
Flight Price definition.
Total Base Fare Amount. Example: 200000
Note: This includes surcharges (if applicable).
Applicable Surcharge(s).
Surcharge detail.
Ticket Tax/fee/charge details to indicate taxes that apply to country of commencement of travel and routing.
Order Price definition.
Current status of the Order Item. Example: OK (Confirmed) Encoding Scheme: IATA Padis Codeset - List for data element [4405] Status, coded
ORDER PROCESSING RESULTS Information definition.
Order-Level Time Limits.
Order Item-Level Time Limits.
Order Time Limits definition.
Order Item Time Limits definition.
NDC XML SPECIFICATION: Common XML Objects shared by NDC Payment and Ticketing Domain.
Notice: This is NDC Draft Specification provided for pre-review by the members of the relevant governance groups, it is not provided for implementation in a production environment or considered to be the final schema to support NDC business requirements. The draft schema may, at any time up to final specification submission, undergo changes including, but not limited to, specific elements, element names/labels, annotations or message name as a result of the ongoing quality control process, and comments, which may be received following the pre-review. Implementation of this version is done so at the risk of the implementer or implementing company.
Carrier Fee information.
A collection of detailed taxes assessed to a carrier fee.
CARRIER FEE definition.
Carrier Fee detail information to include Type, FeeAmount, FareComponent, ClassCode and Reporting code for Pricing Method.
Carrier Fee detail.
Carrier Fee Type.
Encoding Scheme: IATA Padis Codeset - List for data element 9750 (Option)
Note: This is the type of the carrier fee related to a booking or ticketing or service.
Carrier Fee amount and detail, including fee type, fee application and associated origin/ destination.
Carrier fee code type.
Carrier fee amount. Example: 100 USD
Currency encoding for the Carrier Fee Amount. Example: USD
Application code. Example: 15 (Not commissionable)
Encoding Scheme: IATA Padis Codeset - List for data element 9988 (Data Indicator)
Note: This is used to specify if the fee is not interlineable, not refundable, commissionable or not commissionable.
Departure Airport Location code. Example: TPA
Encoding Scheme: IATA/ A4A (three character) Airport or City Code
A series of data elements representing data required to collect non-airport/government fees, store the fee data,
and track the revenue separate from the ticket revenue without requiring a secondary document be issued.
Fare Component information as may be applicable in filed fares scenarios.
Fare Component calculation order (sequence number.) Example: 001
Tariff number for where the fare data is filed. Example: 9171
Rule number. Example: 126
Note: This is the rule number within the tariff where the fare data is filed.
Rule Code. Example: 12BE
Note: This is a system generated code indicating that the ticketed fare is from a specific rule filed fare sent by the issuing system.
A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory.
Carrier Fee Commercial Name. Example: British Airways
Fare class code. Example: M
Note: This is the fare class code that must be used when matching alternate cateory data as specifed by the carrier fee fare rule code, carrier fee rule number, and carrier fee tariff number fields.
Carrier fee pricing method. Example: A
Ticket Tax/fee/charge details to indicate taxes that apply to country of commencement of travel and routing.
Additional Reference information.
Note: Based on the specified Type, this may contain an invoice number, customer file reference, customer id, or airline indexing field.
Booking and Servicing Agent(s).
Checked-in Airline Flight Segment information.
Coupon information.
Coupon Effective/ Expire Date(s).
Airline Flight Coupon information.
Current Airline Flight Segment information.
Flight Segment information.
FlownAirline Flight Segment information.
In connection with document number (A document number representing a transaction that is issued in relation to this transaction); and coupon number (the coupon number(s) associated with the 'in connection with' document number.)
Place of Issue of the agency or airline issuing the document followed by the name of the agency or airline issuing the document.
Original Ticket/ Document Issue information.
Pricing information for the booked itinerary.
Ticket document details.
When true, the credit/debit card used for purchase must be presented.
When true, a penalty restriction applies.
When true, the document is non-commissionable.
When true, the document is non-interlineable.
When true, the document is non reissuable and/or exchangeable.
When true, the fare is non refundable.
When true, a tax has been collected and is due to a local government from the validating carrier.
When TRUE, this is the ticket/document number for a ticket/document that is being exchanged.
When TRUE, this is the primary ticket/document number.
The number of ticket/ documents to be issued.
Note: This is used as a checksum for the quantity of instances specified in the TktDocInfo node.
Traveler information.
Notes:
1. A combination of Anonymous and/ or Recognized Traveler information may be specified.
2. Anonymous Traveler includes a Passenger Type Code and quantity of passengers of this type.
Traveler information, including name, passenger type and contact.
COUPON-RELATED ADDITIONAL REFERENCE definition.
Additional Reference Type. Example: 6 (Customer ID)
Encoding Scheme: IATA Padis Codeset - List for data element 9958 (Reservation Control Type)
Additional Reference ID.
Note: Based on the specified Type, this may contain an invoice number, customer file reference, customer id, or airline indexing field.
COUPON ISSUING AIRLINE definition.
Issuing Airline Name. Example: British Airways
The place where the document was issued. Example: New York City NY
COUPON BOOKING/ SERVICING AGENT definition.
Agency/ Agent Identification Type. Example: 706 (IATA agency numeric code)
Encoding Scheme: IATA Padis Codeset - List for data element 9893 (Identification Type, coded)
ID. Example: 98417900
Note: The ID correlates to the specified ID Type.
Object association(s) between this object and any other object or metadata instance(s).
Object Metadata Association(s). Example: meta1 meta3
Entity Name.
COUPON definition.
Coupon Sequence Number. Example: 2
Note: This is the number representing the order in which this coupon was used or is to be used.
Applicable coupon number. Example: 1234
Coupon Refence Number. Example: 1
Note: This is the sequential number (segment identifier) of an individual flight segment.
Coupon Media Type. Examples: Electronc, Paper, Other
Coupon Valid date or date/time period.
Current status of the flight/value coupon. Example: E (Exchanged/reissued)
Encoding Scheme: IATA Padis Codeset - List for data element 4405 (Status, coded)
Involuntary Change Transaction Code. Example: I (Involuntary - no reason given)
Encoding Scheme: IATA Padis Codeset - List for data element 1245 (Status indicator, coded)
Settlement Authorization Code. Example: AUTH123
Note: This is a reference number generated by the validating carrier authorising settlement of a coupon.
Associated Fare Basis Code.
Note: This is the applicable code provided for IATA Resolution 728 (for the associated EMD.)
Promotional code that applies to the fee. Example: PROMO123
Date of Service. Example: 2017-01-17
Note: This is the scheduled date of service for this coupon of an EMD.
Service Quantity. Example: 1
Note: Thisis the number of services of the same type that are included in an EMD coupon.
Association to services paid by the EMD Association to multiple Optional Service instance(s). Example: srvc1 srvc2
Coupon Value. Example: 100 USD
Note: This is the value associated to a single coupon of a miscellaneous document.
Date and time, flight number, stopover indicator, and status code.
In connection with document number (A document number representing a transaction that is issued in relation to this transaction); and coupon number (the coupon number(s) associated with the 'in connection with' document number.)
Name and location of service provider that will perform the service described on an EMD coupon.
The name of service provider. Example: ???
The location of the service provider. Example: ???
Reason for Issuance information.
Note: This contains the Reason for Issuance Code (RFIC) and Reason for Issuance Subcode (RFISC.)
Reason for Issuance Subcode. Example: ???
Corresponding description to the reason for issuance subcode. Example: ???
Filed fee information.
Filed Fee Amount. Example: 100 USD
Bankers Seller Rate. Example: 1.25
Note: This is the BSR and/ or BBR used to convert the tax/fee/charge filed amount from the filed currency into the tax/fee/charge amount in currency of country of payment.
Contains product characteristics of an optional service, for inclusion on EMD. Includes type (Designates an optional service product characteristic type e.g., t-shirt size, color or pre-reserved seat number); and product characteristic value (Text that describes the product sold for the corresponding Product Characteristic Type, e.g. large, blue.)
Optional Service Product Characteristic. Example: ???
Note: This identifies the type of optional service product characteristic described in description.
Product Characteristic Description. Example: ????
Identifies the ATPCO additional services information.
ATPCO Optional Service Group Code. Example: ???
Note: This is a value which specifies the high-level group applicable to the service at the coupon level as defined by ATPCO.
ATPCO Optional Service Sub Group Code. Example: ???
Note: This is a value which specifies the sub group (within the specified group) applicable to the service at the coupon level as defined by ATPCO.
RFISC Issuance Type. Example: ZZZ (Mutually Defined)
Encoding Scheme: IATA Padis Codeset - List for data element 1131 (Code List Qualifier)
PAULA: Is the right code set?
ATPCO Service Type Code. Example: ?
Note: This is a value which specifies the service type.
Excess baggage information for this coupon.
Excess Baggage Amount. Example: 100 USD
Unit of Measure Code. Example: W (Weight)
Encoding Scheme: IATA Padis Codeset - List for data element 5463 (Allowance or Charge Qualifier)
Excess Baggage Unit Quantity. Example: 10
Excess Baggage Unit of Measure. Example: Pounds
Note: This is a standard unit of measure name (e.g., it could be generic such as metric or imperial or specific such as inches, feet, yards, miles, millimeters, centimeters, meters, kilometers- according to usage).
Coupon Validating Airline. Example: BA
Encoding Scheme: IATA/ A4A (two or three character) Airline Designator Code
Free text to provide further information related to the document and/or the coupon.
The two/three character designator identifying the Marketing Carrier designated in the new reservation.
This field contains the scheduled date of departure of the “Reservation Change” flight.
This field contains the destination Airport/City Code of the “Reservation Change” flight.
This field contains the scheduled departure time of the “Reservation Change” flight.
This field contains the flight number of the “Reservation Change” (Marketing Carrier) flight.
This field contains the origin airport/city code of the “Reservation Change” flight.
This field contains the reservations booking designator (Marketing) of the “Reservation Change” flight.
This field contains the Reservation Status Code of the “Reservation Change” flight.
When true, the coupon is consumed at issuance.
COUPON EFFECTIVE PERIOD definition.
The period in which the applicable coupon on an accountable document may be used for travel or for obtaining a service it entitles the holder to.
Effective period duration. Example: P3M
Note: This maybe used in combination with the Effective date, versus specifying an Expiration date.
The period in which the applicable coupon on an accountable document may be used for travel or for obtaining a service it entitles the holder to.
Effective period duration. Example: P3M
Note: This maybe used in combination with the Effective date, versus specifying an Expiration date.
COUPON-RELATED ORDER REFERENCE definition.
AIRLINE FLIGHT COUPON definition.
Scheduled, intended or actual departure date/ time.
Arrival date/ time.
Flight Stop Quantity and Location(s).
Stop Quantity. Example: 1
Information Source. Example: BA
Tour Operator Flight ID.
Note: This is an ID for the flight as represented by a Tour Operator. This flight is not necessarily in the inventory of an airline as it is a code created by tour operators.
Operating Carrier Information.
Operating Carrier is the carrier that operates a flight with a reference to its own prime flight number.
Note: Operating Carrier may be different from a Marketing Carrier(s), if the flight is actually marketed by another carrier(s) within a codeshare agreement.
Operating Carrier may not be the AOC holder, in which case, and wherever required, this will need to be disclosed to the customer.
Marketing Carrier information.
Notes: This is the carrier that sells with its own code as part of a code share agreement on a flight that is actually operated by another carrier.
Aircraft Equipment.
Note: Two instances of aircraft equipment may be specified if there is a change of gauge.
Reservation Status Code.
Encoding Scheme: IATA Padis Codeset - List for data element 4405 (Status, coded)
Seat Number. Example: 112B
Note: This is a seat assignment reserved for a confirmed flight at the time of ticket issuance.
Baggage related disclosures to passengers as required by several governments.
Unique Metadata Collection Token.
Example: jZhJu7SORZeO MNpifElIkA
Note: This token pertains to all specified metadata information, e.g. the metadata collection.
COUPON FLIGHT SEGMENT definition.
Information Source. Example: BA
Scheduled, intended or actual departure date/ time.
Tour Operator Flight ID.
Note: This is an ID for the flight as represented by a Tour Operator. This flight is not necessarily in the inventory of an airline as it is a code created by tour operators.
Operating Carrier Information.
Operating Carrier is the carrier that operates a flight with a reference to its own prime flight number.
Note: Operating Carrier may be different from a Marketing Carrier(s), if the flight is actually marketed by another carrier(s) within a codeshare agreement.
Operating Carrier may not be the AOC holder, in which case, and wherever required, this will need to be disclosed to the customer.
Marketing Carrier and Flight Number information.
Notes: This is the carrier that sells with its own code as part of a code share agreement on a flight that is actually operated by another carrier.
Aircraft Equipment.
Note: Two instances of aircraft equipment may be specified if there is a change of gauge.
Involuntary Change Transaction Code. Example: I (Involuntary - no reason given)
Encoding Scheme: IATA Padis Codeset - List for data element 1245 (Status indicator, coded)
COUPON TICKET DOCUMENT definition.
Coupon Document Number.
Note: This is the document number comprised of the airline code, form code, and serial number.
Coupon Type. Example: Y (EMD-S Standalone)
Encoding Scheme: IATA Padis Codeset - List for data element 1001 (Document/ Message Name, coded)
Connected Document Number.
Note: This is a ticket/ document to which this document is connected.
The number of booklets issued.
Date of Issue. Example: 2017-01-13
Time of Issue. Example: 14:32
Airport or City Code. Example: JFK
Encoding Scheme: IATA/ A4A (three character) Airport or City Code
Ticket Routing Code. Example: D
Note: This is for EMD-A and EMD-S tickets with routing.
- Use D - if all board and off points are within the same country
- Use I - if all board and off points are not within the same country
- For an EMD-S with no routing, do not use.
Airline Designator. Example: BA
Note: This is the airline designator representing the carrier whose fee was used on the EMD coupons.
Carry-on and checked baggage allowances.
Free text to provide further information related to the document and/or the coupon.
Coupon information.
Association to Penalty element in DataList. Example: PN1 PN2
COUPON-RELATED Traveler CORE definitiion.
Traveler last or surname. Example: SMITH
Traveler first or given name. Example: JOHN
Passenger type code and travelers quantity.
Example: ADT
Encoding Scheme: IATA (three character) Passenger Type Code
Frequent Travel Program information.
The date of birth of the traveler
When TRUE, this Traveler is an infant on lap that does not require a seat.
COUPON-RELATED Traveler DETAIL definitiion.
Traveler Email Contact.
COUPON definition.
Applicable coupon number. Example: 1234
Current status of the flight/value coupon. Example: E (Exchanged/reissued)
Encoding Scheme: IATA Padis Codeset - List for data element 4405 (Status, coded)
Previous status of the flight/value coupon. Example: E (Exchanged/reissued)
Encoding Scheme: IATA Padis Codeset - List for data element 4405 (Status, coded)
Settlement Authorization Code. Example: AUTH123
Note: This is a reference number generated by the validating carrier authorising settlement of a coupon.
The timestamp of the transaction)
Date and time, flight number, stopover indicator, and status code.
COUPON-RELATED IN CONNECTION DOCUMENT/ COUPON definition.
In Connection Document Number. Example: ???
In Connection Document Number. Example: ???
When true, the document and coupon should be associated.
COUPON-RELATED ORIGINAL TICKET/ DOC ISSUE definition.
Original Issuer ID. Example: 12345
Note: This is the ID of the original issuer of the document.
Issue Date. Example: 2017-01-13
Note: This is the date the document was originally issued.
Original Issue Location. Example: JFK
Encoding Scheme: IATA/ A4A (three character) Airport or City Code
Original Ticket/ Document Number. Example: ???
Note: This is the document number comprised of the airline code, form code, and serial number.
COUPON-RELATED PRICING definition.
Booked Itinerary Pricing Date. Example: 2017-01-13
Note: This is the date the booked itinerary was priced.
Booked Itinerary Pricing Time. Example: 09:15
Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)
Pricing Location. Example: JFK
Encoding Scheme: IATA/ A4A (three character) Airport or City Code
Booked Itinerary Pricing Country Code. Example: US
Encoding Scheme: ISO 3166-1 (two character) Country Code
Note: This is the code used to identify the country in which the booked itinerary was priced.
The document number, type and coupon numbers.
The following codes are used for new documents being issued:
J = EMD-A
T = Ticket
Y = EMD-Stand-alone
The following codes are used to identify documents with exchange value being exchanged or reissued:
A = All Other Document Types
E = Excess Baggage
J = EMD-A
M = MCO
O = Tour Order
S = Special Service Ticket
T = Ticket
Y = EMD-Stand-alone
"
The ticket/document number.
The type of ticket/document.
Encoding Scheme: IATA Padis Codeset - List for data element 1001 (Document/ Message Name, coded)
The document number, type and coupon numbers.
The ticket/document number.
The type of ticket/document.
Encoding Scheme: IATA Padis Codeset - List for data element 1001 (Document/ Message Name, coded)
Associated Coupon Number(s).
Coupon number.
COUPON TICKET DOCUMENT definition.
Coupon Document Number.
Note: This is the document number comprised of the airline code, form code, and serial number.
Coupon Type. Example: Y (EMD-S Standalone)
Encoding Scheme: IATA Padis Codeset - List for data element 1001 (Document/ Message Name, coded)
Coupon information.
Base Fare information.
Note: Base, Base Net and Base Sell Amount may be specified.
Equivalent Fare information detailing conversion of filed fares or taxes from currency of filing to currency of payment.
Note: Equivalent, Equivalent Net or Equivalent Sell Paid may be specified.
Fare information, as may be appliable in filed fares scenarios.
Account code, net reporting code, nonendorsable and nonrefundable indicators, penalty restriction indicator, pricing system, statistical code and tour code.
Total Fare information.
Note: Fare Total, Total Net and/ or Total Sell Fare may be specified.
Fare Calculation(s).
Note: Fare calculation area, net amount, sell amount, pricing indicator and reporting indicator may be specified.
BASE FARE TRANSACTION definition.
Base Fare Amount. Example 160 USD
Total Fare Amount Type. Examples: ADC (Additional Charge); Bulk; IT (Tour Inclusive); NOADC (No Additional Charge)
Base Fare Transaction Purpose. Example: Base, Equivalent
Note: This is used to indicate if this is base or equivalent fare transaction information.
EQUIVALENT FARE TRANSACTION definition.
Used to specify the equivalent, equivalent net or equivalent sell paid fare. Example 160 USD
Equivalent Fare Transaction Purpose. Example: Base, Net, Refund, Sell
Note: This is used to indicate if this is base or equivalent fare transaction information.
Conversion rate. Example: 1.25
Note: This is the BSR and/ or BBR used to convert the tax/fee/charge filed amount from the filed currency into the tax/fee/charge amount in currency of country of payment.
COUPON-RELATED FARE INFORMATION definition.
Account code, net reporting code, nonendorsable and nonrefundable indicators, penalty restriction indicator, pricing system, statistical code and tour code.
Validating Carrier-assigned Fare Rule Modification or Override information.
Fare Rule Waiver Code.
Note: This is a code assigned by the validating carrier that allows fare rule modification or override.
Fare Waiver Rule Type. Examples: ExchangeReissued, FareComponent
ATPCO Ticket Fare Category information.
ATPCO fare category number.
Detail information.
Net Reporting Code.
Note: This is a code indicating if the transaction is subject to a net reporting arrangement.
Statistical code.
Note; This is used for domestic or international sales differentiation.
Country code where the ticket is issued. Example: US
Encoding Scheme: ISO 3166-1 (two character) Country Code
The two/three character IATA assigned code identifying the system used to price the itinerary for the document being issued.
TOTAL FARE TRANSACTION definition.
Used to specify the total or total net amount. Example 160 USD
Total Fare Amount Type. Examples: ADC (Additional Charge); Bulk; IT (Tour Inclusive); NOADC (No Additional Charge)
Total Fare Transaction Purpose. Example: Base, Net, Refund, Sell
Conversion rate. Example: 1.25
Note: This is the BSR and/ or BBR used to convert the tax/fee/charge filed amount from the filed currency into the tax/fee/charge amount in currency of country of payment.
Reissue Sequence Number. Example: 2
Note: This is the sequence number assigned to each transaction amount.
COUPON-RELATED UNSTRUCTURED FARE CALCULATION definition.
Unstructured Fare Calculation Purpose. Example: Base, Net, Refund, Sell
Note: This is used to indicate if this is base or equivalent fare transaction information.
Pricing Code.
Note: This is the primary identifier reflecting the method of pricing for this transaction.
Reporting Code.
Note: This is a secondary identifier reflecting the method of pricing for this transaction used in the reporting process.
Fare Calculation.
Note: This is the fare calculation area that is required for ET.
Payment information.
ACCEPTED PAYMENT FORM definition.
The form of payment type. Examples: Credit Card, Cash.
Encoding Scheme: IATA PADIS code list data element [9888] Form of Payment Identification
The amount for this form of payment. Example: 300 USD
Used to specify if this is the old, new or orginal form of payment.
Encoding Scheme: IATA PADIS code list [9988] Data Indicator
Information relating to prepayment vouchers.
ORDER PAYMENT FORM definition.
Payment Form Details.
Information relating to prepayment vouchers.
The amount for this form of payment. Example: 300 USD
Payment Information Association(s).
Passenger(s) associated with the Offer Item. Note: This contains references to Passenger instance(s) defined in the Passengers/Passenger node.
Association to multiple Passenger instance(s). Example: pax1 pax2
Passenger(s) associated with the Offer Item. Note: This contains references to Passenger instance(s) defined in the Passengers/Passenger node.
Association to one or multiple Offer Item Set instance(s). Example:set1 set2
The person who is paying for an Order is not a passenger
Passenger Name information.
Note: Detailed Name information, such as prefix, title and suffix, are specified in PassengerMetadata.
Family name, last name
Example: SMITH
Family (first or given) name. Example: JOHN
Name Title. Examples: MR, MRS, DR
Surname Suffixes and / or Letters, Examples:Jr., Sr., III., Ret., Esq., Ph.D., M.D.
Middle name or initial. Examples: G, GEORGE
Used to specify if this is the old, new or orginal form of payment. Encoding Scheme: IATA PADIS code list [9988] Data Indicator
Actual Payment Method information.
PAYMENT METHOD definition.
Payment Method detail.
Used to specify if this is the old, new, or orginal form of payment.
Encoding Scheme: IATA PADIS code list 9988 - Data Indicator
Applied Promotions for this payment form.
Note: If specified, this individual payment form information will override any globally specified promotion information.
Promotion Detail.
Association(s), including Passenger and Group.
ORDER PAYMENT METHOD definition.
The form of payment type. Examples: Credit Card, Cash. Encoding Scheme: IATA PADIS code list data element [9888] Form of Payment Identification
Payment Method detail.
The amount for this form of payment. Example: 300 USD
Used to specify if this is the old, new, or orginal form of payment. Encoding Scheme: IATA PADIS code list 9988 - Data Indicator
Applied Promotions for this payment form. Note: If specified, this individual payment form information will override any globally specified promotion information.
Promotion Detail.
Association(s), including Passenger and Group.
Payment Information Association(s).
Associated Order ID Example: ORDER7333
Associated Order Item ID(s). Example: ORD7333-001
Passenger(s)/ Groups associated with the Offer Item. Note: This contains references to Passenger and Group instance(s) defined in the Passengers node.
Association to multiple Passenger instance(s). Example: pax1 pax2
Other Named Association(s). Note: Includes an association type choice (e.g. MediaGroup) and an instance association value (e.g. mediagrp1).
Named Instance Association Type. Examples: CarryOnAllowance, MediaGroup
Associated object instance value. Example: mediagrp1
When TRUE, this is a split form of payment.
NDC XML SPECIFICATION: PRICE CLASS XML OBJECT
Notice: This is NDC Draft Specification provided for pre-review by the members of the relevant governance groups, it is not provided for implementation in a production environment or considered to be the final schema to support NDC business requirements. The draft schema may, at any time up to final specification submission, undergo changes including, but not limited to, specific elements, element names/labels, annotations or message name as a result of the ongoing quality control process, and comments, which may be received following the pre-review. Implementation of this version is done so at the risk of the implementer or implementing company.
A data type for Price Class Associations.
A data type Price Class Association Type Name.
Price Class Associations.
Price Class Association Detail.
Named association type. Examples: ServiceBundle, MediaGroup
Associated object instance value. Example: mediagrp1
PRICE CLASS definition.
Price class name. Example: SUPERSAVER
Price class code. Example: 1, ABC
Fare Basis Code with optional application. Example: Y26
Price Class Associations.
The Airline requested default display order (in a client application) for this price class. Example: 2
NDC XML SPECIFICATION: NDC SEAT XML Object.
Notice: This is NDC Draft Specification provided for pre-review by the members of the relevant governance groups, it is not provided for implementation in a production environment or considered to be the final schema to support NDC business requirements. The draft schema may, at any time up to final specification submission, undergo changes including, but not limited to, specific elements, element names/labels, annotations or message name as a result of the ongoing quality control process, and comments, which may be received following the pre-review. Implementation of this version is done so at the risk of the implementer or implementing company.
CORE SEAT definition.
Seat Location information.
Seat Details, including Marketing Name, Description(s), Feature(s), Size and Keywords.
CORE SEAT definition.
Seat Location information.
DETAIL SEAT definition.
Seat Details, including Marketing Name, Description(s), Feature(s), Size and Keywords.
SEAT LOCATION definition.
Seat column. Example: A
Seat row number and row characterisitcs
Seat row number. Example: 2
Row characteristic.
Examples:
A (Extra Leg Room)
B (Buffer Row)
MV (Row With Movie Screen)
Encoding Scheme: IATA PADIS Code List for data element 9864 - Row Characteristic
Seat Details for the entire Row.
Seat row Characteristic(s).
Refers to aircraft seat characteristics; seat option codes. Examples: E (EXIT ROW), M (Middle Seat), A (Aisle seat), L (Left side of aircraft), Q (Bulk Head). Refer to PADIS code list 9825.
Additional Seat Remark(s).
SEAT CHARACTERISTICS definition.
Exit Row position details
SEAT MAP DISPLAY definition.
EXIT row detail.
First row number.
Example: 15
Specifies the exit row position in wide body Aircraft.
Last row number.
Example: 16
Specifies the exit row position in wide body Aircraft.
Exit row position.
Examples:
B (Back)
C (Center section)
F (Front)
FB (Front and Back)
FMB (Front, Middle and Back)
L (Left side section)
LC (Left center section)
R (Right side section)
RC (Right center section)
Encoding Scheme: IATA PADIS Code List for data element 3227 - Place/Location Qualifier
When TRUE, this section is on the upper deck of an aircraft.
Note: If being used in a Seat Map, this may indicate that a separate seatmap graphic is requested.
Over the Wing Row information.
SEAT MAP WING POSITION definition.
Row detail.
First row number.
Example: 15
Last row number.
Example: 16
When TRUE, this section is on the upper deck of an aircraft.
Note: If being used in a Seat Map, this may indicate that a separate seatmap graphic is requested.
Media Content Seat Camera Position information.
Row information for graphical seat maps, to indicate link or images to the entire section defined by the range.
Row number value.
Example: 11
Icon placement (in orientation to cabin row or column).
Examples:
FRO (Place icon before row)
INL (Place icon inline with row or column)
LEF (Place icon left of column)
REA (Place icon behind row)
RIG (Place icon right of column)
Encoding Scheme: IATA PADIS code list COT - Camera Orientation Type
Column position information used for graphical seat map constructions (ie image or link to the entire section as indicated by the defined range).
Column position value.
Example: C
Icon placement (in orientation to cabin row or column).
Examples:
FRO (Place icon before row)
INL (Place icon inline with row or column)
LEF (Place icon left of column)
REA (Place icon behind row)
RIG (Place icon right of column)
Encoding Scheme: IATA PADIS code list COT - Camera Orientation Type
Seat display information.
Seat column to identify a particular seat position on an aircraft
Column position in of the seat.
Example: A (AISLE SEAT)
For maximum interoperability, refer to IATA PADIS Code List for data element 9825 - Seat Characteristic, Coded.
Contains rows and seat information for seat display purposes
First row number. Example: 08
Last row number. Example: 44
Seat information by aircraft section.
Non-Seat Cabin Component information.
Seat Size and Marketing information.
SEAT MAP COMPONENT definition.
Component Location information.
Component location information.
Actual space occupied by this component.
Example:
GALLEY COVERS ROWS 15-17 AND COLUMNS A-C
A range of rows covered by a non-seat cabin component for seat map information
First row occupied by this item. Example: 13
Last row occupied by this item. Example: 17
All columns covered on the map by this item.
Left most column occupied by this item. Example: A
Right most column occupied by this item. Example: C
Row information for graphical seat maps, to indicate link or images to the entire section defined by the range.
Row number value.
Example: 11
Icon placement (in orientation to cabin row or column).
Examples:
FRO (Place icon before row)
INL (Place icon inline with row or column)
LEF (Place icon left of column)
REA (Place icon behind row)
RIG (Place icon right of column)
Encoding Scheme: IATA PADIS code list COT - Camera Orientation Type
Column position information used for graphical seat map constructions (ie image or link to the entire section as indicated by the defined range).
Column position value.
Example: C
Icon placement (in orientation to cabin row or column).
Examples:
FRO (Place icon before row)
INL (Place icon inline with row or column)
LEF (Place icon left of column)
REA (Place icon behind row)
RIG (Place icon right of column)
Encoding Scheme: IATA PADIS code list COT - Camera Orientation Type
Cabin component.
Examples:
701 (Movable compartment divider)
702 (Convertible seats)
AR (Air phone)
BA (Bar)
BK (Bulkhead)
CL (Closet)
G (Galley)
LA (Lavatory)
LG (Luggage storage)
MV (Movie screen)
SO (Storage space)
ST (Stairs to upper deck)
TA (Table)
Encoding Scheme: IATA PADIS Code List for data element 9978 - Cabin Facilities Characteristic
Seat Dimensions.
Note: Defines the size of this item in actual measurement units or defines how much space in relation to rows and columns the space of this item actually consumes.
Component size by number of rows (length) and number of columns (width).
Length in number of ROWS value. Example: 2.5
Width in number of COLUMNS value. Example: 2.5
Actual component size information.
First row number.
Example: 15
Front to back LENGTH measurement value. Example: 70
Front to back WIDTH measurement value. Example: 70
Seat size and marketing information definition.
Associated Keyword Unit of Measure, if relevant. Example: INCH
Lowest Pitch Measurement value for this section. Example: 32
Lowest Width Measurement value for this section. Example: 20
Seat Description Key-Value Word Pairs.
Examples:
ReclineDegree - 25
BedLengthLowEnd - 68
BedLengthHighEnd - 78
WidthLowEnd - 20
WidthHighEnd - 21.5
PitchLowEnd - 32
PitchHighEnd - 34.4
Key-Value detail.
Images and/or links for the entire section defined by the range of rows.
SEAT MAP COMPONENT MEDIA and MESSAGE definition.
Images applicable to this section
Image ID defined in root node MediaContent.
Examples:
IMG713
SFO_LOUNGE
Camera position on seat map information.
=notes=
1. This is the desired position where camera icon or equivalent needs to be positioned on a seat map.
Links applicable to this section
Camera position on seat map information.
=notes=
1. This is the desired position where camera icon or equivalent needs to be positioned on a seat map.
Marketing message for all seats in this section.
Aircraft seat row with seat map ghost row metadata definition.
Ghost row suffix.
Example: A
Notes: A "Ghost" row may be used to identify non-seat rows that contain components, such as lavatory and galley, by their seat characteristics.
Ghost row position.
Examples:
BACK
FRONT
Notes: Identifies if the Ghost row is in front of or behind the referenced true row.
Example: If there is a lavatory, taking the equivalent space of 2 rows in front of row number 1, the values for the 2 ghost rows needed would be:
Row="1"+ RowSuffix="A" and Row="1" + RowSuffix="B".
The RowPos value would be "FRONT" (in front).
NDC XML SPECIFICATION: Transaction Security data components.
disclaimer: This is NDC Shopping Draft Specification provided for pre-review by the members of the relevant governance groups, it is not provided for implementation in a production environment or considered to be the final schema to support NDC shopping requirements. The draft schema may, at any time up to final specification submission, undergo changes including, but not limited to, specific elements, element names/labels, annotations or message name as a result of the ongoing quality control process, and comments, which may be received following the pre-review. Implementation of this version is done so at the risk of the implementer or implementing company.
Message Security information.
A data type for Message Security.
Agent duty code
Agency IATA number
Pseudo City code. Example: AAA2
Defines where the PCC was created. For example 1A, 1P, 1S
LNIATA Number – CRT Address/Terminal ID
ERSP Number: The eight digit IATA
assigned ERSP code.
Department/Identifier
Carrier/GDS Department Code
Airline specific codes applicable for the Services record owner or the carrier specified in bytes 23-25, defined as follows:
Code Definition
RES = all reservation centers
ATO = all airline ticket offices
CTO = all city ticket offices
WEB = website
NDC XML SPECIFICATION: OPTIONAL SERVICE XML OBJECT
A data type forService Combination Rule constrained list.
A data type for Service Combination Rule.
Examples: CombinationOK, DoNotCombine, Other
A data type for Service Coupon Type constrained list.
A data type for Service Coupon Type.
Examples: E-Ticket, Flight, No_EMD, Standalone, Ticket, Other
A data type for Service Associations.
A data type Service Association Type Name.
Service Associations.
Anonymous, Recognized and/or PTC that the offer applies to.
When TRUE, this Baggage Offer applies to all specified Travelers.
Association to multiple Traveler instance(s). Example: Traveler1 Traveler2
Note: May be Recognized or Anonymous Traveler (by PTC) instance(s).
Flight that the offer applies to.
When TRUE, this Baggage Offer applies to all specified flights.
When TRUE, this Baggage Offer applies to all specified flight Origin/ Destination Pairs.
When TRUE, this Baggage Offer applies to all specified flight Segments.
Offer Item Association.
Other association(s).
Other Service Associations.
Other Association Detail.
Note: Includes an association type choice (e.g. MediaGroup) and an instance association value (e.g. mediagrp1).
Named association type. Example: MediaGroup, SSR
Value of the SSR code.
Associated object instance value. Example: mediagrp1
Unique Service Bundle ID. Example: BUNDLE-2B88-4C33
Reason For Issuance Code
Examples:
A (Air Transportation)
C (Baggage)
E (Airport Services)
F (Merchandise)
G (In-flight Services)
Refer to PADIS Codeset for data element 4183 - Special Condition.
IATA Optional Service Reason for Issuance Code (RFIC) definition.
Core Optional Service information.
OPTIONAL SERVICE CORE definition.
Service name. Example: Lounge Pass
Service Codes and Reason for Issuance.
Two character generic code to identify ticket level charges, fees and taxes.
SERVICE Description.
Note: Supports plain text, multimedia and code and link references.
Interline Settlement information between airlines, including method of settlement, interline settlement value and currency.
Service settlement method.
Examples:
AD (Internal Airline Document)
DS (Direct Settlement)
EA (EMD Associated or Internal Airline Document)
ES (EMD Standalone )
FI (Fare Integrated)
MA (Flight Associated, Settled via MCO)
MS (Standalone, Settled via MCO)
Encoding Scheme: IATA PADIS Codeset SST (Service Settlement Type)
Settlement (Price) Value. Example: 300 (USD)
Note: This represents a Settlement value that is only used between the POA and ORA.
Optional SERVICE PRICE.
Notes: This Price amount may be set to zero if pricing has been applied at the Offer Item level.
Optional service booking instructions to include SSR, OSI and Upgrade Method.
Passenger assistance SSR code value.
Examples:
EXST (EXTRA SEAT REQUIRED)
INFT (INFANT ACCOMPANYING ADULT PASSENGER)
PETC (PASSENGER TRAVELING WITH PET IN CABIN)
UMNR (UNACCOMPANIED MINOR)
For maximum interoperability, it is recommended that IATA (four character) Special Service Request (SSR) Code values be used. Select an enumerated value from the list of enter a four character SSR code string.
=notes=
1. Although optional in the schema, some SSR codes may require associated description elements.
Other service information (OSI) text.
Example: PAX VIP MEMBER OF PARLIAMENT
PNR booking method.
Example: AE (BY SSR - SPECIAL SERVICE REQUEST)
For maximum interoperability, refer to IATA PADIS Code List for data element 9750. Select a code value or enter a value that is bilaterally agreed upon between trading partners.
Upgrade method.
Example: AE (BY SSR - SPECIAL SERVICE REQUEST)
For maximum interoperability, refer to IATA PADIS Code List for data element 9750. Select a code value or enter a value that is bilaterally agreed upon between trading partners.
New class of service.
Example: B
Data center instructions.
Aircraft equipment information.
Validating Carrier Airline Designator.
A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory . Example: BA
Other Service Association(s).
OPTIONAL SERVICE DETAIL definition.
Detailed Service information, including Service Bundle, Service Combinations, Service Coupon, Service Fulfillment and Service Quantity Rules.
OPTIONAL SERVICE TO BE PRICED definition.
Service Codes and Reason for Issuance.
Fulfillment detail.
Service Fulfillment Period.
Note: This is the start and end date/time period(s) the service may be fullfilled or used.
The EARLIEST date the associated optional service is available or may be used. Example: 2017-01-13
The LATEST date the associated optional service is available or may be used. Example: 2017-03-13
Information about the company or party that will fulfill the service.
Information about the location where the service will be fulfilled.
.
Flight, Flight Segment and/ or Traveler association(s).
Exclude=false , Include=true, Default value is true
OPTIONAL SERVICE ENCODING definition.
Note: Includes IATA Optional Service Reason for Issuance Code (RFIC) code and Issuance Sub Code.
Service code. Examples:
XLEG (Extra Leg Room Seat, implementer encoding)
XBAG (Extra Bag, implementer encoding).
Used in conjunction with SubCode (Associated Reason For Issuance SubCode).
Associated Reason For Issuance Sub Code.
Examples:
0CC (First Checked Bag)
0B1 (In-flight Entertainment)
0BX (Lounge)
0B3 (Meal/ Beverage)
0B5 (Pre-reserved Seat Assignment)
0G6 (Priority Boarding)
Are these on an IATA Codelist or do they need to be added via FastTrack?
A data type for Optional Service Descriptions.
Service Description detail.
Description Application. Examples: SEAT 3B, Discount 15P
Optional Service Filter(s).
OPTIONAL SERVICE FILTER definition.
Identifies additional services codes, and may refer to ATPCO additional services information or airline specific/ bilaterally agreed codes.
Service Sub-Group Code(s).
Group BG: CT (Container), PP (Pre-Paid Excess Baggage)
Group IE: IT (Internet Access), TV (Television)
Service Fulfillment Airport Location.
Physical address where service fulfillment will occur.
OPTIONAL SERVICE FULFILLMENT representation, including Date/ Time Period, Location, Fulfillment Company.
Service Fulfillment Period.
Note: This is the start and end date/time period(s) the service may be fullfilled or used.
The EARLIEST date the associated optional service is available or may be used. Example: 2017-01-13
The LATEST date the associated optional service is available or may be used. Example: 2017-03-13
Information about the company or party that will fulfill the service.
Information about the location where the service will be fulfilled.
OPTIONAL SERVICE AIRPORT LOCATION representation.
Airport Location Code. Example: TPA
Encoding Scheme: IATA/ A4A (three character) Airport or City Code
OPTIONAL SERVICE ADDRESS LOCATION representation.
A data type for Optional Service Price.
Total price. Example: 6000 USD
Note: This is the total price INCLUDING base price, taxes and fees/ surcharges.
Amount or Percent value indicating the refund value of the service.
Price breakdown amount in currency. Example: 800 USD
Note: This is the individual price excluding base price, taxes and fees/ surcharges.
Commission percentage. Example: 20
Price breakdown details.
Price breakdown sub-total.
Notes:
1. This is the total all price breakdown items, excluding tax and/ or surcharge.
2. Subtotal may be specified as Currency (simple and detail); Award/ Redemption; or combination of Partial Currency and Award Redemption.
Price details.
Note: This price does not include taxes and fee/ surcharges.
Price application. Example: Base Fare
Price breakdown amount. Example: 60 USD
Notes:
1. This is the individual price excluding base price, taxes and fees/ surcharges.
Ticket Tax/fee/charge details to indicate taxes that apply to country of commencement of travel and routing.
Individual fee/ surcharge information would appear on the accountable document.
Optional SERVICE PRICE.
Note: This is a price that is used for BSP and may be different from the price reflected in the offer.
Optional SERVICE COMBINATIONS.
Note: This contains Optional Services that may or may not be combined with one another.
Optional SERVICE FULFILLMENT, including Date/ Time Period, Location, Fulfillment Company.
Optional SERVICE COUPON Information, including Fee Basis and Coupon Type.
Minimum and Maximum Service Ordering Quantity.
SERVICE COMBINATION RULES representation.
Service Combination detail.
Service Combination Rule.
Examples: Permitted, NotPermitted, Other
A data type for Optional Service Coupon.
Instant purchase type.
Examples:
CC (Ticketless purchase immediately charged to credit card)
NO (Not an instant purchase)
TT (Simultaneous with time of ticketing)
Encoding scheme: IATA PADIS Codeset IPT - Instant Purchase Type
Service fee basis.
Examples:
DIS (Option directly applied to fare)
FEE (Baggage only)
FNA (Item is not available/ applicable)
INC (Item is free of charge)
NAP (Item not applicable/ available)
SUR (Surcharge)
Encoding Scheme: IATA Padis Codeset - List for data element SFB - Service Fee Basis
Contains instruction on what type of traffic document should be issued for an optional service.
Examples:
EMD Associated
EMD Standalone
No EMD
Electronic Ticket
MINIMUM/ MAXIMUM Service Ordering Quantity definition.
The MINIMUM Quantity of the Service Item that may be ordered.
Example: 2
The MAXIMUM Quantity of the Service Item that may be ordered.
Example: 4
Eligible Class of Service Upgrade information.
Information relating to the commission amount claimable by a Travel Agent for services on behalf of an airline.
Free-text instructions.
Special Need Order Request/ Booking Method.
Examples:
AE (by SSR-Special Service Request)
AF (by OSI-Other Service Information)
Encoding scheme: PADIS Codeset for data element 9750 - Option
"A unique Service ID that has been returned in the Shopping results, and identifies an airline service item (ie a product or a service) that can be separately delivered and uniquely described by an airline.
Example: SRVC-2B88-4C33-9787-9461114BC9BE"
UNIQUE SERVICE ID representation.
The airline-assigned unique Service ID. Example: SRVC_ccecc4aa-791867b9b2e6
Airline designator or CRS code of the owner/ assigner of the Offer ID, typically used for offer ordering purposes. Example: UA, BA
Encoding Scheme: IATA/ A4A (two or three character) Airline or CRS Designator Code
NDC XML SPECIFICATION: Base Structures, including base types for NDC XML data objects, utility xml objects and core simple type definitions.
Notice: This is NDC Draft Specification provided for pre-review by the members of the relevant governance groups, it is not provided for implementation in a production environment or considered to be the final schema to support NDC business requirements. The draft schema may, at any time up to final specification submission, undergo changes including, but not limited to, specific elements, element names/labels, annotations or message name as a result of the ongoing quality control process, and comments, which may be received following the pre-review. Implementation of this version is done so at the risk of the implementer or implementing company.
A data type for Flight Origin with Additional Location Preference and Date/Time Qualifiers.
Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory . Example: TPA
Notes:
1. A proximity search, e.g. within 25 miles, may be specified using the Radius attributes.
2. A preference level for the specified location code may specified using the Preference attributes.
Preference Level for specified Airport or City code.
Search Radius for specified Airport or City code.
Departure date. Example: 2017-01-13
Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)
Departure time. Example: 09:15
Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)
Lead Pricing information used in calendar shopping scenarios.
A data type for Flight Destination with Additional Location Preference and Date/Time Qualifiers.
Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory . Example: TPA
Notes:
1. A proximity search, e.g. within 25 miles, may be specified using the Radius attributes.
2. A preference level for the specified location code may specified using the Preference attributes.
Preference Level for specified Airport or City code.
Search Radius for specified Airport or City code.
Arrival (destination) date. Example: 2017-02-13
Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)
Arrival (destination) time. Example: 09:15
Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)
Lead Pricing information used in calendar shopping scenarios.
Affinity Shopping Query FLIGHT DEPARTURE (Origin) AIRPORT/ CITY information.
A data type for Affinity Query State or Province Flight Departure (Origin) information.
State or Province Departure (origin) information.
A data type for Affinity Query State or Province Flight Arrival (Destination) information.
State or Province Arrival (destination) information.
A data type for Affinity Query Country Flight Departure (Origin) information.
Country Departure (Origin) information.
A data type for Affinity Query Country Flight Arrival (Destination) information.
Country Arrival (Destination) information.
A data type for Affinity Query Reference Point Flight Departure (Origin) information.
Reference Point Departure (Origin) information.
A data type for Affinity Query Reference Point Flight Arrival (Destination) information.
Reference Point Arrival (Destination) information.
Affinity Shopping Query FLIGHT ARRIVAL (Origin) AIRPORT/ CITY information.
Affinity Shopping Query FLIGHT DEPARTURE (Origin) COUNTRY information.
Affinity Shopping Query FLIGHT ARRIVAL (Origin) COUNTRY information.
Affinity Shopping Query FLIGHT DEPARTURE (Origin) REFERENCE POINT information.
REFERENCE POINT RADIUS QUERY representation.
Reference Point(s), e.g. Cities and Metro Areas.
Reference Point Name or Code. Examples: TAMPA, TPA
Reference Point Proximity.
Notes:
1. This contains either the requested maximum distance search radius values -or- the actual Proximity information, which is typically used to specify the results from the named location radius search.
Reference Point Name or Code. Examples: TAMPA, TPA
Proximity Data Application. Example: SearchRadius, ActualProximity, Other
The actual distance value from the named location search. Example: 20
Distance unit of measure. Examples: Miles, Kilometers
Affinity Shopping Query FLIGHT ARRIVAL (Origin) REFERENCE POINT information.
Affinity Shopping Query FLIGHT DEPARTURE (Origin) STATE or PROVINCE information.
Affinity Shopping Query FLIGHT ARRIVAL (Origin) STATE or PROVINCE information.
DATE-based Lead Period(s).
TIME-based Lead Period(s).
LEAD DATE PERIOD representation.
Notes: Supports Calendar Shopping. Days, Months, etc. before and/ or after the specified date.
The period duration to be applied BEFORE (prior to) the specified date. Examples:
P3D (three days)
P7D (seven days)
The period duration to be applied AFTER the specified date. Examples:
P3D (three days)
P7D (seven days)
LEAD TIMES PERIOD helper object.
Notes: Supports Calendar Shopping and Departure/ Arrival Time preferences.
The period duration to be applied BEFORE (prior to) the specified time. Examples:
P3D (three days)
PT2H (two hours)
The period duration to be applied AFTER the specified time. Examples:
P3D (three days)
PT2H (two hours)
Traveler information.
Notes:
1. A combination of Anonymous and/ or Recognized Traveler information may be specified.
2. Anonymous Traveler includes a Passenger Type Code and quantity of passengers of this type.
Anonymous or Recognized Traveler information.
Discount Program Qualifiers; fare type for this PTC.
Notes:
1. Supports pricing discounts and/ or other benefits from membership in Travel Discount Programs, such as AARP and AAA.
2. Discount Programs may be associated to individual Travellers but will apply to ALL Travellers if no associations are specified.
A data type for a Discount Program Qualifier.
Membership account or ID number. Example: 0956301007
Code for an organization or assocIation which owns or sponsors a particular discount program which an airline may support (discount progam support could be in on a bilateral basis).
Examples: AARP, AAA.
Program name.
Example: AARP MEMBERSHIP
AIRLINE INCENTIVE Program Qualifiers.
Notes:
1. Supports pricing discounts and/ or other benefits from membership (business, group and individual) in an airline-sponsored Incentive Program.
2. Incentive Programs ARE NOT Frequent Traveler Loyalty (FQTV) programs.
3. Incentive Programs may be associated to individual Travelers but will apply to ALL Travelers if no associations are specified.
A data type for Incentive Program Qualifier.
Incentive program name.
Example: RFSB (Reward for small businesses)
Corporate or individual membership account identification for an airline sponsored incentive program (Incentive Programs are NOT Frequent Traveler Loyalty (FQTV program). Example: IBM123
Designator of airline offering the incentive program. Example: BA
Encoding Scheme: IATA/ A4A (two or three character) Airline Designator Code
Member or participant status within the program. Examples: VP, DIRECTOR, EXEC
PRE-PAID TRAVEL Programs.
Notes:
1. Supports pricing flight offers and/ or other benefits from non-revenue and Air Pass Program certificates.
2. Each Prepaid Travel Program MUST be associated to ONE individual Traveler.
A document which can be prepaid or book of coupons to be purchased up-front
Programs Status Qualifier.
Example: Elite status.
Program status name.
A data type for Credit Card Qualifier.
The two letter payment card type. Examples: MC, VI
Payment card IIN/ BIN number. Example: 401123
Note: This is the first 6 digits of a credit card number known as the Issuer Identification Number (IIN), previously known as bank identification number (BIN), that identifies the institution that issued the card to the card holder.
A data type for Social Media Qualifier.
Social media service/ program name. Examples: FACEBOOK, TWITTER
User or profile identification.
Example: JOHNSMITH2367
Email address. Example: [email protected]
Start and End Date Range with Minimum/ Maximum Stay Duration.
A data type for Start and End Date Range with Minimum/ Maximum Stay Duration.
Starting Date of the stay period range. Example: 2016-01-13
Ending Date of the stay period range. Example: 2016-03-13
Minimum Stay Period within the specified date range.
Examples: P5D (five days)
Maximum Stay Period within the specified date range.
Example: P10D (ten days)
Season (Months/ Quarters) with Minimum/ Maximum Stay Duration.
A data type for Season (Months/ Quarters) with Minimum/ Maximum Stay Duration.
Minimum Stay Period within the specified calendar season.
Examples: P5D (five days)
Maximum Stay Period within the specified calendar season.
Example: P10D (ten days)
GROUP (ALL TravelerS) Budget information.
A data type for GROUP BUDGET Qualifier.
Budgeted amount for ALL TravelerS.
Example: 17000 USD
Allows to specify travel budget in a shopping request, on per individual traveler baisis, mainly in "affinity" type shopping requests.
A data type for PER PERSON BUDGET Qualifier.
Budgeted amount PER PERSON.
Example: 1700 USD
BAGGAGE PRICING Qualifiers.
BAGGAGE PRICING Qualifier.
Carry-on options requested. Example: N (DO NOT PROCESS CARRY-ON RECORDS)
Encoding Scheme: IATA PADIS code list BCC-Baggage Carry On Action
Prepaid option. Example: O (ONLY RETURN PREPAID BAG FEE)
Encoding Scheme: IATA PADIS code list BPO-Baggage Prepaid Option
Request action. Example: D (DISPLAY ONLY)
Encoding Scheme: IATA PADIS Code List for data element 1225
Allowance catalog requested. Example: C (CATALOG ONLY)
EXISTING ORDER Qualifier.
Existing Booking Reference (e.g. PNR Record Locator). Example: R1A3SK
A data type for Shopping Request Business Object: SPECIAL FARE Qualifiers.
Company profile index associated with this special fare. Example: COM1234
Contract ID used for pricing special fares. Example: 675124
Corporate account name or ID used for pricing special fares. Example: 675124
Contains card type, and Issuer Identification Number.
DISCOUNT, INCENTIVE and PRE-PAID PROGRAM Qualifer.
Program Qualifier detail.
Promotion(s) Information.
Notes:
1. Supports pricing discounts and/ or other benefits for Travelers with Promotion Codes issued (or sponsored by) Airlines, Travel Agencies and/ or Companies.
2. Promotion Codes may be associated to individual Travelers but will apply to ALL Travelers if no associations are specified.
Country where the Credit Card was issued.
A data type for Shopping Request Business Object: PROGRAM Qualifiers.
Discount Program Qualifiers; fare type for this PTC.
Notes:
1. Supports pricing discounts and/ or other benefits from membership in Travel Discount Programs, such as AARP and AAA.
2. Discount Programs may be associated to individual Travellers but will apply to ALL Travellers if no associations are specified.
A data type for Shopping Request Business Object: PROMOTION CODE Qualifiers.
A data type for Shopping Request Qualifiers.
Qualifier choices.
SEAT Qualifier.
Seat assignment information.
Element to associate seat to a Traveler and s flight segment.
Optional Services to INCLUDE/ EXCLUDE in Pricing Qualifiers.
Social Media Account information.
Notes:
1. Supports benefits for social media account holders.
2. Each Social Media Account MUST be associated to ONE Traveler.
Special fares, which may be private or negotiated fares.
Notes:
1. Supports pricing discounts and/ or other benefits for Travelers affiliated with companies with private fare and/ or negotiated rate contracts.
2. Private Fares apply to ALL Travelers.
Passenger Special Needs Attributes.
Notes:
1. Supports specification of Traveler special needs in both IATA SSR encoding and non-IATA encoding.
2. Special Needs may be associated to individual Travelers but will apply to ALL Travelers if no associations are specified.
3. Special Needs may be associated to flight segments but will apply to ALL flight segments if no associations are specified.
A data type for Shopping Request Business Object: SOCIAL MEDIA Qualifiers.
A data type for Shopping Request Business Object: SPECIAL NEED Qualifiers.
TRIP PURPOSE Qualifier.
AIRLINE SUPPLIER Preferences.
AIRLINE ALLIANCE PROGRAM Preferences.
AIRLINE SUPPLIER Preferences.
Airline Supplier information.
Geographical indicator type. Example: DOM (DOMESTIC/ DOMESTIC)
Encoding Scheme: IATA Padis Codeset - List for data element 9970 (Product Details Qualifier)
Flight haul length type. Example: LH (LONG-HAUL 6 HRS PLUS)
Encoding Scheme: IATA Padis Codeset - List for data element FHT (Flight Haul Type)
AIRLINE ALLIANCE PROGRAM Preferences.
Used to specify the alliance CodeSet. Refer to IATA PADIS Code List for data element 9906.
Geographical indicator type. Example: DOM (DOMESTIC/ DOMESTIC)
Encoding Scheme: IATA Padis Codeset - List for data element 9970 (Product Details Qualifier)
Flight haul length type. Example: LH (LONG-HAUL 6 HRS PLUS)
Encoding Scheme: IATA Padis Codeset - List for data element FHT (Flight Haul Type)
A data type for Best Pricing Method Preference.
Best Available Fare Pricing Method.
Examples:
Y (BEST FARE IN SAME CABIN CLASS)
C (BEST FARE ACROSS ALL CABIN CLASSES)
N (PRICE ACCORDINGLY TO OTHER DESIGNATED PRICING PARAMETERS)
BEST FARE IN SAME CABIN CLASS
BEST FARE ACROSS ALL CABIN CLASSES
PRICE ACCORDINGLY TO OTHER DESIGNATED PRICING PARAMETERS
Cabin Preferences.
A data type for Cabin Preferences.
A data type for Fare Preferences.
Fare Type(s) with preference level.
Fare type. Examples: 70J-Published Fares, 749-Negotiated Fares, 756-One Way Fare,
758-Private Fares
Encoding Scheme: PADIS codeset element 9910 - Fare Qualifier
A code that gives information regarding the type of fare, class entitlement, minimum and maximum validity, reservations entitlement, seasonality, days of travel and advertising or sales restrictions.
Fare Basis Code with optional application.
Example: Y26
Used in conjunction with Application (Requested, Ticketed, Other)
The applicable code as provided for in A4A SIPP Resolution 110.16 or IATA Resolution 728. Further ticket
designators will be reported at the Fare Component level as matched from a Ticket Discount, ATPCO
Category 35, Category 25 or Category 19-22.
Ticket designator detail.
Contains indicators allowing for different restricted fare types to be be excluded.
When TRUE, do not return fares with minimum stay restrictions.
When TRUE, do not return fares with maximum stay restrictions.
When TRUE, do not return fares with advance purchase restrictions.
When TRUE, do not return fares with penalties.
Group Fare preferences by passenger type.
A data type for Flight Preferences.
Aircraft Features, including Equipment, Cabin Type, Class of Service, Seats, Rows and Tail Number. The IATA aircraft type; use SSIM Appendix A.
Aircraft Equipment.
Cabin Class.
Cabin type. Examples: First Class, Business Class
Encoding Scheme: PADIS codeset element 9873 - Cabin Class of Service
Desired Class(es) of Service.
Example: Y
Class of Service. Example: Y
Seat(s).
Seat characteristic value. Example: L (LEG SPACE SEAT). Refer to PADIS code list 9825.
Refers to position on the aircraft; seat option codes. Examples: E (EXIT ROW), M (Middle Seat), A (Aisle seat), L (Left side of aircraft), Q (Bulk Head). Refer to PADIS code list 9825.
Seat Row Number. Example: 3
Cabin Row Number(s) and Row Feature(s) to specify in preferences.
Row feature value. Example: E (EXIT ROW)
Encoding Scheme: IATA PADIS Code List for data element 9864
Preferred row number. Example: 10
Aircraft Features.
Aircraft Tail Number(s).
Flight Characteristics, e.g. non-stop, red eye, etc.
Non-Stop Flight preference level. Examples: Preferred, Exclude
Preference Level Context. Example: MyContext
Shopping preference for unticketed stop flight preference
Preference Level Context. Example: MyContext
Flights with overnight lodging preference.
Preference Level Context. Example: MyContext
Flights with change of airport preference.
Preference Level Context. Example: MyContext
Red eye flight preference.
Preference Level Context. Example: MyContext
Wait Listing.
Wait-Listing Shopping preference level.
Preference Level Context. Example: MyContext
FLIGHT Preferences, including Aircraft, Flight Characteristics, Connections and Wait Listing.
FARE Preferences, including Fare Type, Fare Basis Code, Ticket Designator and Fare Exclusions.
A data type for Maximum Flight Segment Travel Time.
Maximum Flight Segment Time Preference.
Travel time (unit) Value.
Example: 45, 45 (Minutes)
Travel time unit of measure. Example: Minutes, Hours, Days
A data type for Shopping Request Business Object: GROUP FARE Preferences.
Group Fare Preference detail.
Fare basis detail for fare selection at flight and O/D levels.
Passenger Type Code. Example: ADT
Encoding Scheme: IATA (three character) Passenger Type Code (PTC)
Shopping Preference(s), including Airline Supplier, Alliance Program, Fare, Flight and Transfer/ Connection Points.
Contains Shopping Preference choices, ie allowing to specify Airline, Alliance, Flight, Transfer and other shopping preferences.
Contains information to identify how reservation was re-priced to obtain best published fare (Eg. best fare in same cabin, best fare in all cabins, other parameters to select best fare).
Contains information to identify how reservation was re-priced to obtain best published fare (Eg. best fare in same cabin, best fare in all cabins, other parameters to select best fare).
Total Journey TRAVEL TIME preference.
Note: Based on sum of all flight times plus ground times in connecting airports.
Total Journey TRAVEL DISTANCE preference.
A data type for Travel Distance Preference.
Travel Distance (unit) Value. Example: 20
Travel distance application.
Examples: TotalJourneyDistance, MaximumTravelDistance
Distance unit of measure. Example: Kilometers, Miles, Other
A data type for Travel Time Preference.
Travel Distance (unit) Value. Example: 20
Travel time application.
Examples: TotalJourneyTime, MaximumTravelTime
Travel time unit of measure. Example: Minutes, Hours, days
TRANSFER/ CONNECTION POINT Preferences.
Maximum travel time preference for this flight segment. Example: 3 Hours
Service Pricing Only Preference.
When TRUE, Service Pricing Only is requested.
A data type for Airline Transfer/ Connection Preferences.
Connection(s).
Airport Code(s) optional preference level.
Airport Code. Example: TPA
Encoding Scheme: IATA/ A4A Aiport or City Code
Maximum number of connections. Example: 2
Maximum connection time preference. Example: PT360M
Minimum connection time preference. Example: PT90M
Flight connection preference - online/ interline
Example: 0 (Online)
Encoding Scheme: IATA PADIS Code List for data element 9885 - Online/ Interline Indicator
Contains indicator of when Connection Pricing should be applied. When true, Connection Pricing should be applied.
When TRUE, apply selected CONNECTION PRICING.
Standard way to indicate successful processing of an IATA message. Returning an empty element of this type indicates success.
A collection of warning information.
Used in conjunction with the Success element to define a business error.
Standard way to indicate successful processing of an IATA message, but one in which warnings are generated
The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown".
Used to specify tax information for a coupon.
The ticket/document number to which the tax coupon data applies.
The applicable coupon number.
The tax information for a coupon.
The sold cabin of passenger travel for the coupon.
The standard code of the equipment used for the coupon flight.
The tax/fee charge for this coupon.
The airport code identifying the airort to which the coupon tax applies.
The tax amount aplicable to the coupon as published in the IATA TTBS or other applicable filing mechanism.
The ISO currency code representing the currency code in which the coupon tax applicable amount was published or filed in. Use ISO 4217, three alpha code.
The tax amaount applicable to a coupon expressed in the currency of payment.
The origin airport code identifyng multiple segment taxes.
The destination airport code identifying multiple segment taxes.
The airport or city code identifying an unticketed point which occurs between the coupon origin and destination. Unticketed point refers to a physical location at which the passenger makes a (potentially taxable) arrival and departure which does not appear in the good for Passage Area of the ticket. Used for the application of coupon level taxes.
The airport or city code identifying an unticketed point which occurs between the coupon origin and destination.
The date and time of arrival in GMT at the unticketed point.
The date and time of depature in GMT from the unticketed point.
The standard code of the quipment used for the coupon flight departing from the unticketed point.
The coupon number.
The ticket/document number for this transaction.
The date of issue of the document.
The date of birth of the passenger.
The airport/city code which has been assumed to be the journey turnaround point in the construction of the itinerary by the pricing system.
Used for strings, length 1 to 8.
Used for strings, length 1 to 16.
Used for strings, length 1 to 5.
Use for numeric values, from 1 to 4 inclusive.
The reissued flown flight coupon information.
Departure, date, time, arrival, RPH, flight number information.
An intermediate airport/city code stop.
Airport city code.
When true, a stopover is permitted.
Used to indiccate when a transaction occurred due to a diversion en route. Refer to IATA PADIS Code List for data element 1245.
Coupon number.
The number representing the order in which this coupon was used or is to be used.
The applicable fare basis code.
Document number comprised of the airline code, form code, and serial number.
The date the ticket was issued.
A validating carrier assigned code allowing a fare rule modification or override applied to a flown coupon from the ticket being reissued.
The applicable code as provided for in ATA SIPP Reso 110.16 or IATA Reso 728, for each flown coupon from the ticket being reissued.
Used for Alpha-Numeric Strings, length 1 to 19
The IATA_PayloadStdAttributes defines the standard attributes that appear on the root element for all IATA payloads.
A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.
Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock (e.g. 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).
Used to indicate whether the request is for the Test or Production system.
For all IATA versioned messages, the version of the message is indicated by a decimal value.
A unique identifier to relate all messages within a transaction (e.g. this would be sent in all request and response messages that are part of an on-going transaction).
Used to identify the sequence number of the transaction as assigned by the sending system; allows for an application to process messages in a certain order or to request a resynchronization of messages in the event that a system has been off-line and needs to retrieve messages that were missed.
This indicates where this message falls within a sequence of messages.
This is the first message within a transaction.
This is the last message within a transaction.
This indicates that all messages within the current transaction must be ignored.
This is any message that is not the first or last message within a transaction.
Specifies that this is a followup request asking for more of what was requested in the previous request.
This request message is a subsequent request based on the previous message sent in this transaction.
When true, indicates the message is being re-sent after a failure. It is recommended that this attribute is used (i.e., set to TRUE) only when a message is retransmitted.
Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
When true, indicates that the client can accept asynchronous processing.
Used for strings, length 1 to 128.
Identifes the primary language preference for the message.
Identifes the primary language preference for the message. The human language is identified by ISO 639 codes.
Identifies the alternate language for a customer or message. The human language is identified by ISO 639 codes.
Identifies the alternate language for a customer or message. The human language is identified by ISO 639 codes.
Geographic Specification information
A code indicating the type of geographic specification that will be found in the following fields. Blank or A = Area S = State SA = Sub Area C = City N = Country CO = Coordinates
A one IATA numeric area designator. Example : 1 = Western Hemisphere 2 = Europe, Africa, and the Near East 3 = Far East, Australia, and Pacific
Standard ISO/IATA sub area code
Coordinates (Latitude, Longitude, as defined in the Data Dictionary)
Radius (in miles) to use in conjunction with coordinates above
Non Geographic Specification information
A code Indicating the type of CODE data to be found in the following fields: T = Pseudo Code/Travel Agency Code I = IATA Travel Agency No. H = Home IATA Agency No. U = Home Travel Agency Code X = Department/Identifier V = CRS/CXR Department Code L = LNIATA Number (CRT Address) Blank = No application
Up to a six character code for a pseudo
code/Travel Agency (left justified) followed by spaces.
An eight digit IATA assigned travel agency code.
Up to a seven digit code indicating the airline department or CRS agency/department (right justified) with leading zeros. Space in packed byte 32 or unpacked byte 41.
Up to a six character code indicating the airline department or CRS agency/department (left justified) followed by spaces.
Up to an eight character assigned complete line address (left justified) followed by spaces
Offer Geographic Specification information
1 = From LOC 1 to LOC 2 2 = To LOC 1 from LOC 2 3 = Originating from LOC 1 to LOC 2 4 = Originating from LOC 2 to LOC 1 "Blank = No application"
Identifies the Offer Origin Point.
Identifies the Offer Destination Point.
Specifies that all travel on the itinerary must be wholly within the specified location.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy