OrderReshopRS NDC 2017.2

OrderReshopRS

OrderReshopRS

XPath: /OrderReshopRS

Data Type Value: OrderReshopRS

Description: The OrderReshop transaction set passes new shopping requests to an airline to replace existing specified order or order items in an Order or for new shopping requests to add to an existing Order. Airline responds with product offers within the context of the existing Order. There is no change to the Order or Order Items, in response to a Reshop request - typically, the Reshop response will be followed by an OrderChangeRQ or OrderCancelRQ transaction, to commit the re-shop offer. In the response, the Airline can provide exact instructions as to what actions can finally be executed, as a solution to the initially requested action.


EchoToken

XPath: /OrderReshopRS/@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: /OrderReshopRS/@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: /OrderReshopRS/@Target

Data Type Value: Target

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


Version

XPath: /OrderReshopRS/@Version

Data Type Value: string

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


TransactionIdentifier

XPath: /OrderReshopRS/@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: /OrderReshopRS/@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: /OrderReshopRS/@TransactionStatusCode

Data Type Value: TransactionStatusCode

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


PrimaryLangID

XPath: /OrderReshopRS/@PrimaryLangID

Data Type Value: language

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


AltLangID

XPath: /OrderReshopRS/@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: /OrderReshopRS/@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: /OrderReshopRS/@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: /OrderReshopRS/Document/@id

Data Type Value: ID

Description: A globally unique identifier for this object instance.


Name

XPath: /OrderReshopRS/Document/Name

Data Type Value: ProperNameSimpleType

Description: NDC Implementation Name. Example: ThisAirline Gateway.


ReferenceVersion

XPath: /OrderReshopRS/Document/ReferenceVersion

Data Type Value: ContextSimpleType

Description: NDC Framework Version. Example: SOAP 2015.1.

Success

Success

XPath: /OrderReshopRS/Success

Data Type Value: SuccessType

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

Warnings

Warnings

XPath: /OrderReshopRS/Warnings

Data Type Value: WarningsType

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


Warning

XPath: /OrderReshopRS/Warnings/Warning

Data Type Value: WarningType[]

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


Code

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


DocURL

XPath: /OrderReshopRS/Warnings/Warning/@DocURL

Data Type Value: anyURI

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


ShortText

XPath: /OrderReshopRS/Warnings/Warning/@ShortText

Data Type Value: StringLength1to255

Description: An error in textual format.


Language

XPath: /OrderReshopRS/Warnings/Warning/@Language

Data Type Value: language

Description: Language identification.


Owner

XPath: /OrderReshopRS/Warnings/Warning/@Owner

Data Type Value: StringLength1to32

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


Status

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


Tag

XPath: /OrderReshopRS/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].


RecordID

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


Type

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

Errors

XPath: /OrderReshopRS/Errors

Data Type Value: ErrorsType

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


Errors

XPath: /OrderReshopRS/Errors/Error

Data Type Value: ErrorType[]

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


Language

XPath: /OrderReshopRS/Errors/Error/@Language

Data Type Value: language

Description: Language identification.


Type

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


Code

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


DocURL

XPath: /OrderReshopRS/Errors/Error/@DocURL

Data Type Value: anyURI

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


ShortText

XPath: /OrderReshopRS/Errors/Error/@ShortText

Data Type Value: StringLength1to255

Description: An error in textual format.


Owner

XPath: /OrderReshopRS/Errors/Error/@Owner

Data Type Value: StringLength1to32

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


Status

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


Tag

XPath: /OrderReshopRS/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].


RecordID

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


NodeList

XPath: /OrderReshopRS/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 constraint which contains the data of the node. This will provide the offending data back to systems that cannot maintain the original message.

Response

NoPriceChangeInd

XPath: /OrderReshopRS/Response/NoPriceChangeInd

Data Type Value: boolean

Description: When "true", the Reprice had no effect on the price(s) of the original Order/OrderItems.


ObjectKey

XPath: /OrderReshopRS/Response/ChangeFees/@ObjectKey

Data Type Value: ID

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


Remark

XPath: /OrderReshopRS/Response/ChangeFees/ApplicableFeeRemarks/Remark

Data Type Value: Remark[]

Description: Remark Text.


Type

XPath: /OrderReshopRS/Response/ChangeFees/Details/Detail/Type

Data Type Value: PenaltySimpleType

Description: Penalty Type. Examples: Cancellation, Change, NoShow, Upgrade, Other.


Application

XPath: /OrderReshopRS/Response/ChangeFees/Details/Detail/Application

Data Type Value: IATA_CodeType

Description: Penalty application type. Encoding scheme: IATA Padis Codeset FAT - Fare or Application Penalty Type.


Amounts

XPath: /OrderReshopRS/Response/ChangeFees/Details/Detail/Amounts

Data Type Value: Amounts

Description: Penalty Amount(s) with Penalty Amount Application and Remarks.


Amounts

XPath: /OrderReshopRS/Response/ChangeFees/Details/Detail/Amounts

Data Type Value: Amounts

Description: Penalty Amount(s) with Penalty Amount Application and Remarks.


CurrencyAmountValue

XPath: /OrderReshopRS/Response/ChangeFees/Details/Detail/Amounts/Amount/CurrencyAmountValue

Data Type Value: CurrencyAmountOptType

Description: Penalty monetary value amount and currency code.


Code

XPath: /OrderReshopRS/Response/ChangeFees/Details/Detail/Amounts/Amount/CurrencyAmountValue/@Code

Data Type Value: CurrencySimpleType

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


AmountApplication

XPath: /OrderReshopRS/Response/ChangeFees/Details/Detail/Amounts/Amount/AmountApplication

Data Type Value: PenaltyAppSimpleType

Description: Penalty Amount Application. Examples: MinimumPenaltyAmount, MaximumPenaltyAmount, Other.


Number

XPath: /OrderReshopRS/Response/Payments/Payment/Method/VoucherMethod/Number

Data Type Value: ShortDescSimpleType

Description: Voucher ID or Number. Example: XX12345.


Expiration

XPath: /OrderReshopRS/Response/Payments/Payment/Method/VoucherMethod/EffectiveExpireDate/Expiration

Data Type Value: date

Description: Voucher Expiration date. Example: 2017-06-13.


RemainingValue

XPath: /OrderReshopRS/Response/Payments/Payment/Method/VoucherMethod/RemainingValue

Data Type Value: CurrencyAmountOptType

Description: Remaining Amount on Voucher.


Street

XPath: /OrderReshopRS/Response/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/Street

Data Type Value: string[]

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


CityName

XPath: /OrderReshopRS/Response/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/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).


StateProv

XPath: /OrderReshopRS/Response/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/StateProv

Data Type Value: string

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


PostalCode

XPath: /OrderReshopRS/Response/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/PostalCode

Data Type Value: PostalCode

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


CountryCode

XPath: /OrderReshopRS/Response/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/CountryCode

Data Type Value: CountryCode

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


ResponseID

XPath: /OrderReshopRS/Response/ReShoppingResponseID/ResponseID

Data Type Value: ResponseID

Description: Unique shopping session response ID. Example: 1F126AF1-7FCF-414F-8A3D-E4FFA408F747.


ReshopOffers

XPath: /OrderReshopRS/Response/ReshopOffers

Data Type Value: ReshopOffers

Description: Reshopped airline offer(s).


ReshopOffer

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer

Data Type Value: ReshopOffer[]

Description: Reshopped airline offer.


OfferID

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/@OfferID

Data Type Value: ID

Description: Airline-assigned unique Offer identifier.


Owner

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/@Owner

Data Type Value: AirlineDesigSimpleType

Description: Airline designator of the owner/ assigner of the Offer ID, typically used for offer ordering purposes. Example: UA, BA. Encoding Scheme: IATA/ A4A (two or three character) Airline Designator Code.


Remark

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/Penalty/ApplicableFeeRemarks/Remark

Data Type Value: Remark[]

Description: Remark Text.


Type

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/Penalty/Details/Detail/Type

Data Type Value: PenaltySimpleType

Description: Penalty Type. Examples: Cancellation, Change, NoShow, Upgrade, Other.


Application

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/Penalty/Details/Detail/Application

Data Type Value: IATA_CodeType

Description: Penalty application type. Encoding scheme: IATA Padis Codeset FAT - Fare or Application Penalty Type.


CurrencyAmountValue

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/Penalty/Details/Detail/Amounts/Amount/CurrencyAmountValue

Data Type Value: CurrencyAmountOptType

Description: Penalty monetary value amount and currency code.


Remark

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/Penalty/Details/Detail/Amounts/Amount/ApplicableFeeRemarks/Remark

Data Type Value: Remark[]

Description: Remark Text.


Total

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/TotalPrice/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: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/TotalPrice/DetailCurrencyPrice/Total/@Code

Data Type Value: CurrencySimpleType

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


SubTotal

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/TotalPrice/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.


Code

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/TotalPrice/DetailCurrencyPrice/Details/Detail/SubTotal/@Code

Data Type Value: CurrencySimpleType

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


Total

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/TotalPrice/DetailCurrencyPrice/Taxes/Total

Data Type Value: Total

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


Amount

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/TotalPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax/Amount

Data Type Value: CurrencyAmountOptType

Description: Amount. Example: 15000 USD.


Code

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/TotalPrice/DetailCurrencyPrice/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: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/TotalPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax/TaxCode

Data Type Value: string

Description: Tax Code. Example: AY, GB.


Description

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/TotalPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax/Description

Data Type Value: ShortDescSimpleType

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


TaxType

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/TotalPrice/DetailCurrencyPrice/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.


Fees

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/TotalPrice/DetailCurrencyPrice/Fees

Data Type Value: Fees

Description: Individual fee/ surcharge information would appear on the accountable document.


Total

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/TotalPrice/DetailCurrencyPrice/Fees/Total

Data Type Value: Total

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


Code

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/TotalPrice/DetailCurrencyPrice/Fees/Total/@Code

Data Type Value: CurrencySimpleType

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


Designator

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/TotalPrice/DetailCurrencyPrice/Fees/Breakdown/Fee/Designator

Data Type Value: CodesetValueSimpleType

Description: Fee designator. Example: USC.


Amount

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/TotalPrice/DetailCurrencyPrice/Fees/Breakdown/Fee/Amount

Data Type Value: CurrencyAmountOptType

Description: Fee Amount. Example: 500 USD.


Code

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/TotalPrice/DetailCurrencyPrice/Fees/Breakdown/Fee/Amount/@Code

Data Type Value: CurrencySimpleType

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


PassengerList

XPath: /OrderReshopRS/Response/DataLists/PassengerList

Data Type Value: PassengerList

Description: Passenger data list definition.


Passenger

XPath: /OrderReshopRS/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, or ship.


PassengerID

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

Data Type Value: ID

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


PTC

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


InfantRef

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


Birthdate

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

Data Type Value: DateType

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


Gender

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

Data Type Value: GenderCodeContentType

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


NameTitle

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

Data Type Value: ShortNameType

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


GivenName

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

Data Type Value: ProperNameType[]

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


MiddelName

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

Data Type Value: ProperNameType[]

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


Surname

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

Data Type Value: ProperNameType

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


ProfileID

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

Data Type Value: SimpleTextType

Description: Passenger Profile ID.


LoyaltyProgramAccount

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

Data Type Value:

Description:


TierPriority

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

Data Type Value:

Description:


AccountNumber

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

Data Type Value:

Description:


ProgramCode

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

Data Type Value:

Description:


AirlineName

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

Data Type Value: ProperNameType

Description: Issuing Airline Name. Example: British Airways


AirlinDesignator

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


IdentityDocument

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

Data Type Value:

Description:


IdentityDocumentNumber

XPath: /OrderReshopRS/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. Example: passport number, drive license number.


IdentityDocumentType

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

Data Type Value: IdentityDocumentTypeCodeType

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


Birthdate

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

Data Type Value: DateType

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


IssueDate

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

Data Type Value:

Description:


ExpiryDate

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

Data Type Value:

Description:


IssuingCountryCode

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

Data Type Value:

Description:


CitizenshipCountryCode

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

Data Type Value:

Description:


NameTitle

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

Data Type Value:

Description:


GivenName

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

Data Type Value:

Description:


MiddleName

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

Data Type Value:

Description:


SurnameSuffix

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

Data Type Value:

Description:


Gender

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


Surname

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

Data Type Value: ProperNameType

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


ContactInfoRef

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

Data Type Value: IDREF

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


ContactInformation

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


ContactID

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

Data Type Value: ID

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


EmailAddressValue

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

Data Type Value: SimpleTextType

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


Label

XPath: /OrderReshopRS/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


CountryDialingCode

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


AreaCode

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

Data Type Value: NumberType

Description: Phone number area code. Example: 813


PhoneNumber

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

Data Type Value: NumberType

Description: Phone number text. Examples: +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.


ServiceDefinition

XPath: /OrderReshopRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition

Data Type Value: ServiceDefinitionType[]

Description: OPTIONAL SERVICE CORE definition.


Owner

XPath: /OrderReshopRS/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. Examples: UA, BA. Encoding Scheme: IATA/ A4A (two or three character) Airline or CRS Designator Code.


ServiceDefinitionID

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


Name

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

Data Type Value:

Description:


SubCode

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

Data Type Value:

Description:


refs

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

Data Type Value:

Description:


refs

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

Data Type Value:

Description:


Text

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

Data Type Value: Text

Description: Description value.


Total

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/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: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/TotalAmount/DetailCurrencyPrice/Total/@Code

Data Type Value: CurrencySimpleType

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


SubTotal

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/TotalAmount/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.


Code

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/TotalAmount/DetailCurrencyPrice/Details/Detail/SubTotal/@Code

Data Type Value: CurrencySimpleType

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


Total

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/TotalAmount/DetailCurrencyPrice/Taxes/Total

Data Type Value: Total

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


Amount

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/TotalAmount/DetailCurrencyPrice/Taxes/Breakdown/Tax/Amount

Data Type Value: CurrencyAmountOptType

Description: Amount. Example: 15000 USD.


Code

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/TotalAmount/DetailCurrencyPrice/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: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/TotalAmount/DetailCurrencyPrice/Taxes/Breakdown/Tax/TaxCode

Data Type Value: string

Description: Tax Code. Example: AY, GB.


Description

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/TotalAmount/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).


Total

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/TotalAmount/DetailCurrencyPrice/Fees/Total

Data Type Value: Total

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


Code

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/TotalAmount/DetailCurrencyPrice/Fees/Total/@Code

Data Type Value: CurrencySimpleType

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


Amount

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/TotalAmount/DetailCurrencyPrice/Fees/Breakdown/Fee/Amount

Data Type Value: CurrencyAmountOptType

Description: Fee Amount. Example: 500 USD.


Code

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/TotalAmount/DetailCurrencyPrice/Fees/Breakdown/Fee/Amount/@Code

Data Type Value: CurrencySimpleType

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


Designator

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/TotalAmount/DetailCurrencyPrice/Fees/Breakdown/Fee/Designator

Data Type Value: CodesetValueSimpleType

Description: Fee designator. Example: USC.


TaxCode

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/Taxes/Breakdown/Tax/TaxCode

Data Type Value: string

Description: Tax Code. Example: AY, GB.


Amount

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/Taxes/Breakdown/Tax/Amount

Data Type Value: CurrencyAmountOptType

Description: Amount. Example: 15000 USD.


Code

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/TotalPriceDetail/Taxes/Breakdown/Tax/Amount/@Code

Data Type Value: CurrencySimpleType

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


ServiceID

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/Service/@ServiceID

Data Type Value: ID

Description: ID for the Service unique across the entire XML document.


PassengerRefs

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/Service/PassengerRefs

Data Type Value: IDREFS

Description: Reference to the PassengerID of one or more Passengers in DataLists. The Passenger is the recipient entitled to receive/consume the Service(s) offered by the Airline, whether the Service(s) are flight-related or not.


FlightRefs

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/Service/FlightRefs

Data Type Value: IDREFS

Description: Reference to one or more flights in the Datalists that are being sold as part of this OfferItem/Service.


BaseAmount

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/FareDetail/Price/BaseAmount

Data Type Value: CurrencyAmountOptType

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


Code

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/FareDetail/Price/BaseAmount/@Code

Data Type Value: CurrencySimpleType

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


Code

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/FareDetail/FareComponent/FareBasis/FareBasisCode/Code

Data Type Value: CodesetValueSimpleType

Description: Fare basis code. Example: Y26.


FareBasisCityPair

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/FareDetail/FareComponent/FareBasis/FareBasisCityPair

Data Type Value: ContextSimpleType

Description: A data type for Context Value size constraint.


RBD

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/FareDetail/FareComponent/FareBasis/RBD

Data Type Value: string

Description: Reservation Booking Designator or Booking Class. Example: T.


CabinTypeCode

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/FareDetail/FareComponent/FareBasis/CabinType/CabinTypeCode

Data Type Value: CabinTypeCode

Description:


CabinTypeName

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/FareDetail/FareComponent/FareBasis/CabinType/CabinTypeName

Data Type Value: CabinTypeName

Description:


Remark

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/FareDetail/FareComponent/FareRules/Remarks/Remark

Data Type Value: Remark[]

Description: Remark Text.


PriceClassRef

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/FareDetail/FareComponent/PriceClassRef

Data Type Value: IDREF

Description:


SegmentRefs

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/FareDetail/FareComponent/SegmentRefs

Data Type Value: SegmentRefs

Description:


OfferItemID

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/@OfferItemID

Data Type Value: ID

Description: Unique identifier for this OfferItem instance. Must be unique within XML message. Exceeding 64 characters or use of dashes is not recommended.


OrderItemIDs

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/AddOfferItem/@OrderItemIDs

Data Type Value: string

Description: Reference to one or more OrderItems that are going to be replaced by this OfferItem.


PriceClassID

XPath: /OrderReshopRS/Response/DataLists/PriceClassList/PriceClass/@PriceClassID

Data Type Value: ID

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


Quantity

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/Parameters/PTC_Priced/Priced/@Quantity

Data Type Value: integer

Description: Number of Traveler(s) for associated passenger type and country of residence. Example: 2.


Priced

XPath: /OrderReshopRS/Response/ReshopOffers/ReshopOffer/Parameters/PTC_Priced/Priced

Data Type Value: PTC_QuantityType

Description: Actual passenger type code used for for pricing. Example: ADT. Encoding scheme: IATA (three character) Passenger Type Code.


Name

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

Data Type Value: ProperNameSimpleType

Description: Price class name. Example: SUPERSAVER.


Text

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

Data Type Value:

Description:


FlightSegment

XPath: /OrderReshopRS/Response/DataLists/FlightSegmentList/FlightSegment

Data Type Value: ListOfFlightSegmentType[]

Description: Flight origin/destination information.


SegmentKey

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

Data Type Value:

Description:


FlightSegmentType

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

Data Type Value:

Description:


Departure

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

Data Type Value:

Description:


AirportCode

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

Data Type Value:

Description:


Date

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

Data Type Value:

Description:


Time

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

Data Type Value:

Description:


Name

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

Data Type Value:

Description:


Gate

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

Data Type Value:

Description:


Arrival

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

Data Type Value:

Description:


AirportCode

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

Data Type Value:

Description:


Date

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

Data Type Value:

Description:


Time

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

Data Type Value:

Description:


Name

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

Data Type Value:

Description:


Gate

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

Data Type Value:

Description:


MarketingCarrier

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

Data Type Value:

Description:


AirlineID

XPath:

Data Type Value: /OrderReshopRS/Response/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/AirlineID

Description:


Name

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

Data Type Value:

Description:


FlightNumber

XPath: /OrderReshopRS/Response/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/FlightNumber

Data Type Value: FlightNumber

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


ResBookingDesigCode

XPath: /OrderReshopRS/Response/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/ResBookDesigCode

Data Type Value: ResBookDesigCode

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


ResBookDesigCode

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

Data Type Value:

Description:


OperatingCarrier

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

Data Type Value:

Description:


AirlineID

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

Data Type Value:

Description:


Name

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

Data Type Value:

Description:


FlightNumber

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

Data Type Value:

Description:


ResBookDesigCode

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

Data Type Value:

Description:


AircraftCode

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

Data Type Value:

Description:


Code

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

Data Type Value:

Description:


SecureFlight

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

Data Type Value:

Description:


Value

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

Data Type Value:

Description:


StopQuantity

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

Data Type Value:

Description:


StopLocation

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

Data Type Value:

Description:


AirportCode

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

Data Type Value:

Description:


ArrivalDate

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

Data Type Value:

Description:


ArrivalTime

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

Data Type Value:

Description:


DepartureDate

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

Data Type Value:

Description:


DepartureTime

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

Data Type Value:

Description:


Text

XPath: /OrderReshopRS/Response/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/Disclosures/Description/Text

Data Type Value: Text

Description: Description value.


OriginDestinationKey

XPath: /OrderReshopRS/Response/DataLists/OriginDestinationList/OriginDestination/@OriginDestinationKey

Data Type Value: KeyIdentifier

Description: A globally unique identifier for this OriginDestination instance. Example: origDest1.


DepartureCode

XPath: /OrderReshopRS/Response/DataLists/OriginDestinationList/OriginDestination/DepartureCode

Data Type Value: DepartureCode

Description: Departure Airport Location code. Example: TPA. Encoding Scheme: IATA/ A4A (three character) Airport or City Code.


ArrivalCode

XPath: /OrderReshopRS/Response/DataLists/OriginDestinationList/OriginDestination/ArrivalCode

Data Type Value: ArrivalCode

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.


FlightReferences

XPath: /OrderReshopRS/Response/DataLists/OriginDestinationList/OriginDestination/FlightReferences

Data Type Value: FlightReferences

Description: Association to multiple Flight instance(s). Example: flight1 flight2.

Note: Flight Slice On and Off Board Points may also be specified.