Last updated 8 minutes ago

OrderChange - OrderViewRS NDC 2017.2

OrderViewRS

OrderViewRS

XPath: /OrderViewRS

Data Type Value: OrderViewRS

Description: The OrderCreate/OrderView transaction is a multi-function message that may:

  1. Request specified inventory to be held (and returns a reference to the held inventory)
  2. Request that an order to be created (returning the complete view of the Order)
  3. Request additions to order data elements (e.g., add frequent flyer data)

Mandatory: WN

Optional:


EchoToken

XPath: /OrderViewRS/@EchoToken

Data Type Value: StringLength1to128

Description: 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.

Mandatory: WN

Optional:


TimeStamp

XPath: /OrderViewRS/@TimeStamp

Data Type Value: dateTime

Description: 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).

Mandatory: WN

Optional:


Target

XPath: /OrderViewRS/@Target

Data Type Value: Target

Description: Used to indicate whether the request is for the Test or Production system.

Mandatory: WN

Optional:


Version

XPath: /OrderViewRS/@Version

Data Type Value: string

Description: For all IATA versioned messages, the version of the message is indicated by a decimal value.

Mandatory: WN

Optional:


TransactionIdentifier

XPath: /OrderViewRS/@TransactionIdentifier

Data Type Value: StringLength1to32

Description: 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).

Mandatory: WN

Optional:


SequenceNmbr

XPath: /OrderViewRS/@SequenceNmbr

Data Type Value: nonNegativeInteger

Description: 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 if a system has been off-line and needs to retrieve messages that were missed.

Mandatory: WN

Optional:


TransactionStatusCode

XPath: /OrderViewRS/@TransactionStatusCode

Data Type Value: TransactionStatusCode

Description: This indicates where this message falls within a sequence of messages.

Mandatory: WN

Optional:


PrimaryLangID

XPath: /OrderViewRS/@PrimaryLangID

Data Type Value: language

Description: Identifes the primary language preference for the message. The human language is identified by ISO 639 codes.

Mandatory: WN

Optional:


AltLangID

XPath: /OrderViewRS/@AltLangID

Data Type Value: language

Description: Identifies the alternate language for a customer or message. The human language is identified by ISO 639 codes.

Mandatory: WN

Optional:


RetransmissionIndicator

XPath: /OrderViewRS/@RetransmissionIndicator

Data Type Value: boolean

Description: 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.

Mandatory: WN

Optional:


CorrelationID

XPath: /OrderViewRS/@CorrelationID

Data Type Value: StringLength1to64

Description: Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.

Mandatory: WN

Optional:

Document

id

XPath: /OrderViewRS/Document/@id

Data Type Value: ID

Description: A globally unique identifier for this object instance.

Mandatory: WN

Optional:


Name

XPath: /OrderViewRS/Document/Name

Data Type Value: ProperNameSimpleType

Description: NDC Implementation Name. Example: ThisAirline Gateway

Mandatory: WN

Optional:


ReferenceVersion

XPath: /OrderViewRS/Document/ReferenceVersion

Data Type Value: ContextSimpleType

Description: NDC Framework Version. Example: SOAP 2015.1

Mandatory: WN

Optional:

Success

Success

XPath: /OrderViewRS/Success

Data Type Value: SuccessType

Description: The presence of the empty Success element explicitly indicates that the message succeeded.

Mandatory: WN

Optional:

Warnings

Warnings

XPath: /OrderViewRS/Warnings

Data Type Value: WarningsType

Description: Used in conjunction with the Success element to define one or more business errors.

Mandatory: WN

Optional:


Warning

XPath: /OrderViewRS/Warnings/Warning

Data Type Value: WarningType[]

Description: Used in conjunction with the Success element to define a business error.

Mandatory: WN

Optional:


Language

XPath: /OrderViewRS/Warnings/Warning/@Language

Data Type Value: language

Description: Language identification.

Mandatory: WN

Optional:


Type

XPath: /OrderViewRS/Warnings/Warning/@Type

Data Type Value: IATA_CodeType

Description: 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".

Mandatory: WN

Optional:


ShortText

XPath: /OrderViewRS/Warnings/Warning/@ShortText

Data Type Value: StringLength1to255

Description: An error in textual format.

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Warnings/Warning/@Code

Data Type Value: IATA_CodeType

Description: 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.

Mandatory: WN

Optional:


DocURL

XPath: /OrderViewRS/Warnings/Warning/@DocURL

Data Type Value: anyURI

Description: If present, this URL refers to an online description of the error that occurred.

Mandatory: WN

Optional:


Status

XPath: /OrderViewRS/Warnings/Warning/@Status

Data Type Value: StringLength1to64

Description: 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.

Mandatory: WN

Optional:


Tag

XPath: /OrderViewRS/Warnings/Warning/@Tag

Data Type Value: string

Description: 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 if 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].

Mandatory: WN

Optional:


RecordID

XPath: /OrderViewRS/Warnings/Warning/@RecordID

Data Type Value: StringLength1to32

Description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records.

Mandatory: WN

Optional:


Owner

XPath: /OrderViewRS/Warnings/Warning/@Owner

Data Type Value: StringLength1to32

Description: Used to specify the owner of the error/warning codelist.

Mandatory: WN

Optional:

Response

PassengerList

XPath: /OrderViewRS/Response/DataLists/PassengerList

Data Type Value: PassengerList

Description: Passenger data list definition.

Mandatory: WN

Optional:


Passenger

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger

Data Type Value: PassengerType[]

Description: Any person except members of the crew carried or to be carried with the consent of the carrier, on board of any transport vehicle such as aircraft, train, bus, ship.

Mandatory: WN

Optional:


PassengerID

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/@PassengerID

Data Type Value: ID

Description: Uniquely identifies a Passenger within the context of one message.

Mandatory: WN

Optional:


PTC

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/PTC

Data Type Value: PassengerTypeCodeType

Description: Type code applying to the Passenger which typically drives pricing (e.g., ADT, CHD, etc).

Mandatory: WN

Optional:


InfantRef

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/InfantRef

Data Type Value: IDREF

Description: Reference to Passenger instance within the context of one message, associating an infant on lap to this adult passenger.

Mandatory: WN

Optional:


Birthdate

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/Individual/Birthdate

Data Type Value: DateType

Description: Individual's birth location (e.g., city and/or country).

Mandatory: WN

Optional:


Gender

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/Individual/Gender

Data Type Value: GenderCodeContentType

Description: Gender of the individual (M, F, or X for unspecified).

Mandatory: WN

Optional:


NameTitle

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/Individual/NameTitle

Data Type Value: ShortNameType

Description: Individual's name title. Examples: MR, MRS, DR.

Mandatory: WN

Optional:


GivenName

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/Individual/GivenName

Data Type Value: ProperNameType[]

Description: Individual's first or given name. Example: JOHN.

Mandatory: WN

Optional:


MiddleName

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/Individual/MiddleName

Data Type Value: ProperNameType[]

Description: Individual's middle name or initial. Examples: G, GEORGE

Mandatory: WN

Optional:


Surname

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/Individual/Surname

Data Type Value: ProperNameType

Description: Individual's family name, last name. Example: SMITH.

Mandatory: WN

Optional:


ProfileID

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/ProfileID

Data Type Value: SimpleTextType

Description: Passenger Profile ID

Mandatory: WN

Optional:


LoyaltyProgramAccount

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/LoyaltyProgramAccount

Data Type Value: LoyaltyProgramAccountType[]

Description: An account set up for a customer within a rewards program which holds funds on behalf of that customer.

Mandatory: WN

Optional:


AirlineName

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/LoyaltyProgramAccount/Airline/AirlineName

Data Type Value: ProperNameType

Description: Issuing Airline Name. Example: British Airways

Mandatory: WN

Optional:


AirlineDesignator

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/LoyaltyProgramAccount/Airline/AirlineDesignator

Data Type Value: AirlineDesignatorCodeType

Description: Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. Refer to IATA Airline Coding Directory, Section 3.

Mandatory: WN

Optional:


TierPriority

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/LoyaltyProgramAccount/TierPriority

Data Type Value: SimpleTextType

Description: Loyalty Program account priority within the tier (e.g., Platinum, executive, etc.)

Mandatory: WN

Optional:


AccountNumber

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/LoyaltyProgramAccount/AccountNumber

Data Type Value: SimpleCodeType

Description: Loyalty Program account number. Example: ABC123456

Mandatory: WN

Optional:


ProgramCode

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/LoyaltyProgramAccount/ProgramCode

Data Type Value: SimpleCodeType

Description: Loyalty Program ID: Example: MAM

Mandatory: WN

Optional:


IdentyDocument

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument

Data Type Value: IdentityDocumentType[]

Description: Any document which may be used to identify a person or verify aspects of a person's personal identity.

Mandatory: WN

Optional:


IdentityDocumentNumber

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/IdentityDocumentNumber

Data Type Value: SimpleCodeType

Description: Uniquely identifies the document from all other identity documents issued by the state or organization. e.g., passport number, drive license number.

Mandatory: WN

Optional:


IdentityDocumentType

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/IdentityDocumentType

Data Type Value: IdentityDocumentTypeCodeType

Description: The type of passenger document. Examples: PT (Passport)

Mandatory: WN

Optional:


Birthdate

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/Birthdate

Data Type Value: DateType

Description: Holder’s date of birth as written on the document.

Mandatory: WN

Optional:


Gender

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/Gender

Data Type Value: GenderCodeContentType

Description: Holder’s gender as specified on the document (M, F, or X for unspecified).

Mandatory: WN

Optional:


Surname

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/Surname

Data Type Value: ProperNameType

Description: Holder's family name, last name as written on the document. Example: SMITH.

Mandatory: WN

Optional:


SurnameSuffix

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/SurnameSuffix

Data Type Value: ShortNameType

Description: Holder's surname suffixes and letters as written on the document. Examples: Jr., Sr., III, Ret., Esq.

Mandatory: WN

Optional:


IssueDate

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/IssueDate

Data Type Value: DateType

Description: The date the identity document was issued.

Mandatory: WN

Optional:


ExpiryDate

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/ExpiryDate

Data Type Value: DateType

Description: The date the identity document expires.

Mandatory: WN

Optional:


IssuingCountryCode

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/IssuingCountryCode

Data Type Value: ISO_3166CountryCodeContentType

Description: Issuing country code of the identity document.

Mandatory: WN

Optional:


CitizenshipCountryCode

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/CitizenshipCountryCode

Data Type Value: ISO_3166CountryCodeContentType

Description: Citizenship Country Code. Examples: US, FR.

Mandatory: WN

Optional:


NameTitle

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/NameTitle

Data Type Value: ProperNameType

Description: Holder's name title as written on the document. Examples: MR, MRS, DR.

Mandatory: WN

Optional:


GivenName

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/GivenName

Data Type Value: ProperNameType[]

Description: Holder's first or given name, as written on the document. Example: JOHN.

Mandatory: WN

Optional:


MiddleName

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/MiddleName

Data Type Value: ProperNameType[]

Description: Holder's middle name or initial, as written on the document. Examples: G, GEORGE

Mandatory: WN

Optional:


ContractInfoRef

XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/ContactInfoRef

Data Type Value: IDREF

Description: Reference to Contact Information, within the context of one message.

Mandatory: WN

Optional:


ContactInformation

XPath: /OrderViewRS/Response/DataLists/ContactList/ContactInformation

Data Type Value: ContactInformationType[]

Description: The electronic or geographic address which a party has provided as the contact channel. For example, contact email, contact postal address, contact phone number.

Mandatory: WN

Optional:


ContactID

XPath: /OrderViewRS/Response/DataLists/ContactList/ContactInformation/@ContactID

Data Type Value: ID

Description: Uniquely Identifies a set of Contact Information, within the context of one message.

Mandatory: WN

Optional:


EmailAddressValue

XPath: /OrderViewRS/Response/DataLists/ContactList/ContactInformation/ContactProvided/EmailAddress/EmailAddressValue

Data Type Value: SimpleTextType

Description: The email address which should be used for contact purposes.

Mandatory: WN

Optional:


Label

XPath: /OrderViewRS/Response/DataLists/ContactList/ContactInformation/ContactProvided/Phone/Label

Data Type Value: SimpleTextType

Description: Used to differentiate multiple Phone numbers of one contact. Examples: Work, Home, Mobile

Mandatory: WN

Optional:


CountryDialingCode

XPath: /OrderViewRS/Response/DataLists/ContactList/ContactInformation/ContactProvided/Phone/CountryDialingCode

Data Type Value: CountryDialiingCodeType

Description: Numeric telephone dialing prefixes for the member countries of the International Telecommunication Union (ITU).

Mandatory: WN

Optional:


AreaCode

XPath: /OrderViewRS/Response/DataLists/ContactList/ContactInformation/ContactProvided/Phone/AreaCode

Data Type Value: NumberType

Description: Phone number area code. Example: 813

Mandatory: WN

Optional:


PhoneNumber

XPath: /OrderViewRS/Response/DataLists/ContactList/ContactInformation/ContactProvided/Phone/PhoneNumber

Data Type Value: NumberType

Description: Phone number text. Example: +1 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 the additional attributes to create a structured phone number.

Mandatory: WN

Optional:


OrderID

XPath: /OrderViewRS/Response/Order/@OrderID

Data Type Value: UniqueID_SimpleType

Description: The airline-assigned unique Order ID. Example: ORDER-c98c-4759-a20b

Mandatory: WN

Optional:


Owner

XPath: /OrderViewRS/Response/Order/@Owner

Data Type Value: AirlineDesigSimpleType

Description: Airline Designator of airline that owns/ assigned this ID. Example: BA Encoding Scheme: IATA/ A4A (two or three character) Airline Designator Codes

Mandatory: WN

Optional:


OwnerType

XPath: /OrderViewRS/Response/Order/@OwnerType

Data Type Value: OwnerType

Description: The POA OrderID should only go to the ORA, not back to the seller. \1. ORA \2. POA

Mandatory: WN

Optional:


BookingReference

XPath: /OrderViewRS/Response/Order/BookingReferences/BookingReference

Data Type Value: BookingReferenceType[]

Description: Booking Reference detail.

Mandatory: WN

Optional:


Type

XPath: /OrderViewRS/Response/Order/BookingReferences/BookingReference/Type

Data Type Value: IATA_CodeType

Description: Booking Reference Type. Example: 6 (Passenger confirmation number) Encoding Scheme: IATA Padis Codeset - List for data element [1153] Reference Qualifier

Mandatory: WN

Optional:


ID

XPath: /OrderViewRS/Response/Order/BookingReferences/BookingReference/ID

Data Type Value: ID

Description: Existing Booking Reference ID. Example: R1A3SK

Mandatory: WN

Optional:


AirlineID

XPath: /OrderViewRS/Response/Order/BookingReferences/BookingReference/AirlineID

Data Type Value: AirlineID

Description: 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.

Mandatory: WN

Optional:


Name

XPath: /OrderViewRS/Response/Order/BookingReferences/BookingReference/AirlineID/@Name

Data Type Value: ProperNameSimpleType

Description: Name. Example: British Airways

Mandatory: WN

Optional:


TotalOrderPrice

XPath: /OrderViewRS/Response/Order/TotalOrderPrice

Data Type Value: TotalOrderPrice

Description: Total Order Price. Example: 3400 USD Note: This is a sub-total of all associated Order Item prices.

Mandatory: WN

Optional:


DetailCurrencyPrice

XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice

Data Type Value: DetailCurrencyPriceType

Description: DETAIL CURRENCY PRICE BASIS UNIT: Price with tax and/ or fee break-down or totals.

Mandatory: WN

Optional:


Total

XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Total

Data Type Value: CurrencyAmountOptType

Description: Total price in currency. Example: 16000 USD Note: This is the total price INCLUDING base price, taxes and fees/ surcharges.

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Total/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code

Mandatory: WN

Optional:


SubTotal

XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Details/Detail/SubTotal

Data Type Value: CurrencyAmountOptType

Description: Price breakdown sub-total. Note: This is the total of all price breakdown items, excluding tax and/ or surcharge.

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Details/Detail/SubTotal/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code

Mandatory: WN

Optional:


Total

XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Taxes/Total

Data Type Value: Total

Description: Sub-total of all applicable taxes. Monetary value and currency code.

Mandatory: WN

Optional:


Amount

XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax/Amount

Data Type Value: CurrencyAmountOptType

Description: Amount. Example: 15000 USD

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax/Amount/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code

Mandatory: WN

Optional:


TaxCode

XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax/TaxCode

Data Type Value: string

Description: Tax Code. Example: AY, GB

Mandatory: WN

Optional:


Description

XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax/Description

Data Type Value: ShortDescSimpleType

Description: Tax short description. Example: $4 per flight segment, per passenger (U.S. domestic segment tax)

Mandatory: WN

Optional:


Total

XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Fees/Total

Data Type Value: Total

Description: Sub-total of all fees and charges. Monetary value and currency code.

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Fees/Total/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code

Mandatory: WN

Optional:


Amount

XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Fees/Breakdown/Fee/Amount

Data Type Value: CurrencyAmountOptType

Description: Fee Amount. Example: 500 USD

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Fees/Breakdown/Fee/Amount/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code

Mandatory: WN

Optional:


Designator

XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Fees/Breakdown/Fee/Designator

Data Type Value: CodesetValueSimpleType

Description: Fee designator. Example: USC

Mandatory: WN

Optional:


OrderItemID

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/@OrderItemID

Data Type Value: ID

Description: The airline-assigned unique Order Item ID. Example: ORD769-A850-4EC4-8F46-02293F72D7E6

Mandatory: WN

Optional:


BaseAmount

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/BaseAmount

Data Type Value: CurrencyAmountOptType

Description: Total Base Fare Amount. Example: 200000 Note: This includes surcharges (if applicable).

Mandatory:

Optional: WN


Code

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/BaseAmount/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code

Mandatory:

Optional: WN


SimpleCurrencyPrice

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/TotalAmount/SimpleCurrencyPrice

Data Type Value: SimpleCurrencyPriceType

Description: SIMPLE CURRENCY PRICE BASIS UNIT: NO price break-down, taxes and/or fees.

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/TotalAmount/SimpleCurrencyPrice/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code

Mandatory: WN

Optional:


BaseAmount

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/BaseAmount

Data Type Value: CurrencyAmountOptType

Description: Total Base Fare Amount. Example: 200000 Note: This includes surcharges (if applicable).

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/BaseAmount/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code

Mandatory: WN

Optional:


ServiceID

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/Service/@ServiceID

Data Type Value: ID

Description: ID for the Service contained this OrderItem. While the OrderItem would be a direct transference of the originating OfferItem, the Services within are broken down to a more granular level (i.e., a single deliverable unit of a specific service per passenger per flight segment). Therefore, the ServiceIDs in an Order do not reflect a 1-to-1 mapping to the originating Offer’s ServiceIDs.

Mandatory: WN

Optional:


PassengerRef

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/Service/PassengerRef

Data Type Value: IDREF

Description:  

Mandatory: WN

Optional:


ServiceDefinitionRef

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/Service/ServiceDefinitionRef

Data Type Value: ServiceDefinitionRef

Description:  

Mandatory: WN

Optional:


ServiceRef

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/Service/ServiceRef

Data Type Value: IDREF

Description: Create dependencies with parent services to which this particular ServiceItem is linked to (e.g., a meal to a flight). Can reference ServiceItems across different OfferItems within the same Offer.

Mandatory: WN

Optional:


SegmentRef

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/Service/SegmentRef

Data Type Value: IDREF

Description: Reference a segment being sold as part of this OrderItem/Service.

Mandatory: WN

Optional:


ServiceDefinition

XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition

Data Type Value: ServiceDefinitionType[]

Description: OPTIONAL SERVICE CORE definition.

Mandatory: WN

Optional:


Owner

XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/@Owner

Data Type Value: AirlineDesigSimpleType

Description: 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

Mandatory: WN

Optional:


ServiceDefinitionID

XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/@ServiceDefinitionID

Data Type Value: ID

Description: "A unique Service ID that has been returned in the Shopping results, and identifies an airline service item (i.e., a product or a service) that can be separately delivered and uniquely described by an airline. Example: SRVC-2B88-4C33-9787-9461114BC9BE"

Mandatory: WN

Optional:


Name

XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/Name

Data Type Value: Name

Description: Service name. Example: Lounge Pass

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/Encoding/Code

Data Type Value: Code

Description: 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).

Mandatory: WN

Optional:


SubCode

XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/Encoding/SubCode

Data Type Value: SubCode

Description: 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)

Mandatory: WN

Optional:


refs

XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/Encoding/@refs

Data Type Value: InstanceClassRefSimpleType

Description: Object association(s) between this object and any other object or metadata instance(s).

Mandatory: WN

Optional:


Text

XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/Descriptions/Description/Text

Data Type Value: Text

Description: Description value.

Mandatory: WN

Optional:


refs

XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/Descriptions/Description/@refs

Data Type Value: InstanceClassRefSimpleType

Description: Object association(s) between this object and any other object or metadata instance(s).

Mandatory: WN

Optional:


refs

XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/Descriptions/@refs

Data Type Value: InstanceClassRefSimpleType

Description: Object association(s) between this object and any other object or metadata instance(s).

Mandatory: WN

Optional:


SSRCode

XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/BookingInstructions/SSRCode

Data Type Value: string[]

Description: 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. Note: Although optional in the schema, some SSR codes may require associated description elements.

Mandatory: WN

Optional:


Timestamp

XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/TimeLimits/TicketingTimeLimits/@Timestamp

Data Type Value: dateTime

Description: Timestamp. Example: 2017-01-13T13:59:38Z

Mandatory: WN

Optional:


Text

XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition[2]/Descriptions/Description/Text

Data Type Value: SimpleCurrencyPriceType

Description: SIMPLE CURRENCY PRICE BASIS UNIT: NO price break-down, taxes and/or fees.

Mandatory: WN

Optional:


OrderItemID

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/@OrderItemID

Data Type Value: ID

Description: The airline-assigned unique Order Item ID. Example: ORD769-A850-4EC4-8F46-02293F72D7E6

Mandatory: WN

Optional:


SimpleCurrencyPrice

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/TotalAmount/SimpleCurrencyPrice

Data Type Value: SimpleCurrencyPriceType

Description: SIMPLE CURRENCY PRICE BASIS UNIT: NO price break-down, taxes and/or fees.

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/TotalAmount/SimpleCurrencyPrice/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code

Mandatory: WN

Optional:


BaseAmount

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/BaseAmount

Data Type Value: CurrencyAmountOptType

Description: Total Base Fare Amount. Example: 200000 Note: This includes surcharges (if applicable).

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/BaseAmount/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code

Mandatory: WN

Optional:


Total

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Taxes/Total

Data Type Value: Total

Description: Sub-total of all applicable taxes. Monetary value and currency code.

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Taxes/Total/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code

Mandatory: WN

Optional:


Amount

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Taxes/Breakdown/Tax/Amount

Data Type Value: CurrencyAmountOptType

Description: Amount. Example: 15000 USD

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Taxes/Breakdown/Tax/Amount/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code

Mandatory: WN

Optional:


TaxCode

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Taxes/Breakdown/Tax/TaxCode

Data Type Value: string

Description: Tax Code. Example: AY, GB

Mandatory: WN

Optional:


Description

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Taxes/Breakdown/Tax/Description

Data Type Value: ShortDescSimpleType

Description: Tax short description. Example: $4 per flight segment, per passenger (U.S. domestic segment tax)

Mandatory: WN

Optional:


Total

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Fees/Total

Data Type Value: Total

Description: Sub-total of all fees and charges. Monetary value and currency code.

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Fees/Total/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code

Mandatory: WN

Optional:


Amount

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Fees/Breakdown/Fee/Amount

Data Type Value: CurrencyAmountOptType

Description: Fee Amount. Example: 500 USD

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Fees/Breakdown/Fee/Amount/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code

Mandatory: WN

Optional:


Designator

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Fees/Breakdown/Fee/Designator

Data Type Value: CodesetValueSimpleType

Description: Fee designator. Example: USC

Mandatory: WN

Optional:


Service

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/Service

Data Type Value: Service[]

Description: The individual instance of a specific Service (as described in DataLists' ServiceDefinitions) or service bundle as it has been offered, and eventually ordered by a specific Passenger.

Mandatory: WN

Optional:


ServiceID

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/Service/@ServiceID

Data Type Value: ID

Description: ID for the Service contained this OrderItem. While the OrderItem would be a direct transference of the originating OfferItem, the Services within are broken down to a more granular level (i.e., a single deliverable unit of a specific service per passenger per flight segment). Therefore, the ServiceIDs in an Order do not reflect a 1-to-1 mapping to the originating Offer’s ServiceIDs.

Mandatory: WN

Optional:


PassengerRef

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/Service/PassengerRef

Data Type Value: IDREF

Description:  

Mandatory: WN

Optional:


SegmentRef

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/Service/SegmentRef

Data Type Value: IDREF

Description: Reference a segment being sold as part of this OrderItem/Service.

Mandatory: WN

Optional:


BaseAmount

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/Price/BaseAmount

Data Type Value: CurrencyAmountOptType

Description: Total Base Fare Amount. Example: 200000 Note: This includes surcharges (if applicable).

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/Price/BaseAmount/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareBasis/FareBasisCode/Code

Data Type Value: CodesetValueSimpleType

Description: Fare basis code. Example: Y26

Mandatory: WN

Optional:


refs

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareBasis/FareBasisCode/@refs

Data Type Value: InstanceClassRefSimpleType

Description: Object association(s) between this object and any other object or metadata instance(s).

Mandatory: WN

Optional:


RBD

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareBasis/RBD

Data Type Value: string

Description: Reservation Booking Designator or Booking Class (e.g., T)

Mandatory: WN

Optional:


FareBasisCityPair

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareBasis/FareBasisCityPair

Data Type Value: ContextSimpleType

Description: A data type for Context Value size constraint.

Mandatory: WN

Optional:


PriceClassRef

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/PriceClassRef

Data Type Value: IDREF

Description:  

Mandatory: WN

Optional:


CabinTypeCode

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareBasis/CabinType/CabinTypeCode

Data Type Value: CabinTypeCode

Description:  

Mandatory: WN

Optional:


CabinTypeName

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareBasis/CabinType/CabinTypeName

Data Type Value: CabinTypeName

Description:  

Mandatory: WN

Optional:


Timestamp

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareRules/Remarks/Remark/@Timestamp

Data Type Value: dateTime

Description: Remark creation timestamp. Example: 2017-01-13T13:59:38Z

Mandatory: WN

Optional:


Remark

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareRules/Remarks/Remark

Data Type Value: Remark[]

Description: Remark Text.

Mandatory: WN

Optional:


SegmentRefs

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/SegmentRefs

Data Type Value: SegmentRefs

Description:  

Mandatory: WN

Optional:


Timestamp

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/TimeLimits/PaymentTimeLimit/@Timestamp

Data Type Value: dateTime

Description: Timestamp. Example: 2017-01-13T13:59:38Z

Mandatory: WN

Optional:


Timestamp

XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/TimeLimits/TicketingTimeLimits/@Timestamp

Data Type Value: dateTime

Description: Timestamp. Example: 2017-01-13T13:59:38Z

Mandatory: WN

Optional:


Name

XPath: /OrderViewRS/Response/DataLists/PriceClassList/PriceClass/Name

Data Type Value: ProperNameSimpleType

Description: Price class name. Example: SUPERSAVER

Mandatory: WN

Optional:


Text

XPath: /OrderViewRS/Response/DataLists/PriceClassList/PriceClass/Descriptions/Description/Text

Data Type Value: Text

Description: Description value.

Mandatory: WN

Optional:


Payments

XPath: /OrderViewRS/Response/Order/Payments

Data Type Value: Payments

Description: Payment Processing information. Note: This payment information applies to the entire Order. Note that it may also be specified at the Order Item level.

Mandatory: WN

Optional:


Payment

XPath: /OrderViewRS/Response/Order/Payments/Payment

Data Type Value: PaymentProcessType[]

Description: Payment Processing detail.

Mandatory: WN

Optional:


ObjectKey

XPath: /OrderViewRS/Response/Order/Payments/Payment/Description/@ObjectKey

Data Type Value: ID

Description: Object globally unique Instance ID. Example: obj1

Mandatory: WN

Optional:


Type

XPath: /OrderViewRS/Response/Order/Payments/Payment/Type

Data Type Value: IATA_CodeType

Description: The form of payment type. Examples: Credit Card, Cash. Encoding Scheme: IATA PADIS code list data element [9888] Form of Payment Identification

Mandatory: WN

Optional:


StatusCode

XPath: /OrderViewRS/Response/Order/Payments/Payment/Status/StatusCode

Data Type Value: StatusCode

Description: Overall Order payment Status Code.

Mandatory: WN

Optional:


PaymentCardMethod

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod

Data Type Value: PaymentCardMethodType

Description: PAYMENT CARD Payment Method definition.

Mandatory: WN

Optional:


CardType

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/CardType

Data Type Value: PayCardTypeSimpleType

Description: Magnetic striped card type.

Mandatory: WN

Optional:


CardCode

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/CardCode

Data Type Value: PayCardCodeSimpleType

Description: Credit card issuer code. Example: MC Note: This is the two-character code of the credit card issuer.

Mandatory: WN

Optional:


MaskedCardNumber

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/MaskedCardNumber

Data Type Value: MaskedCardNumber

Description: Concealed credit card number, Example: xxxxxxxxxxxx9922

Mandatory: WN

Optional:


AddressContact

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/Contacts/Contact/AddressContact

Data Type Value: AddressContactType

Description: ADDRESS CONTACT definition.

Mandatory: WN

Optional:


Street

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/Contacts/Contact/AddressContact/Street

Data Type Value: string[]

Description: Street. Examples: Main Street, 100 Main Street

Mandatory: WN

Optional:


CityName

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/Contacts/Contact/AddressContact/CityName

Data Type Value: string

Description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).

Mandatory: WN

Optional:


StateProv

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/Contacts/Contact/AddressContact/StateProv

Data Type Value: string

Description: State or province code. Examples: NY, QUE

Mandatory: WN

Optional:


PostalCode

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/Contacts/Contact/AddressContact/PostalCode

Data Type Value: PostalCode

Description: Postal code. Examples: 11001, 11001-2345

Mandatory: WN

Optional:


CountryCode

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/Contacts/Contact/AddressContact/CountryCode

Data Type Value: CountryCode

Description: Country Code. Examples: US, FR Encoding Scheme: ISO 3166-1 (two character) Country Code

Mandatory: WN

Optional:


Application

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/Contacts/Contact/EmailContact/Application

Data Type Value: EmailAppSimpleType

Description: Email address application. Examples: Personal, Business, SMS

Mandatory: WN

Optional:


Address

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/Contacts/Contact/EmailContact/Address

Data Type Value: Address

Description: The traveler email address for contact.

Mandatory: WN

Optional:


CardHolderName

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/CardHolderName

Data Type Value: CardHolderName

Description: Name of credit card holder. Example: JOHN SMITH

Mandatory: WN

Optional:


CardIssuerName

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/CardIssuerName

Data Type Value: CardIssuerName

Description: Credit card issuing company.

Mandatory: WN

Optional:


BankID

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/CardIssuerName/BankID

Data Type Value: ProperNameSimpleType

Description: 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.).

Mandatory: WN

Optional:


Expiration

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/EffectiveExpireDate/Expiration

Data Type Value: PayCardDateSimpleType

Description: Payment Card Expiration Date. Example: 0119

Mandatory: WN

Optional:


SimpleCurrencyPrice

XPath: /OrderViewRS/Response/Order/Payments/Payment/Amount/SimpleCurrencyPrice

Data Type Value: SimpleCurrencyPriceType

Description: SIMPLE CURRENCY PRICE BASIS UNIT: NO price break-down, taxes and/or fees.

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/Order/Payments/Payment/Amount/SimpleCurrencyPrice/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD Encoding Scheme: ISO 4217 (three alpha character) Currency Code

Mandatory: WN

Optional:


Number

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/VoucherMethod/Number

Data Type Value: ShortDescSimpleType

Description: Voucher ID or Number. Example: XX12345

Mandatory: WN

Optional:


TicketNumber

XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/MiscChargeMethod/TicketNumber

Data Type Value: ContextSimpleType

Description: The ticket number of the miscellaneous charge order (MCO).

Mandatory: WN

Optional:


OrderID

XPath: /OrderViewRS/Response/Order/OrderKeys/OrderID

Data Type Value: OrderID_Type

Description: A data type for an Order ID. The airline-assigned unique Order ID. Example: ORDER-c98c-4759-a20b

Mandatory: WN

Optional:


Owner

XPath: /OrderViewRS/Response/Order/OrderKeys/OrderID/@Owner

Data Type Value: AirlineDesigSimpleType

Description: Airline Designator of airline that owns/ assigned this ID. Example: BA Encoding Scheme: IATA/ A4A (two or three character) Airline Designator Codes

Mandatory: WN

Optional:


OfferItemID

XPath: /OrderViewRS/Response/Order/OrderKeys/AssociatedIDs/AssociatedID/OfferItemID

Data Type Value: ItemID_Type

Description: A data type for an order or offer related ID. Example: ORDER-c98c-4759-a20b-01

Mandatory: WN

Optional:


Owner

XPath: /OrderViewRS/Response/Order/OrderKeys/AssociatedIDs/AssociatedID/OfferItemID/@Owner

Data Type Value:  

Description:  

Mandatory: WN

Optional:


refs

XPath: /OrderViewRS/Response/Order/OrderKeys/AssociatedIDs/AssociatedID/ServiceID/@refs

Data Type Value: InstanceClassRefSimpleType

Description: Object association(s) between this object and any other object or metadata instance(s).

Mandatory: WN

Optional:


ServiceID

XPath: /OrderViewRS/Response/Order/OrderKeys/AssociatedIDs/AssociatedID/ServiceID

Data Type Value: ServiceID_Type

Description: UNIQUE SERVICE ID representation. The airline-assigned unique Service ID. Example: SRVC_ccecc4aa-791867b9b2e6

Mandatory: WN

Optional:


Owner

XPath: /OrderViewRS/Response/Order/OrderKeys/AssociatedIDs/AssociatedID/ServiceID/@Owner

Data Type Value: AirlineDesigSimpleType

Description: 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

Mandatory: WN

Optional:


FlightSegment

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment

Data Type Value: ListOfFlightSegmentType[]

Description: Flight origin/ destination information.

Mandatory: WN

Optional:


SegmentKey

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/@SegmentKey

Data Type Value: KeyIdentifier

Description: A globally unique identifier for this Flight Segment instance. Example: segment1

Mandatory: WN

Optional:


FlightSegmentType

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/FlightSegmentType

Data Type Value: IATA_CodeType

Description: Used for codes in the IATA code tables. Possible values of this pattern are 1, 101, EQP

Mandatory: WN

Optional:


Departure

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Departure

Data Type Value: Departure

Description: Departure (origin) Airport, Date and Time information.

Mandatory: WN

Optional:


AirportCode

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Departure/AirportCode

Data Type Value: AirportCode

Description: 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

Mandatory: WN

Optional:


Date

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Departure/Date

Data Type Value: date

Description: Departure date. Example: 2017-01-13 Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)

Mandatory: WN

Optional:


Time

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Departure/Time

Data Type Value: TimeSimpleType

Description: Departure time. Example: 09:15 Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)

Mandatory: WN

Optional:


Name

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Departure/Terminal/Name

Data Type Value: ProperNameSimpleType

Description: Terminal name or ID. Example: Terminal C

Mandatory: WN

Optional:


Gate

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Departure/Terminal/Gate

Data Type Value: ContextSimpleType

Description: Terminal Gate Number. Example: C39

Mandatory: WN

Optional:


Arrival

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Arrival

Data Type Value: FlightArrivalType

Description: FLIGHT ARRIVAL definition.

Mandatory: WN

Optional:


AirportCode

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Arrival/AirportCode

Data Type Value: AirportCode

Description: 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

Mandatory: WN

Optional:


Date

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Arrival/Date

Data Type Value: date

Description: Arrival date. Example: 2017-01-14 Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)

Mandatory: WN

Optional:


Time

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Arrival/Time

Data Type Value: TimeSimpleType

Description: Arrival time. Example: 09:15 Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)

Mandatory: WN

Optional:


Name

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Arrival/Terminal/Name

Data Type Value: ProperNameSimpleType

Description: Terminal name or ID. Example: Terminal C

Mandatory: WN

Optional:


Gate

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Arrival/Terminal/Gate

Data Type Value: ContextSimpleType

Description: Terminal Gate Number. Example: C39

Mandatory: WN

Optional:


MarketingCarrier

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier

Data Type Value: MarketingCarrierFlightType

Description: Marketing Carrier information.

Mandatory: WN

Optional:


AirlineID

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/AirlineID

Data Type Value: AirlineID

Description: 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 .

Mandatory: WN

Optional:


Name

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/Name

Data Type Value: CarrierNameType

Description: Airline Name. Example: British Airways

Mandatory: WN

Optional:


FlightNumber

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/FlightNumber

Data Type Value: FlightNumber

Description: Flight Number. Example: 1234, or OPEN, or ARNK

Mandatory: WN

Optional:


ResBookDesigCode

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/ResBookDesigCode

Data Type Value: CodesetValueSimpleType

Description: The Reservation Booking Designator (booking class) of the Operating Carrier if different from the Marketing Carrier. Example: Y

Mandatory: WN

Optional:


OperatingCarrier

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier

Data Type Value: OperatingCarrier

Description: 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 marketed by other 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.

Mandatory: WN

Optional:


AirlineID

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/AirlineID

Data Type Value: AirlineID

Description: 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.

Mandatory: WN

Optional:


Name

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/Name

Data Type Value: CarrierNameType

Description: Airline Name. Example: British Airways

Mandatory: WN

Optional:


FlightNumber

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/FlightNumber

Data Type Value: FlightNumber

Description: Flight Number. Example: 1234, or OPEN, or ARNK

Mandatory: WN

Optional:


ResBookDesigCode

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/ResBookDesigCode

Data Type Value: CodesetValueSimpleType

Description: The Reservation Booking Designator (booking class) of the Operating Carrier if different from the Marketing Carrier. Example: Y

Mandatory: WN

Optional:


AirCraftCode

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Equipment/AircraftCode

Data Type Value: AircraftCode

Description: Equipment Code. Example: 737 Encoding Scheme: IATA/ A4A Equipment Code

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/ClassOfService/Code

Data Type Value: Code

Description: Class of Service Code. Example: B

Mandatory: WN

Optional:


SecureFlight

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/@SecureFlight

Data Type Value: boolean

Description: When true, the flight is secure flight. An indicator to disclose when a flight is a "secure flight"

Mandatory: WN

Optional:


Value

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/FlightDuration/Value

Data Type Value: duration

Description: 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.

Mandatory: WN

Optional:


StopQuantity

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopQuantity

Data Type Value: integer

Description: Stop Quantity. Example: 1

Mandatory: WN

Optional:


StopLocation

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopLocations/StopLocation

Data Type Value: StopLocation[]

Description: Stop Location detail.

Mandatory: WN

Optional:


AirportCode

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopLocations/StopLocation/AirportCode

Data Type Value: AirportCode

Description: 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

Mandatory: WN

Optional:


ArrivalDate

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopLocations/StopLocation/ArrivalDate

Data Type Value: date

Description: Stop Arrival date. Example: 2017-01-14 Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)

Mandatory: WN

Optional:


ArrivalTime

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopLocations/StopLocation/ArrivalTime

Data Type Value: TimeSimpleType

Description: Arrival time. Example: 09:15 Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)

Mandatory: WN

Optional:


DepartureDate

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopLocations/StopLocation/DepartureDate

Data Type Value: date

Description: Scheduled Departure Date. Example: 2017-01-13 Note: This is the date and time of departure in GMT from the unticketed point.

Mandatory: WN

Optional:


DepartureTime

XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopLocations/StopLocation/DepartureTime

Data Type Value: TimeSimpleType

Description: Departure time. Example: 09:15 Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)

Mandatory: WN

Optional:


ListKey

XPath: /OrderViewRS/Response/DataLists/InstructionsList/Instruction/@ListKey

Data Type Value: ID

Description: Globally unique id for this Data List instance.

Mandatory: WN

Optional:


Remark

XPath: /OrderViewRS/Response/DataLists/InstructionsList/Instruction/FreeFormTextInstruction/Remark

Data Type Value: Remark[]

Description: Remark Text.

Mandatory: WN

Optional:


TicketDocInfo

XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo

Data Type Value: TicketDocInfo[]

Description: Ticket/document information.

Mandatory: WN

Optional:


TicketDocNbr

XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/TicketDocNbr

Data Type Value: TicketDocNbr

Description: Coupon Document Number. Note: This is the document number comprised of the airline code, form code, and serial number.

Mandatory: WN

Optional:


Type

XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/Type

Data Type Value: IATA_CodeType

Description: Coupon Type. Example: Y (EMD-S Standalone) Encoding Scheme: IATA Padis Codeset - List for data element 1001 (Document/ Message Name, coded)

Mandatory: WN

Optional:


NumberofBooklets

XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/NumberofBooklets

Data Type Value: integer

Description: The number of booklets issued.

Mandatory: WN

Optional:


DateOfIssue

XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/DateOfIssue

Data Type Value: date

Description: Date of Issue. Example: 2017-01-13

Mandatory: WN

Optional:


Remark

XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/Remark

Data Type Value: string

Description: Free text to provide further information related to the document and/or the coupon.

Mandatory: WN

Optional:


ReportingType

XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/ReportingType

Data Type Value: ReportingType

Description: For billing and settlement purposes, each time a travel agent requests an airline to perform an action on a document (Issuance, Refund, Exchange), he needs to know how to reconciliate this action: via BSP, via ARC, directly done by the ORA, etc.

Mandatory: WN

Optional:


CouponNumber

XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CouponNumber

Data Type Value: integer

Description: Applicable coupon number. Example: 1234

Mandatory: WN

Optional:


Status

XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/Status

Data Type Value: IATA_CodeType

Description: Current status of the flight/value coupon. Example: E (Exchanged/reissued) Encoding Scheme: IATA Padis Codeset - List for data element 4405 (Status, coded)

Mandatory: WN

Optional:


PassengerReference

XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo/PassengerReference

Data Type Value: IDREFS

Description: Association to one or multiple Passenger instances. Example: pax1 pax2

Mandatory: WN

Optional:

Errors

Errors

XPath: /OrderViewRS/Errors

Data Type Value: ErrorsType

Description: A collection of errors that occurred during the processing of a message.

Mandatory: WN

Optional:


Error

XPath: /OrderViewRS/Errors/Error

Data Type Value: ErrorType[]

Description: Standard way to indicate that an error occurred during the processing of an IATA message

Mandatory: WN

Optional:


Language

XPath: /OrderViewRS/Errors/Error/@Language

Data Type Value: language

Description: Language identification.

Mandatory: WN

Optional:


Type

XPath: /OrderViewRS/Errors/Error/@Type

Data Type Value: IATA_CodeType

Description: 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".

Mandatory: WN

Optional:


ShortText

XPath: /OrderViewRS/Errors/Error/@ShortText

Data Type Value: StringLength1to255

Description: An error in textual format.

Mandatory: WN

Optional:


Code

XPath: /OrderViewRS/Errors/Error/@Code

Data Type Value: IATA_CodeType

Description: 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.

Mandatory: WN

Optional:


DocURL

XPath: /OrderViewRS/Errors/Error/@DocURL

Data Type Value: anyURI

Description: If present, this URL refers to an online description of the error that occurred.

Mandatory: WN

Optional:


Status

XPath: /OrderViewRS/Errors/Error/@Status

Data Type Value: StringLength1to64

Description: 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.

Mandatory: WN

Optional:


Tag

XPath: /OrderViewRS/Errors/Error/@Tag

Data Type Value: string

Description: 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 if 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].

Mandatory: WN

Optional:


RecordID

XPath: /OrderViewRS/Errors/Error/@RecordID

Data Type Value: StringLength1to32

Description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records.

Mandatory: WN

Optional:


Owner

XPath: /OrderViewRS/Errors/Error/@Owner

Data Type Value: StringLength1to32

Description: Used to specify the owner of the error/warning codelist.

Mandatory: WN

Optional:


NodeList

XPath: /OrderViewRS/Errors/Error/@NodeList

Data Type Value: string

Description: 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.

Mandatory: WN

Optional:

Metadata

refs

XPath: /OrderViewRS/Response/Metadata/Other/OtherMetadata/CurrencyMetadatas/CurrencyMetadata/@refs

Data Type Value: InstanceClassRefSimpleType

Description: Object association(s) between this object and any object instance(s).

Mandatory: WN

Optional:


MetadataKey

XPath: /OrderViewRS/Response/Metadata/Other/OtherMetadata/CurrencyMetadatas/CurrencyMetadata/@MetadataKey

Data Type Value: ID

Description: A globally unique identifier for this Metadata instance.

Mandatory: WN

Optional:


Decimals

XPath: /OrderViewRS/Response/Metadata/Other/OtherMetadata/CurrencyMetadatas/CurrencyMetadata/Decimals

Data Type Value: integer

Description: Number of decimal places. Example: 2. Note this is the number of decimal places normally used when displaying amounts in this currency

Mandatory: WN

Optional:

DataLists

OriginDestinationKey

XPath: /OrderViewRS/DataLists/OriginDestinationList/OriginDestination/@OriginDestinationKey

Data Type Value:  

Description:  

Mandatory: WN

Optional:


DepartureCode

XPath: /OrderViewRS/DataLists/OriginDestinationList/OriginDestination/DepartureCode

Data Type Value:  

Description:  

Mandatory: WN

Optional:


ArrivalCode

XPath: /OrderViewRS/DataLists/OriginDestinationList/OriginDestination/ArrivalCode

Data Type Value:  

Description:  

Mandatory: WN

Optional:


FlightReferences

XPath: /OrderViewRS/DataLists/OriginDestinationList/OriginDestination/FlightReferences

Data Type Value:  

Description:  

Mandatory: WN

Optional: