OrderCreateRQ NDC 2017.2

OrderCreateRQ

XPath: /OrderCreateRQ

Data Type Value: OrderCreateRQ

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

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

EchoToken

XPath: /OrderCreateRQ/@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.

TimeStamp

XPath: /OrderCreateRQ/@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).

Target

XPath: /OrderCreateRQ/@Target

Data Type Value: Target

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

Version

XPath: /OrderCreateRQ/@Version

Data Type Value: string

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

TransactionIdentifier

XPath: /OrderCreateRQ/@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).

SequenceNmbr

XPath: /OrderCreateRQ/@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 in the event that a system has been off-line and needs to retrieve messages that were missed.

TransactionStatusCode

XPath: /OrderCreateRQ/@TransactionStatusCode

Data Type Value: TransactionStatusCode

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

PrimaryLangID

XPath: /OrderCreateRQ/@PrimaryLangID

Data Type Value: language

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

AltLangID

XPath: /OrderCreateRQ/@AltLangID

Data Type Value: language

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

RetransmissionIndicator

XPath: /OrderCreateRQ/@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.

CorrelationID

XPath: /OrderCreateRQ/@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.

Document

id

XPath: /OrderCreateRQ/Document/@id

Data Type Value: ID

Description: A globally unique identifier for this object instance.

Party

IATA_Number

XPath: /OrderCreateRQ/Party/Sender/TravelAgencySender/IATA_Number

Data Type Value: IATA_NbrSimpleType

Description: Agency Seller IATA number. Example: 98417900.

Query

OfferID

XPath: /OrderCreateRQ/Query/Order/Offer/@OfferID

Data Type Value: [1..1] xsd:ID

Description: Reference to the OfferID of the selected Offer (either a standard Offer or an a-la-carte Offer) returned in a previous shopping response.

Owner

XPath: /OrderCreateRQ/Query/Order/Offer/@Owner

Data Type Value: string

Description: Designator of Airline that owns/ assigned these IDs. Examples: BA. Encoding Scheme: IATA/ A4A (two or three character) Airline Designator Code.

ResponseID

XPath: /OrderCreateRQ/Query/Order/Offer/@ResponseID

Data Type Value: string

Description: Reference to unique shopping session response ID, as provided in the airline's previous shopping response.

OfferItemID

XPath: /OrderCreateRQ/Query/Order/Offer/OfferItem/@OfferItemID

Data Type Value: xsd:string [1..1]

Description: Reference to the OfferItemID of the selected OfferItem (contained in either a standard Offer or an a-la-carte Offer) returned in a previous shopping response.

PassengerRefs

XPath: /OrderCreateRQ/Query/Order/Offer/OfferItem/PassengerRefs

Data Type Value: IDREFS

Description: Reference to passenger(s) for which this OfferItem and selected Services (in case of Service Bundles) applies.

ServiceID

XPath: /OrderCreateRQ/Query/Order/Offer/OfferItem/ServiceSelection/@ServiceID

Data Type Value: string

Description: Reference to the Service (within the OfferItem) from which the bundling begins.

ServiceDefinitionID

XPath: /OrderCreateRQ/Query/Order/Offer/OfferItem/ServiceSelection/ServiceDefinitionID

Data Type Value: string

Description: Id to define a selected ServiceDefinition from the selected bundle.

Payments

XPath: /OrderCreateRQ/Query/Payments

Data Type Value: Payments

Description: Payment information.

Payment

XPath: /OrderCreateRQ/Query/Payments/Payment

Data Type Value: Payment[]

Description: Payment detail, including association(s).

PassengerList

XPath: /OrderCreateRQ/Query/DataLists/PassengerList

Data Type Value: PassengerList

Description: Passenger data list definition.

Passenger

XPath: /OrderCreateRQ/Query/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.

PassengerID

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/@PassengerID

Data Type Value: ID

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

Birthdate

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/Birthdate

Data Type Value: extension of xs:date [0..1]

Description: Traveler birth date. Example: YYYY-MM-DD.

PTC

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/PTC

Data Type Value: extension of PaxSimpleType [0..1]

Description: Type code applying to the Passenger which typically drives pricing (e.g., ADT, CHD, etc.). A code is a character string of letters. It represents the type a passenger like ADT(Adult).

InfantRef

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/InfantRef

Data Type Value: xsd:IDREF [0..1]

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

Individual

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/Individual

Data Type Value: IndividualType

Description: A single human being as distinct from a group, class, or family.

Gender

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/Individual/Gender

Data Type Value: GenderCodeType [0..1]

Description: Passenger Gender Male

GivenName

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/Individual/GivenName

Data Type Value: extension of ProperNameSimpleType [0..5]

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

Surname

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/Individual/Surname

Data Type Value: extension of ProperNameSimpleType [1..1]

Description: Family name, last name Example: SMITH

SurNameSuffix

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/Individual/SurnameSuffix

Data Type Value: ShortNameType

Description: Individual's surname suffixes and letters. Examples: Jr., Sr., III, Ret., Esq.

MiddleName

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/Individual/MiddleName

Data Type Value: ProperNameType[]

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

NameTitle

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/Individual/NameTitle

Data Type Value: ShortNameType

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

Birthdate

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/Individual/Birthdate

Data Type Value: DateType

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

Phone

XPath: /OrderCreateRQ/Query/DataLists/ContactList/ContactInformation/ContactProvided/Phone

Data Type Value: PhoneTypeAIDM[]

Description: A telephone number is a sequence of digits assigned to a fixed-line telephone subscriber station connected to a telephone line or to a wireless electronic telephony device, such as a radio telephone or a mobile telephone, or to other devices for data transmission via the public switched telephone network (PSTN) or other private networks.

Label

XPath: /OrderCreateRQ/Query/DataLists/ContactList/ContactInformation/ContactProvided/Phone/Label

Data Type Value: SimpleTextType [1..Unbounded]

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

Extension

XPath: /OrderCreateRQ/Query/DataLists/ContactList/ContactInformation/ContactProvided/Phone/Extension

Data Type Value: NumberType [0..1]

Description: Phone extension number. Example: 1234.A mathematical number that is assigned or is determined by calculation.

PhoneNumber

XPath: /OrderCreateRQ/Query/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.

CountryDialingCode

XPath: /OrderCreateRQ/Query/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).

AreaCode

XPath: /OrderCreateRQ/Query/DataLists/ContactList/ContactInformation/ContactProvided/Phone/AreaCode

Data Type Value: NumberType

Description: Phone number area code. Example: 813.

EmailAddressValue

XPath: /OrderCreateRQ/Query/DataLists/ContactList/ContactInformation/ContactProvided/EmailAddress/EmailAddressValue

Data Type Value: SimpleTextType [1..1]

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

Label

XPath: /OrderCreateRQ/Query/DataLists/ContactList/ContactInformation/ContactProvided/EmailAddress/Label

Data Type Value: SimpleTextType

Description: Used to differentiate multiple email addresses of one contact.

CountrySubdivisionName

XPath: /OrderCreateRQ/Query/DataLists/ContactList/ContactInformation/PostalAddress/CountrySubdivisionName

Data Type Value: ProperNameType

Description: The name, expressed as text, of the subdivision of a country.

CountryCode

XPath: /OrderCreateRQ/Query/DataLists/ContactList/ContactInformation/PostalAddress/CountryCode

Data Type Value: ISO_3166CountryCodeContentType

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

CityName

XPath: /OrderCreateRQ/Query/DataLists/ContactList/ContactInformation/PostalAddress/CityName

Data Type Value: SimpleNameType

Description: The name, expressed as text, of the city, town or village.

Street

XPath: /OrderCreateRQ/Query/DataLists/ContactList/ContactInformation/PostalAddress/Street

Data Type Value: SimpleTextType[]

Description: Street name and number corresponding to the postal address. Examples: Main Street, 100 Main Street

ExpiryDate

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/IdentityDocument/ExpiryDate

Data Type Value: DateType

Description: The date the identity document expires.

Birthdate

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/IdentityDocument/Birthdate

Data Type Value: xsd:date [0..1]

Description: The Date of Birth of the Passenger. Anonymous Shopping requests or when the birthdate (in Individual) is not known.

Gender

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/IdentityDocument/Gender

Data Type Value: GenderCodeType [0..1]

Description: Passenger Gender Male

Surname

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/IdentityDocument/Surname

Data Type Value: xsd:string

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

SurnameSuffix

XPath: /OrderCreateRQ/Query/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.

NameTitle

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/IdentityDocument/NameTitle

Data Type Value: ProperNameType

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

GivenName

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/IdentityDocument/GivenName

Data Type Value: extension of ProperNameSimpleType [0..5]

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

MiddleName

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/IdentityDocument/MiddleName

Data Type Value: ProperNameType[]

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

IdentityDocumentNumber

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/IdentityDocument/IdentityDocumentNumber

Data Type Value: SimpleCodeType[1..1]

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

IssuingCountryCode

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/IdentityDocument/IssuingCountryCode

Data Type Value: ISO_3166CountryCodeContentType

Description: Issuing country code of the identity document.

CitizenshipCountryCode

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/IdentityDocument/CitizenshipCountryCode

Data Type Value: ISO_3166CountryCodeContentType

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

IssueDate

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/IdentityDocument/IssueDate

Data Type Value: DateType

Description: The date the identity document was issued.

IdentityDocumentType

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/IdentityDocument/IdentityDocumentType

Data Type Value: IdentityDocumentTypeCodeType

Description: The type of passenger document. Example: Passport.

LoyaltyProgramAccount

XPath: /OrderCreateRQ/Query/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.

ProgramCode

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/LoyaltyProgramAccount/ProgramCode

Data Type Value: SimpleCodeType

Description: Loyalty Program ID: Example: MAM.

TierCode

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/LoyaltyProgramAccount/TierCode

Data Type Value: SimpleCodeType

Description: Loyalty Program tier code.

AccountNumber

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/LoyaltyProgramAccount/AccountNumber

Data Type Value: SimpleCodeType [0..1] xsd:string

Description: Loyalty Program account number. Example: ABC123456.

AirlineDesignator

XPath: /OrderCreateRQ/Query/DataLists/PassengerList/Passenger/LoyaltyProgramAccount/Airline/AirlineDesignator

Data Type Value: AirlineDesignatorCodeType [0..1]

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.

FareList

XPath: /OrderCreateRQ/Query/DataLists/FareList

Data Type Value: FareList

Description: Element combining Fare Basis Code and Fare Details.

FareGroup

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup

Data Type Value: FareGroup[]

Description:

ListKey

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/@ListKey

Data Type Value: ID

Description: Globally unique id for this Data List instance.

SimpleCurrencyPrice

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/TotalAmount/SimpleCurrencyPrice

Data Type Value: SimpleCurrencyPriceType

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

Code

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/TotalAmount/SimpleCurrencyPrice/@Code

Data Type Value: CurrencySimpleType

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

Total

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/TotalAmount/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.

Code

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/TotalAmount/DetailCurrencyPrice/Total/@Code

Data Type Value: CurrencySimpleType

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

BaseAmount

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/BaseAmount

Data Type Value: CurrencyAmountOptType

Description: Total Base Fare Amount. Example: 200000.

Note: This includes surcharges (if applicable).

Code

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/BaseAmount/@Code

Data Type Value: CurrencySimpleType

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

BaseAmount

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/FareFiledIn/BaseAmount

Data Type Value: CurrencyAmountOptType

Description: Filed fare amount. Example: 2385 USD.

Note: This contains the originally filed base fare amount.

Code

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/FareFiledIn/BaseAmount/@Code

Data Type Value: CurrencySimpleType

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

Total

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/Surcharges/Surcharge/Total

Data Type Value: Total

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

Code

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/Surcharges/Surcharge/Total/@Code

Data Type Value: CurrencySimpleType

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

Amount

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/Surcharges/Surcharge/Breakdown/Fee/Amount

Data Type Value: CurrencyAmountOptType

Description: Fee Amount. Example: 500 USD.

Code

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/Surcharges/Surcharge/Breakdown/Fee/Amount/@Code

Data Type Value: CurrencySimpleType

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

Designator

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/Surcharges/Surcharge/Breakdown/Fee/Designator

Data Type Value: CodesetValueSimpleType

Description: Fee designator. Example: USC.

Total

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/Taxes/Total

Data Type Value: Total

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

Code

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/Taxes/Total/@Code

Data Type Value: CurrencySimpleType

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

Amount

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/Taxes/Breakdown/Tax/Amount

Data Type Value: CurrencyAmountOptType

Description: Amount. Example: 15000 USD.

Code

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/Taxes/Breakdown/Tax/Amount/@Code

Data Type Value: CurrencySimpleType

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

TaxCode

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/Taxes/Breakdown/Tax/TaxCode

Data Type Value: string

Description: Tax Code. Example: AY, GB

TaxType

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/Price/Taxes/Breakdown/Tax/TaxType

Data Type Value: string

Description: Tax type. Used to specify where the tax was applied. May be nice to have for auditing purposes. Example: 001, 002.

PriceClassRef

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/FareComponent/PriceClassRef

Data Type Value: IDREF

Description:

SegmentRefs

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/FareComponent/SegmentRefs

Data Type Value: SegmentRefs

Description:

TourCode

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareDetail/TourCode

Data Type Value: TourCode

Description: Tour Code. Example: ITGF12.

FareCode

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/Fare/FareCode

Data Type Value: IATA_CodeType

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

Code

XPath: /OrderCreateRQ/Query/DataLists/FareList/FareGroup/FareBasisCode/Code

Data Type Value: CodesetValueSimpleType

Description: Fare basis code. Example: Y26

FlightSegment

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment

Data Type Value: ListOfFlightSegmentType[]

Description: Flight origin/destination information.

SegmentKey

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment/@SegmentKey

Data Type Value: KeyIdentifier

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

refs

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment/@refs

Data Type Value: InstanceClassRefSimpleType

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

AirportCode

XPath: /OrderCreateRQ/Query/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.

Date

XPath: /OrderCreateRQ/Query/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).

Time

XPath: /OrderCreateRQ/Query/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).

AirportCode

XPath: /OrderCreateRQ/Query/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.

Date

XPath: /OrderCreateRQ/Query/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).

Time

XPath: /OrderCreateRQ/Query/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).

Name

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment/Arrival/Terminal/Name

Data Type Value: ProperNameSimpleType

Description: Terminal name or ID. Example: Terminal C.

AirlineID

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/AirlineID

Data Type Value: AirlineID

Description: A two-character alphanumeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory.

Name

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/Name

Data Type Value: CarrierNameType

Description: Airline Name. Example: British Airways.

FlightNumber

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/FlightNumber

Data Type Value: FlightNumber

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

ResBookDesigCode

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/ResBookDesigCode

Data Type Value: ResBookDesigCode

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

AirlineID

XPath: /OrderCreateRQ/Query/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.

Name

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/Name

Data Type Value: CarrierNameType

Description: Airline Name. Example: British Airways

FlightNumber

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/FlightNumber

Data Type Value: FlightNumber

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

OperationalSuffix

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/FlightNumber/@OperationalSuffix

Data Type Value: OperationalSuffix

Description: Flight Operational Suffix

Text

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/Disclosures/Description/Text

Data Type Value: Text

Description: Description value.

Equipment

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment/Equipment

Data Type Value: AircraftSummaryType

Description: AIRCRAFT SUMMARY representation.

AircraftCode

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment/Equipment/AircraftCode

Data Type Value: AircraftCode

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

refs

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment/ClassOfService/@refs

Data Type Value: InstanceClassRefSimpleType

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

Code

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment/ClassOfService/Code

Data Type Value: Code

Description: Class of Service Code. Example: B.

SecureFlight

XPath: /OrderCreateRQ/Query/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".

Value

XPath: /OrderCreateRQ/Query/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.

StopQuality

XPath: /OrderCreateRQ/Query/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopQuantity

Data Type Value: integer

Description: Stop Quantity. Example: 1.

Name

XPath: /OrderCreateRQ/Query/DataLists/PriceClassList/PriceClass/Name

Data Type Value: ProperNameSimpleType

Description: Price class name. Example: SUPERSAVER.

PriceClassID

XPath: /OrderCreateRQ/Query/DataLists/PriceClassList/PriceClass/@PriceClassID

Data Type Value: ID

Description: Object globally unique Instance ID. Example: obj1.

Owner

XPath: /OrderCreateRQ/Query/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.

ServiceDefinitionID

XPath: /OrderCreateRQ/Query/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".

Name

XPath: /OrderCreateRQ/Query/DataLists/ServiceDefinitionList/ServiceDefinition/Name

Data Type Value: Name

Description: Service name. Example: Lounge Pass.

Code

XPath: /OrderCreateRQ/Query/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).

refs

XPath: /OrderCreateRQ/Query/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).

PaymentCard

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/PaymentCard

Data Type Value: PaymentCardType

Description: PAYMENT CARD definition.

Street

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/PaymentCard/CardHolderBillingAddress/Street

Data Type Value: string[]

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

BuildingRoom

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/PaymentCard/CardHolderBillingAddress/BuildingRoom

Data Type Value: string

Description: Building name, room, apartment, or suite number.

CityName

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/PaymentCard/CardHolderBillingAddress/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).

CountryCode

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/PaymentCard/CardHolderBillingAddress/CountryCode

Data Type Value: CountryCode

Description: Country Code. Examples: US, FR

Encoding Scheme: ISO 3166-1 (two character) Country Code

PostalCode

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/PaymentCard/CardHolderBillingAddress/PostalCode

Data Type Value: PostalCode

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

StateProv

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/PaymentCard/CardHolderBillingAddress/StateProv

Data Type Value: string

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

CardCode

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/PaymentCard/CardCode

Data Type Value: PayCardCodeSimpleType

Description: Credit card issuer code. Example: MC

Note: This is the two-character code of the credit card issuer.

CardHolderName

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/PaymentCard/CardHolderName

Data Type Value: CardHolderName

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

CardHolderBillingAddress

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/PaymentCard/CardHolderBillingAddress

Data Type Value: CardHolderBillingAddress

Description: Cardholder Address.

CardNumber

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/PaymentCard/CardNumber

Data Type Value: CardNumber

Description: The Credit Card Number embossed on the card. Example: 1111222233334444

Effective

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/PaymentCard/EffectiveExpireDate/Effective

Data Type Value: PayCardDateSimpleType

Description: Payment Card Effective Date. Example: 0116.

Expiration

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/PaymentCard/EffectiveExpireDate/Expiration

Data Type Value: PayCardDateSimpleType

Description: Payment Card Expiration Date. Example: 0119

MiscChargeOrder

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/MiscChargeOrder

Data Type Value: MiscChargeOrder

Description: Miscellaneous Charge Order (MCO) information.

TicketNumber

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/MiscChargeOrder/TicketNumber

Data Type Value: ContextSimpleType

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

SeriesCode

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/PaymentCard/SeriesCode

Data Type Value: SeriesCode

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

Cash

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/Cash

Data Type Value: Cash

Description: Used to indicate payment in cash.

CashInd

XPath: /OrderCreateRQ/Query/Payments/Payment/Method/Cash/@CashInd

Data Type Value: boolean

Description: When true, payment is being made in cash.

Type

XPath: /OrderCreateRQ/Query/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.

Amount

XPath: /OrderCreateRQ/Query/Payments/Payment/Amount

Data Type Value: SimpleCurrencyPriceType

Description: The amount for this form of payment. Example: 300 USD

Code

XPath: /OrderCreateRQ/Query/Payments/Payment/Amount/@Code

Data Type Value: CurrencySimpleType

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