OfferPriceRS
OfferPriceRS
XPath: OfferPriceRS
Data Type Value: OfferPriceRS
Description: The OfferPrice transaction set may return two different sets of content. The response will initially provide the priced Offer reflecting the Offers/OfferItems requested for pricing, and potentially additional Offers that are applicable and relevant to the PricedOffer provided.
EchoToken
XPath: OfferPriceRS/@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: OfferPriceRS/@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: OfferPriceRS/@Target
Data Type Value: Target
Description: Used to indicate whether the request is for the Test or Production system.
Version
XPath: OfferPriceRS/@Version
Data Type Value: xs:string
Description: For all IATA versioned messages, the version of the message is indicated by a decimal value.
TransactionIdentifier
XPath: OfferPriceRS/@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: OfferPriceRS/@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: OfferPriceRS/@TransactionStatusCode
Data Type Value: TransactionStatusCode
Description: This indicates where this message falls within a sequence of messages.
PrimaryLangID
XPath: OfferPriceRS/@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: OfferPriceRS/@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: OfferPriceRS/@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: OfferPriceRS/@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: OfferPriceRS/Document/@id
Data Type Value: ID
Description: A globally unique identifier for this object instance.
Name
XPath: OfferPriceRS/Document/Name
Data Type Value: ProperNameSimpleType
Description: NDC Implementation Name.
Example: ThisAirline Gateway
ReferenceVersion
XPath: OfferPriceRS/Document/ReferenceVersion
Data Type Value: ContextSimpleType
Description: NDC Framework Version. Example: SOAP 2015.1
Success
Success
XPath: OfferPriceRS/Success
Data Type Value: SuccessType
Description: The presence of the empty Success element explicitly indicates that the message succeeded.
Warnings
Warnings
XPath: OfferPriceRS/Warnings
Data Type Value: WarningsType
Description: Used in conjunction with the Success element to define one or more business errors.
Warning
XPath: OfferPriceRS/Warnings/Warning
Data Type Value: WarningType[]
Description: Used in conjunction with the Success element to define a business error.
Language
XPath: OfferPriceRS/Warnings/Warning/@Language
Data Type Value: language
Description: Language identification.
Type
XPath: OfferPriceRS/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".
ShortText
XPath: OfferPriceRS/Warnings/Warning/@ShortText
Data Type Value: StringLength1to255
Description: An error in textual format.
Code
XPath: OfferPriceRS/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: OfferPriceRS/Warnings/Warning/@DocURL
Data Type Value: xs:anyURI [0..1]
Description: If present, this URL refers to an online description of the error that occurred.
Status
XPath: OfferPriceRS/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: OfferPriceRS/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 in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].
RecordID
XPath: OfferPriceRS/Warnings/Warning/@RecordID
Data Type Value: StringLength1to32 [0..1]
Description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records.
PricedOffer
PricedOffer
XPath: OfferPriceRS/PricedOffer
Data Type Value: PricedOffer
Description: Offer containing all the Offers/OfferItems requested for pricing in previous request.
OfferID
XPath: OfferPriceRS/PricedOffer/@OfferID
Data Type Value: ID
Description: Airline-assigned unique Offer identifier.
Owner
XPath: OfferPriceRS/PricedOffer/@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
refs
XPath: OfferPriceRS/PricedOffer/Penalty/@refs
Data Type Value: InstanceClassRefSimpleType
Description: Object association(s) between this object and any other object or metadata instance(s).
DateTime
XPath: OfferPriceRS/PricedOffer/TimeLimits/OfferExpiration/@DateTime
Data Type Value: dateTime
Description: Date and time. Example: 2017-01-03T13:20:00
TotalPrice
XPath: OfferPriceRS/PricedOffer/TotalPrice
Data Type Value: TotalPrice
Description: The total price for all mandatory OfferItems contained within this Offer.
DetailCurrencyPrice
XPath: OfferPriceRS/PricedOffer/TotalPrice/DetailCurrencyPrice
Data Type Value: DetailCurrencyPriceType[1..1]
Description: A (detailed) CURRENCY-based Price with Price Break-down for Tax and/ or Fee information.
Total
XPath: OfferPriceRS/PricedOffer/TotalPrice/DetailCurrencyPrice/Total
Data Type Value: CurrencyAmountOptType
Description: Total price in currency. Example: 16000 USD
📝 This is the total price INCLUDING base price, taxes and fees/ surcharges.
Code
XPath: OfferPriceRS/PricedOffer/TotalPrice/DetailCurrencyPrice/Total/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
Detail
XPath: OfferPriceRS/PricedOffer/TotalPrice/DetailCurrencyPrice/Details/Detail
Data Type Value: Detail[]
Description: Price details.
📝 This price does not include taxes and fee/surcharges.
SubTotal
XPath: OfferPriceRS/PricedOffer/TotalPrice/DetailCurrencyPrice/Details/Detail/SubTotal
Data Type Value: CurrencyAmountOptType
Description: Price breakdown sub-total.
📝 This is the total of all price breakdown items, excluding tax and/or surcharge.
Code
XPath: OfferPriceRS/PricedOffer/TotalPrice/DetailCurrencyPrice/Details/Detail/SubTotal/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
Application
XPath: OfferPriceRS/PricedOffer/TotalPrice/DetailCurrencyPrice/Details/Detail/Application
Data Type Value: ProperNameSimpleType
Description: Price application. Example: Base Fare
TaxCode
XPath: OfferPriceRS/OtherOffers/Offer/TotalPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax/TaxCode
Data Type Value: string
Description: Tax Code. Example: AY, GB
Description
XPath: OfferPriceRS/PricedOffer/TotalPrice/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)
Tax
XPath: OfferPriceRS/PricedOffer/TotalPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax
Data Type Value: Tax[]
Description: Tax breakdown detail.
Amount
XPath: OfferPriceRS/PricedOffer/TotalPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax/Amount
Data Type Value: CurrencyAmountOptType
Description: Amount. Example: 15000 USD
Code
XPath: OfferPriceRS/PricedOffer/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
Total
XPath: OfferPriceRS/PricedOffer/TotalPrice/DetailCurrencyPrice/Fees/Total
Data Type Value: Total
Description: Sub-total of all fees and charges. Monetary value and currency code.
Code
XPath: OfferPriceRS/PricedOffer/TotalPrice/DetailCurrencyPrice/Fees/Total/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Amount
XPath: OfferPriceRS/PricedOffer/TotalPrice/DetailCurrencyPrice/Fees/Breakdown/Fee/Amount
Data Type Value: CurrencyAmountOptType
Description: Fee Amount. Example: 500 USD
Code
XPath: OfferPriceRS/PricedOffer/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
Designator
XPath: OfferPriceRS/OtherOffers/Offer/TotalPrice/DetailCurrencyPrice/Fees/Breakdown/Fee/Designator
Data Type Value: CodesetValueSimpleType
Description: Fee designator. Example: USC.
Total
XPath: OfferPriceRS/PricedOffer/TotalPrice/DetailCurrencyPrice/Taxes/Total
Data Type Value: Total
Description: Sub-total of all applicable taxes. Monetary value and currency code.
Code
XPath: OfferPriceRS/PricedOffer/TotalPrice/DetailCurrencyPrice/Taxes/Total/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
OfferItem
XPath: OfferPriceRS/PricedOffer/OfferItem
Data Type Value: OfferItemType[]
Description: A set of one or more Service s. The Offer Item assigns a total price for all included services for all passengers and all segments referenced. Once constructed, the OfferItem cannot be modified.
OfferItemID
XPath: OfferPriceRS/PricedOffer/OfferItem/@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.
Total
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/TotalAmount/DetailCurrencyPrice/Total
Data Type Value: CurrencyAmountOptType
Description: Total price in currency. Example: 16000 USD
📝 This is the total price INCLUDING base price, taxes and fees/ surcharges.
Code
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/TotalAmount/DetailCurrencyPrice/Total/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
BaseAmount
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/BaseAmount
Data Type Value: CurrencyAmountOptType
Description: Total Base Fare Amount. Example: 200000
📝 This includes surcharges (if applicable).
Code
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/BaseAmount/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
Surcharges
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Surcharges
Data Type Value: Surcharges
Description: Applicable Surcharge(s).
Total
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Surcharges/Surcharge/Total
Data Type Value: Total
Description: Sub-total of all fees and charges. Monetary value and currency code.
Description
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Surcharges/Surcharge/Breakdown/Fee/Description
Data Type Value: ShortDescSimpleType
Description: Fee/surcharge Description. Example: U.S Customs User Fee
Designator
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Surcharges/Surcharge/Breakdown/Fee/Designator
Data Type Value: CodesetValueSimpleType
Description: Fee designator. Example: USC
Amount
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Surcharges/Surcharge/Breakdown/Fee/Amount
Data Type Value: CurrencyAmountOptType
Description: Fee Amount. Example: 500 USD
Taxes
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Taxes
Data Type Value: TaxDetailType
Description: Ticket Tax/fee/charge details to indicate taxes that apply to country of commencement of travel and routing.
Total
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Taxes/Total
Data Type Value: Total
Description: Sub-total of all applicable taxes. Monetary value and currency code.
Code
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Taxes/Total/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
Description
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Taxes/Breakdown/Tax/Description
Data Type Value: ShortDescSimpleType [0..1]
Description: Tax short description.
Example: $4 per flight segment, per passenger (U.S. domestic segment tax)
TaxCode
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Taxes/Breakdown/Tax/TaxCode
Data Type Value: string
Description: Tax Code. Example: AY, GB
Amount
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Taxes/Breakdown/Tax/Amount
Data Type Value: CurrencyAmountOptType
Description: Amount. Example: 15000 USD
Nation
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Taxes/Breakdown/Tax/Nation
Data Type Value: string
Description: Tax Nation or Designator. Example: US, GB
CollectionInd
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Taxes/Breakdown/Tax/@CollectionInd
Data Type Value: boolean
Description: When true, this tax must be collected.
Code
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Taxes/Breakdown/Tax/Amount/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
TaxType
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/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
Description
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Discount/Description
Data Type Value: DescriptionSimpleType
Description: Discount Description.
DiscountAmount
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Discount/DiscountAmount
Data Type Value: CurrencyAmountOptType
Description: AMOUNT with OPTIONAL CURRENCY ENCODING representation.
Application
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Discount/Application
Data Type Value: ContextSimpleType
Description: Discount Application. Example: BAG
ServiceID
XPath: OfferPriceRS/PricedOffer/OfferItem/Service/@ServiceID
Data Type Value: ID
Description: ID for the Service unique across the entire XML document.
PassengerRefs
XPath: OfferPriceRS/PricedOffer/OfferItem/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: OfferPriceRS/PricedOffer/OfferItem/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.
ServiceRef
XPath: OfferPriceRS/PricedOffer/OfferItem/Service/ServiceRef
Data Type Value: IDREF
Description: Create dependencies with parent services to which this particular Service is linked. Can reference Services across different OfferItems within the same Offer.
ServiceDefinitionRef
XPath: OfferPriceRS/PricedOffer/OfferItem/Service/ServiceDefinitionRef
Data Type Value: ServiceDefinitionRef
Description: References the ID of the Service Definition in DataLists.
Total
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Fees/Total
Data Type Value: Total
Description: Sub-total of all fees and charges. Monetary value and currency code.
Code
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Fees/Total/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Fee
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Fees/Breakdown/Fee
Data Type Value: Fee[]
Description: Individual fee/ surcharge information would appear on the accountable document.
📝 Separate structure for individual TAX details is also present.
Amount
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Fees/Breakdown/Fee/Amount
Data Type Value: CurrencyAmountOptType
Description: Fee Amount. Example: 500 USD.
Code
XPath: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/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: OfferPriceRS/PricedOffer/OfferItem/TotalPriceDetail/Fees/Breakdown/Fee/Designator
Data Type Value: CodesetValueSimpleType
Description: Fee designator. Example: USC.
BaseAmount
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/Price/BaseAmount
Data Type Value: CurrencyAmountOptType
Description: Total Base Fare Amount. Example: 200000
📝 This includes surcharges (if applicable).
Code
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/Price/BaseAmount/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
PassengerRefs
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/PassengerRefs
Data Type Value: PassengerRefs
Description: Passengers associated with the specific Fare Detail instance. Allows the Price breakdown of the fare for the OfferItem per passenger.
Total
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/Price/TotalAmount/DetailCurrencyPrice/Total
Data Type Value: CurrencyAmountOptType
Description: Total price in currency. Example: 16000 USD.
📝 This is the total price INCLUDING base price, taxes and fees/ surcharges.
Code
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/Price/TotalAmount/DetailCurrencyPrice/Total/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
Total
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/Price/Taxes/Total
Data Type Value: Total
Description: Sub-total of all applicable taxes. Monetary value and currency code.
Code
XPath: OfferPriceRS/PricedOffer/OfferItem/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: OfferPriceRS/PricedOffer/OfferItem/FareDetail/Price/Taxes/Breakdown/Tax/Amount
Data Type Value: CurrencyAmountOptType
Description: Amount. Example: 15000 USD.
Code
XPath: OfferPriceRS/PricedOffer/OfferItem/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.
Description
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/Price/Taxes/Breakdown/Tax/Description
Data Type Value: ShortDescSimpleType
Description: Tax short description. Example: $4 per flight segment, per passenger (U.S. domestic segment tax).
RBD
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/FareComponent/FareBasis/RBD
Data Type Value: string
Description: Reservation Booking Designator or Booking Class e.g. T
CabinTypeCode
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/FareComponent/FareBasis/CabinType/CabinTypeCode
Data Type Value: CabinTypeCode
Description:
CabinTypeName
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/FareComponent/FareBasis/CabinType/CabinTypeName
Data Type Value: CabinTypeName
Description:
Code
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/FareComponent/FareBasis/FareBasisCode/Code
Data Type Value: CodesetValueSimpleType
Description: Fare basis code. Example: Y26
refs
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/FareComponent/FareBasis/FareBasisCode/@refs
Data Type Value: InstanceClassRefSimpleType
Description: Object association(s) between this object and any other object or metadata instance(s).
FareBasisCityPair
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/FareComponent/FareBasis/FareBasisCityPair
Data Type Value: ContextSimpleType
Description: A data type for Context Value size constraint.
TicketDesig
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/FareComponent/TicketDesig
Data Type Value: TicketDesignatorType
Description: Ticket Designator with Application definition.
Total
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/Price/Surcharges/Surcharge/Total
Data Type Value: Total
Description: Sub-total of all fees and charges. Monetary value and currency code.
Code
XPath: OfferPriceRS/PricedOffer/OfferItem/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: OfferPriceRS/PricedOffer/OfferItem/FareDetail/Price/Surcharges/Surcharge/Breakdown/Fee/Amount
Data Type Value: CurrencyAmountOptType
Description: Fee Amount. Example: 500 USD
Code
XPath: OfferPriceRS/PricedOffer/OfferItem/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: OfferPriceRS/PricedOffer/OfferItem/FareDetail/Price/Surcharges/Surcharge/Breakdown/Fee/Designator
Data Type Value: CodesetValueSimpleType
Description: Fee designator. Example: USC.
PriceClassRef
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/FareComponent/PriceClassRef
Data Type Value: IDREF
Description:
SegmentRefs
XPath: OfferPriceRS/PricedOffer/OfferItem/FareDetail/FareComponent/SegmentRefs
Data Type Value: SegmentRefs
Description:
Payments
Type
XPath: OfferPriceRS/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.
MisChargeOrder
XPath: OfferPriceRS/Payments/Payment/Method/MiscChargeOrder
Data Type Value: MiscChargeOrder
Description: Miscellaneous Charge Order (MCO) information.
TicketNumber
XPath: OfferPriceRS/Payments/Payment/Method/MiscChargeOrder/TicketNumber
Data Type Value: ContextSimpleType
Description: The ticket number of the miscellaneous charge order (MCO).
Remark
XPath: OfferPriceRS/Payments/Payment/Method/Other/Remarks/Remark
Data Type Value: Remark[]
Description: Remark Text.
Amount
XPath: OfferPriceRS/Payments/Payment/Amount
Data Type Value: SimpleCurrencyPriceType
Description: The amount for this form of payment. Example: 300 USD
Code
XPath: OfferPriceRS/Payments/Payment/Amount/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Number
XPath: OfferPriceRS/Payments/Payment/Method/Voucher/Number
Data Type Value: ShortDescSimpleType
Description: Voucher ID or Number. Example: XX12345.
DataLists
Age
XPath: OfferPriceRS/DataLists/PassengerList/Passenger/Age
Data Type Value: MeasureType
Description: The age of the passenger. To be used in NDC Anonymous Shopping requests or when the birthdate (in Individual) is not known.
PTC
XPath: OfferPriceRS/DataLists/PassengerList/Passenger/PTC
Data Type Value: extension of PaxSimpleType [0..1]
Description: Passenger type code and travelers quantity. ADT
PassengerID
XPath: OfferPriceRS/DataLists/PassengerList/Passenger/@PassengerID
Data Type Value: PassengerTypeCodeType
Description: Type code applying to the Passenger which typically drives pricing (e.g., ADT, CHD, etc).
DisclosureList
XPath: OfferPriceRS/DataLists/DisclosureList
Data Type Value: ListOfDisclosureType
Description: DISCLOSURE data list definition.
Disclosures
XPath: OfferPriceRS/DataLists/DisclosureList/Disclosures
Data Type Value:
Description:
ListKey
XPath: OfferPriceRS/DataLists/DisclosureList/Disclosures/@ListKey
Data Type Value: ID
Description: Globally unique id for this Data List instance.
Text
XPath: OfferPriceRS/DataLists/DisclosureList/Disclosures/Description/Text
Data Type Value: Text
Description: Description value.
FlightSegmentList
XPath: OfferPriceRS/DataLists/FlightSegmentList
Data Type Value: FlightSegmentList
Description: List of Flight Segments
FlightSegment
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment
Data Type Value: ListOfFlightSegmentType[]
Description: Flight origin/ destination information.
SegmentKey
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/@SegmentKey
Data Type Value: KeyIdentifier
Description: A globally unique identifier for this Flight Segment instance. Example: segment1
refs
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/@refs
Data Type Value: InstanceClassRefSimpleType
Description: Object association(s) between this object and any other object or metadata instance(s).
SecureFlight
XPath: OfferPriceRS/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".
Date
XPath: OfferPriceRS/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: OfferPriceRS/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).
Date
XPath: OfferPriceRS/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: OfferPriceRS/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).
Date
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/@refs/FlightSegment/Departure/Date
Data Type Value: InstanceClassRefSimpleType
Description: Object association(s) between this object and any other object or metadata instance(s).
Time
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/@refs/FlightSegment/Departure/Time
Data Type Value: InstanceClassRefSimpleType
Description: Object association(s) between this object and any other object or metadata instance(s).
Date
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/@refs/FlightSegment/Arrival/Date
Data Type Value: InstanceClassRefSimpleType
Description: Object association(s) between this object and any other object or metadata instance(s).
Time
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/@refs/FlightSegment/Arrival/Time
Data Type Value: InstanceClassRefSimpleType
Description: Object association(s) between this object and any other object or metadata instance(s).
StopQuantity
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopQuantity
Data Type Value: integer
Description: Stop Quantity. Example: 1
StopLocation
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopLocations/StopLocation
Data Type Value: StopLocation[]
Description: Stop Location detail.
AirportCode
XPath: OfferPriceRS/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.
ArrivalDate
XPath: OfferPriceRS/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).
ArrivalTime
XPath: OfferPriceRS/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).
DepartureDate
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopLocations/StopLocation/DepartureDate
Data Type Value: date
Description: Scheduled Departure Date. Example: 2017-01-13.
📝 This is the date and time of departure in GMT from the unticketed point.
DepartureTime
XPath: OfferPriceRS/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).
Code
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/ClassOfService/Code
Data Type Value: Code
Description: Class of Service Code. Example: B
MarketingName
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/ClassOfService/MarketingName
Data Type Value: MarketingName
Description: Cabin Class Marketing Name. Example: Premium Economy
FareBasisCode
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/ClassOfService/FareBasisCode
Data Type Value: string
Description: Fare basis code. Example: Y26CH.
Departure
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/Departure
Data Type Value: Departure
Description: Departure (origin) Airport, Date and Time information.
AirportCode
XPath: OfferPriceRS/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
Terminal
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/Departure/Terminal
Data Type Value: Terminal
Description: Airport terminal name and gate.
Refer to IATA SSIM Appendix D for terminal codes and terminal names.
AirportCode
XPath: OfferPriceRS/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
OperatingCarrier
XPath: OfferPriceRS/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.
📝 Operating Carrier may be different from a Marketing Carrier(s), if the flight is actually marketed by another carrier(s) within a codeshare agreement.
Operating Carrier may not be the AOC holder, in which case, and wherever required, this will need to be disclosed to the customer.
Name
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/Name
Data Type Value: CarrierNameType
Description: Airline Name. Example: British Airways
AirlineID
XPath: OfferPriceRS/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.
Equipment
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/Equipment
Data Type Value: AircraftSummaryType
Description: AIRCRAFT SUMMARY representation.
AircraftCode
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/Equipment/AircraftCode
Data Type Value: AircraftCode
Description: Equipment Code. Example: 737
Encoding Scheme: IATA/ A4A Equipment Code
MarketingCarrier
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier
Data Type Value: MarketingCarrierFlightType
Description: Marketing Carrier information.
Name
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/Name
Data Type Value: CarrierNameType
Description: Airline Name. Example: British Airways
AirlineID
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/AirlineID
Data Type Value: xsd:string [1..1]
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.
FlightNumber
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/FlightNumber
Data Type Value: FlightNumber
Description: Flight Number. Example: 1234, or OPEN, or ARNK
ResBookDesigCode
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/ResBookDesigCode
Data Type Value: ResBookDesigCode
Description: The Reservation Booking Designator (booking class) of the Marketing Carrier. Example: Y.
Text
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/Disclosures/Description/Text
Data Type Value: Text
Description: Description value.
ObjectKey
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/Disclosures/Description/@ObjectKey
Data Type Value: ID
Description: Object globally unique Instance ID. Example: obj1
Value
XPath: OfferPriceRS/DataLists/FlightSegmentList/FlightSegment/FlightDetail/FlightDuration/Value
Data Type Value: duration
Description: Flight Segment Duration.
Example: PT6H45M (six hours and forty-five minutes)
📝 This is the in-flight time duration associated with this segment. Stop duration is specified in the Stops node.
FlightSegmentType
XPath: OfferPriceRS/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.
OriginDestinationKey
XPath: OfferPriceRS/DataLists/OriginDestinationList/OriginDestination/@OriginDestinationKey
Data Type Value: KeyIdentifier
Description: A globally unique identifier for this OriginDestination instance. Example: origDest1
DepartureCode
XPath: OfferPriceRS/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: OfferPriceRS/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: OfferPriceRS/DataLists/OriginDestinationList/OriginDestination/FlightReferences
Data Type Value: FlightReferences
Description: Association to multiple Flight instance(s). Example: flight1 flight2
📝 Flight Slice On and Off Board Points may also be specified.
PriceClass
XPath: OfferPriceRS/DataLists/PriceClassList/PriceClass
Data Type Value: ListOfPriceClassType [0..1]
Description: Price Class definition.
PriceClassID
XPath: OfferPriceRS/DataLists/PriceClassList/PriceClass/@PriceClassID
Data Type Value: ID
Description: Object globally unique Instance ID. Example: obj1
Name
XPath: OfferPriceRS/DataLists/PriceClassList/PriceClass/Name
Data Type Value: ProperNameSimpleType
Description: Price class name. Example: SUPERSAVER
Description
XPath: OfferPriceRS/DataLists/PriceClassList/PriceClass/Descriptions/Description
Data Type Value: Description[]
Description: Description detail.
Text
XPath: OfferPriceRS/DataLists/PriceClassList/PriceClass/Descriptions/Description/Text
Data Type Value: Text
Description: Description value.
Code
XPath: OfferPriceRS/DataLists/PriceClassList/PriceClass/ClassOfService/Code
Data Type Value: Code
Description: Class of Service Code. Example: B
ServiceDefinition
XPath: OfferPriceRS/DataLists/ServiceDefinitionList/ServiceDefinition
Data Type Value: ServiceDefinitionType[]
Description: OPTIONAL SERVICE CORE definition.
ServiceDefinitionID
XPath: OfferPriceRS/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"
Owner
XPath: OfferPriceRS/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
Name
XPath: OfferPriceRS/DataLists/ServiceDefinitionList/ServiceDefinition/Name
Data Type Value: Name
Description: Service name. Example: Lounge Pass
Text
XPath: OfferPriceRS/DataLists/ServiceDefinitionList/ServiceDefinition/Descriptions/Description/Text
Data Type Value: Text
Description: Descriptive value.
ServiceDefinitionRef
XPath: OfferPriceRS/DataLists/ServiceDefinitionList/ServiceDefinition/ServiceBundle/ServiceDefinitionRef
Data Type Value: ServiceDefinitionRef[]
Description: Reference to further Service Definitions which form part of this Service Bundle
Code
XPath: OfferPriceRS/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).
ListKey
XPath: OfferPriceRS/DataLists/TermsList/@ListKey
Data Type Value: ID
Description: Globally unique id for this Data List instance.
Text
XPath: OfferPriceRS/DataLists/TermsList/Term/Descriptions/Description/Text
Data Type Value: Text
Description: Description value.
OtherOffers
OfferID
XPath: OfferPriceRS/OtherOffers/ALaCarteOffer/@OfferID
Data Type Value: ID
Description: Airline-assigned unique Offer identifier.
Owner
XPath: OfferPriceRS/OtherOffers/ALaCarteOffer/@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.
OfferItemID
XPath: OfferPriceRS/OtherOffers/ALaCarteOffer/ALaCarteOfferItem/@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.
PassengerRefs
XPath: OfferPriceRS/OtherOffers/ALaCarteOffer/ALaCarteOfferItem/Eligibility/PassengerRefs
Data Type Value: PassengerRefs
Description: Reference to the passengers who are eligible for this Offer Item
SegmentRefs
XPath: OfferPriceRS/OtherOffers/ALaCarteOffer/ALaCarteOfferItem/Eligibility/SegmentRefs
Data Type Value: SegmentRefs
Description: Reference to the flight segments on which this Offer Item can be provided.
SimpleCurrencyPrice
XPath: OfferPriceRS/OtherOffers/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/TotalAmount/SimpleCurrencyPrice
Data Type Value: SimpleCurrencyPriceType
Description: SIMPLE CURRENCY PRICE BASIS UNIT: NO price break-down, taxes and/or fees.
Code
XPath: OfferPriceRS/OtherOffers/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/TotalAmount/SimpleCurrencyPrice/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Total
XPath: OfferPriceRS/OtherOffers/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/TotalAmount/DetailCurrencyPrice/Total
Data Type Value: CurrencyAmountOptType
Description: Total price in currency. Example: 16000 USD
📝 This is the total price INCLUDING base price, taxes and fees/ surcharges.
BaseAmount
XPath: OfferPriceRS/OtherOffers/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/BaseAmount
Data Type Value: CurrencyAmountOptType
Description: Total Base Fare Amount. Example: 200000
📝 This includes surcharges (if applicable).
Taxes
XPath: OfferPriceRS/OtherOffers/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/Taxes
Data Type Value:
Description:
Total
XPath: OfferPriceRS/OtherOffers/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/Taxes/Total
Data Type Value: TaxDetailType
Description: Ticket Tax/fee/charge details to indicate taxes that apply to country of commencement of travel and routing.
Description
XPath: OfferPriceRS/OtherOffers/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/Taxes/Breakdown/Tax/Description
Data Type Value: ShortDescSimpleType
Description: Tax short description.
Example: $4 per flight segment, per passenger (U.S. domestic segment tax)
Amount
XPath: OfferPriceRS/OtherOffers/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/Taxes/Breakdown/Tax/Amount
Data Type Value: CurrencyAmountOptType
Description: Amount. Example: 15000 USD
TaxCode
XPath: OfferPriceRS/OtherOffers/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/Taxes/Breakdown/Tax/TaxCode
Data Type Value: string
Description: Tax Code. Example: AY, GB
TaxType
XPath: OfferPriceRS/OtherOffers/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/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.
Metadata
MetadataKey
XPath: OfferPriceRS/Metadata/Other/OtherMetadata/CurrencyMetadatas/CurrencyMetadata/@MetadataKey
Data Type Value: ID
Description: A globally unique identifier for this Metadata instance.
Decimals
XPath: OfferPriceRS/Metadata/Other/OtherMetadata/CurrencyMetadatas/CurrencyMetadata/Decimals
Data Type Value: integer
Description: Number of decimal places. Example: 2.
📝 This is the number of decimal places normally used when displaying amounts in this currency.
Name
XPath: OfferPriceRS/Metadata/Other/OtherMetadata/CurrencyMetadatas/CurrencyMetadata/Name
Data Type Value: ProperNameSimpleType
Description: Currency name. Example: US Dollars
AirlineID
XPath: OfferPriceRS/Metadata/Shopping/ShopMetadataGroup/Qualifier/SpecialFareQualifiers/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.
Account
XPath: OfferPriceRS/Metadata/Shopping/ShopMetadataGroup/Qualifier/SpecialFareQualifiers/Account
Data Type Value: Account
Description: Corporate account name or ID used for pricing special fares. Example: 675124
SpecialFareQualifiers
Contract
XPath: OfferPriceRS/SpecialFareQualifiers/ContractMetadata/Shopping/ShopMetadataGroup/Qualifier/SpecialFareQualifiers/Contract
Data Type Value: Contract
Description: Contract ID used for pricing special fares. Example: 675124.
Errors
Errors
XPath: OfferPriceRS/Errors
Data Type Value: ErrorsType [0..1]
Description: A collection of errors that occurred during the processing of a message.
Error
XPath: OfferPriceRS/Errors/Error
Data Type Value: ErrorType [1..99]
Description: Standard way to indicate that an error occurred during the processing of an IATA message
Language
XPath: OfferPriceRS/Errors/Error/@Language
Data Type Value: language
Description: Language identification.
Type
XPath: OfferPriceRS/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".
ShortText
XPath: OfferPriceRS/Errors/Error/@ShortText
Data Type Value: StringLength1to255
Description: An error in textual format.
Code
XPath: OfferPriceRS/Errors/Error/@Code
Data Type Value: IATA_CodeType [0..1]
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: OfferPriceRS/Errors/Error/@DocURL
Data Type Value: xs:anyURI [0..1]
Description: If present, this URL refers to an online description of the error that occurred.
Status
XPath: OfferPriceRS/Errors/Error/@Status
Data Type Value: StringLength1to64 [0..1]
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: OfferPriceRS/Errors/Error/@Tag
Data Type Value: xs:string [0..1]
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 in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].
RecordID
XPath: OfferPriceRS/Errors/Error/@RecordID
Data Type Value: StringLength1to32 [0..1]
Description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records.
NodeList
XPath: OfferPriceRS/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.
Promotions
Remark
XPath: OfferPriceRS/Promotions/Promotion/Remarks/Remark
Data Type Value: Remark[]
Description: Remark Text.
Code
XPath: OfferPriceRS/Promotions/Promotion/Code
Data Type Value Code**:** Code
Description: Promotion code ID or number. Example: PROMO123. Used in conjunction with Link (Promotion URL), Issuer (Promotion Owner or Sponsor) and Remarks (Promotion remarks).
Fare Rules
Code
XPath: OfferPriceRS/DataLists/PenaltyList/Penalty/Details/Detail/Amounts/Amount/CurrencyAmountValue/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
ObjectKey
XPath: OfferPriceRS/DataLists/PenaltyList/Penalty/@ObjectKey
Data Type Value: xsd:ID
Description: Object globally unique Instance ID. Example: obj1
Type
XPath: OfferPriceRS/DataLists/PenaltyList/Penalty/Details/Detail/Type
Data Type Value: PenaltySimpleType
Description: Penalty Type.
Examples: Cancellation, Change, NoShow, Upgrade, Other
CurrencyAmountValue
XPath: OfferPriceRS/DataLists/PenaltyList/Penalty/Details/Detail/Amounts/Amount/CurrencyAmountValue
Data Type Value: CurrencyAmountOptType
Description: Penalty monetary value amount and currency code.