AirShoppingRS NDC 2017.2
AirShoppingRS
AirShoppingRS
XPath: AirShoppingRS
Data Type Value: Type: restriction of xs:anyType [0..1]
Description: The AirShopping transaction set supports both demanding and flexible shopping experiences for anonymous or personalized shopping. The combination of functionally-rich attribute and affinity shopping support date range or specific month (calendar) shopping as an example.
The response returns offers which may include branded offers or itinerary-priced offers with or without ancillary services. It also returns applicable rules for the integrated fares as well as for each service.
The message also returns multi-media content at message level as well as media references at the individual offer level.
EchoToken
XPath: AirShoppingRS/@EchoToken
Data Type Value: Type: StringLength1to128 [0..1]
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: AirShoppingRS/@TimeStamp
Data Type Value: xs:dateTime [0..1]
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).
Version
XPath: AirShoppingRS/@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: AirShoppingRS/@TransactionIdentifier
Data Type Value: StringLength1to32 [0..1]
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).
PrimaryLangID
XPath: /AirShoppingRS/@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: /AirShoppingRS/@AltLangID
Data Type Value: language
Description: Identifies the alternate language for a customer or message. The human language is identified by ISO 639 codes.
SequenceNmbr
XPath: AirShoppingRS/@SequenceNmbr
Data Type Value: xs:nonNegativeInteger [0..1]
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.
Document
Name
XPath: AirShoppingRS/Document/Name
Data Type Value:
Description:
ReferenceVersion
XPath: AirShoppingRS/Document/ReferenceVersion
Data Type Value:
Description:
Success
Success
XPath: AirShoppingRS/Success
Data Type Value: SuccessType [0..1]
Description: The presence of the empty Success element explicitly indicates that the message succeeded.
Warnings
Warnings
XPath: AirShoppingRS/Warnings
Data Type Value: WarningsType [0..1]
Description: Used in conjunction with the Success element to define one or more business errors.
Warning
XPath: AirShoppingRS/Warnings/Warning
Data Type Value: WarningType [1..99]
Description: Used in conjunction with the Success element to define a business error.
Type
XPath: .../Warnings/Warning/@Type
Data Type Value: IATA_CodeType [0..1]
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: .../Warnings/Warning/@ShortText
Data Type Value: StringLength1to64 [0..1]
Description: An error in textual format.
Code
XPath: .../Warnings/Warning/@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: .../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.
Tag
XPath: .../Warnings/Warning/@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 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].
DataLists
TermsList
XPath: AirShoppingRS/DataLists/TermsList
Data Type Value: ListOfOfferTermsType [0..1]
Description: Offer/Order Term(s).
ListKey
XPath: AirShoppingRS/DataLists/TermsList/@ListKey
Data Type Value: xs:ID
Description: Globally unique id for this Data List instance.
Term
XPath: /AirShoppingRS/DataLists/TermsList/Term
Data Type Value: OfferTermsType[]
Description: Terms detail.
refs
XPath: /AirShoppingRS/DataLists/TermsList/Term/Descriptions/Description/@refs
Data Type Value: InstanceClassRefSimpleType
Description: Object association(s) between this object and any other object or metadata instance(s).
Text
XPath: AirShoppingRS/DataLists/TermsList/Term/Descriptions/Description/Text
Data Type Value: extension of DescriptionSimpleType [0..1]
Description: Description value.
ListKey
XPath: /AirShoppingRS/DataLists/InstructionsList/Instruction/@ListKey
Data Type Value: ID
Description: Globally unique id for this Data List instance.
Remark
XPath: /AirShoppingRS/DataLists/InstructionsList/Instruction/FreeFormTextInstruction/Remark
Data Type Value: Remark[]
Description: Remark Text.
PriceClassList
XPath: AirShoppingRS/DataLists/PriceClassList
Data Type Value: ListOfPriceClassType [0..1]
Description: Price Class List.
PriceClass
XPath: AirShoppingRS/DataLists/PriceClassList/PriceClass
Data Type Value: PriceClassType [1..∞]
Description: PRICE CLASS definition.
Name
XPath: AirShoppingRS/PriceClassList/PriceClass/Name
Data Type Value: ProperNameSimpleType
Description: Price class name. Example: SUPERSAVER
PriceClassID
XPath: AirShoppingRS/DataLists/PriceClassList/PriceClass/@PriceClassID
Data Type Value: xsd:ID optional
Description: Object globally unique instance ID.
Text
XPath: /AirShoppingRS/DataLists/PriceClassList/PriceClass/Descriptions/Description/Text
Data Type Value: Text
Description: Description value.
OriginDestination
XPath: /AirShoppingRS/DataLists/OriginDestinationList/OriginDestination
Data Type Value: OriginDestination[]
Description: Origin/ Destination information. Contains a list of all Flight element that are part of that OD.
DepartureCode
XPath: /AirShoppingRS/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: /AirShoppingRS/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: AirShoppingRS/DataLists/OriginDestinationList/OriginDestination/FlightReferences
Data Type Value: extension of InstanceClassRefSimpleType [0..1]
Description: Association to multiple Flight instance(s). Example: flight1 flight2
Note: Flight Slice On and Off Board Points may also be specified.
OriginDestinationKey
XPath: AirShoppingRS/DataLists/OriginDestinationList/OriginDestination/@OriginDestinationKey
Data Type Value: KeyIdentifier
Description: A globally unique identifier for this OriginDestination instance. Example: origDest1.
FlightSegmentList
XPath: AirShoppingRS/DataLists/FlightSegmentList
Data Type Value: FlightSegmentList
Description: List of Flight segments.
FlightSegment
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment
Data Type Value: ListOfFlightSegmentType [1..∞]
Description: Flight origin/destination information.
Date
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/Departure/Date
Data Type Value: xs:date
Description: Departure date. Example: 2017-01-13
Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)
Time
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/Departure/Time
Data Type Value: TimeSimpleType [0..1]
Description: Departure time. Example: 09:15
Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)
Date
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/Arrival/Date
Data Type Value: xs:date [0..1]
Description: Arrival date. Example: 2017-01-14
Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)
Time
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/Arrival/Time
Data Type Value: TimeSimpleType [0..1]
Description: Arrival time. Example: 09:15
Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)
StopQuantity
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopQuantity
Data Type Value: xs:positiveInteger [0..1]
Description: Stop Quantity. Example: 1
AirportCode
XPath: AirShoppingRS/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: AirShoppingRS/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: AirShoppingRS/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: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopLocations/StopLocation/DepartureDate
Data Type Value: date
Description: Scheduled Departure Date. Example: 2017-01-13. Note: This is the date and time of departure in GMT from the unticketed point.
DepartureTime
XPath: AirShoppingRS/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).
SegmentKey
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/@SegmentKey
Data Type Value: KeyIdentifier
Description: A globally unique identifier for this Flight Segment instance. Example: segment1
FlightNumber
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/FlightNumber
Data Type Value: extension of FlightNumberType
Description: Flight Number. Example: 1234, or OPEN, or ARNK
ResBookDesigCode
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/ResBookDesigCode
Data Type Value: xs:anyType [0..1]
Description: The Reservation Booking Designator (booking class) of the Marketing Carrier. Example: Y
ElectronicTicketInd
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/@ElectronicTicketInd
Data Type Value: xs:boolean [0..1]
Description: When TRUE, an electronic ticket may be issued.
ObjectKey
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/Disclosures/Description/@ObjectKey
Data Type Value: ID
Description: Object globally unique Instance ID. Example: obj1
Text
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/Disclosures/Description/Text
Data Type Value: Text
Description: Description value.
ChangeOfDay
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/Arrival/ChangeOfDay
Data Type Value: integer
Description: Number of days between arrival and departure. Example: 1.
Departure
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/Departure
Data Type Value: extension of FlightDepartureType
Description: Departure (origin) Airport, Date and Time information.
AirportCode
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/Departure/AirportCode
Data Type Value: extension of AirportCitySimpleType
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
Name
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/Departure/Terminal/Name
Data Type Value: ProperNameSimpleType [0..1]
Description: Terminal name or ID. Example: Terminal C
Gate
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/Departure/Terminal/Gate
Data Type Value: ContextSimpleType [0..1]
Description: Terminal Gate Number. Example: C39
Arrival
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/Arrival
Data Type Value: FlightArrivalType
Description: Arrival (destination) Airport, Date and Time information.
AirportCode
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/Arrival/AirportCode
Data Type Value: extension of AirportCitySimpleType
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
Name
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/Arrival/Terminal/Name
Data Type Value: ProperNameSimpleType [0..1]
Description: Terminal name or ID. Example: Terminal C
Gate
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/Arrival/Terminal/Gate
Data Type Value: ContextSimpleType [0..1]
Description: Terminal Gate Number. Example: C39
OperatingCarrier
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier
Data Type Value: extension of OperatingCarrierFlightType [0..1]
Description: Operating Carrier Information.
Operating Carrier is the carrier that operates a flight with a reference to its own prime flight number.
Note: Operating Carrier may be different from a Marketing Carrier(s), if the flight is 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: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/Name
Data Type Value: ProperNameSimpleType [0..1]
Description: Airline Name. Example: British Airways
AirlineID
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/AirlineID
Data Type Value: extension of AirlineID_Type [0..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: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/FlightNumber
Data Type Value: extension of FlightNumberType [0..1]
Description: Flight Number. Example: 1234, or OPEN, or ARNK
ResBookDesigCode
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/ResBookDesigCode
Data Type Value: CodesetValueSimpleType [0..1]
Description: The Reservation Booking Designator (booking class) of the Operating Carrier if different from the Marketing Carrier. Example: Y
Equipment
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/Equipment
Data Type Value: AircraftSummaryType [0..1]
Description: Aircraft Equipment.
AircraftCode
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/Equipment/AircraftCode
Data Type Value: extension of AircraftCodeType
Description: The IATA aircraft type three-character code; use SSIM Appendix A. Example:318.
MarketingCarrier
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier
Data Type Value: MarketingCarrierFlightType
Description: Marketing Carrier information.
Name
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/Name
Data Type Value: ProperNameSimpleType [0..1]
Description: Airline Name. Example: British Airways
AirlineID
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/AirlineID
Data Type Value: extension of AirlineID_Type
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.
ClassOfService
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/ClassOfService
Data Type Value: FlightCOS_CoreType
Description: A data type for Class of Service Core. Class of service code. Example: B.
Code
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/ClassOfService/Code
Data Type Value: extension of Flight_COS_SimpleType
Description: Class of Service Code. Example: B
SeatsLeft
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/ClassOfService/Code/@SeatsLeft
Data Type Value: xs:int [0..1]
Description: Indicates how many seats are still available in this class of service.
Value
XPath: AirShoppingRS/DataLists/FlightSegmentList/FlightSegment/FlightDetail/FlightDuration/Value
Data Type Value: xs:duration
Description: Flight Segment Duration. Example: PT6H45M (six hours and forty-five minutes)
Note: This is the in-flight time duration associated with this segment. Stop duration is specified in the Stops node.
PassengerID
XPath: AirShoppingRS/DataLists/PassengerList/Passenger/@PassengerID
Data Type Value: ID
Description: Uniquely identifies a Passenger within the context of one message.
PTC
XPath: AirShoppingRS/DataLists/PassengerList/Passenger/PTC
Data Type Value: PassengerTypeCodeType
Description: Type code applying to the Passenger which typically drives pricing (e.g. ADT, CHD, etc).
OffersGroup
OffersGroup
XPath: AirShoppingRS/OffersGroup
Data Type Value: Type: restriction of xs:anyType [0..1]
Description: Offers Grouped by Airline Supplier.
Offer
XPath: /AirShoppingRS/OffersGroup/AirlineOffers/Offer
Data Type Value: Offer[]
Description: A collection of Offer Items.
OfferID
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/@OfferID
Data Type Value: ItemID_Type xsd:string [1..1]
Description: Airline-assigned unique Offer identifier (Built-in derived type. ID represents the ID attribute type.The base type of ID is NCName). Globally unique Offer instance ID. Length should not exceed 64 characters and it is recommended to not use dash character. For example: QWASZXERDFCVTYGHBNUIJKNMF67D5F9GHR567SWER41SD458F9456FMDIRTN34DF
Owner
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/@Owner
Data Type Value: AirlineDesigSimpleType [1..1] xsd:string
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.
DetailCurrencyPrice
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice
Data Type Value: DetailCurrencyPriceType
Description: DETAIL CURRENCY PRICE BASIS UNIT: Price with tax and/ or fee break-down or totals.
SubTotal
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice/Details/Detail/SubTotal
Data Type Value: CurrencyAmountOptType [0..1]
Description: Price breakdown sub-total.
Note: This is the total of all price breakdown items, excluding tax and/ or surcharge.
Code
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice/Details/Detail/SubTotal/@Code
Data Type Value: CurrencySimpleType [0..1]
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
Total
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice/Total
Data Type Value: CurrencyAmountOptType [0..1]
Description: Total price in currency. Example: 16000 USD
Note: This is the total price INCLUDING base price, taxes, and fees/surcharges.
Code
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice/Total/@Code
Data Type Value: CurrencySimpleType [0..1]
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
Taxes
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice/Taxes
Data Type Value: Taxes
Description: Ticket Tax/fee/charge details to indicate taxes that apply to country of commencement of travel and routing.
Total
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice/Taxes/Total
Data Type Value: Total
Description: Sub-total of all applicable taxes. Monetary value and currency code.
Tax
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax
Data Type Value: Tax[]
Description: Tax breakdown detail.
Amount
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax/Amount
Data Type Value: CurrencyAmountOptType
Description: Amount. Example: 15000 USD
Code
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/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: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax/TaxCode
Data Type Value: string
Description: Tax Code. Example: AY, GB
Nation
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax/Nation
Data Type Value: string
Description: Tax Nation or Designator. Example: US, GB
Description
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/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).
Fees
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice/Fees
Data Type Value: Fees
Description: Individual fee/ surcharge information would appear on the accountable document.
Total
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice/Fees/Total
Data Type Value: Total
Description: Sub-total of all fees and charges. Monetary value and currency code.
Code
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice/Fees/Total/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Fee
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice/Fees/Breakdown/Fee
Data Type Value: Fee[]
Description: Individual fee/ surcharge information would appear on the accountable document. Note: Separate structure for individual TAX details is also present.
Amount
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice/Fees/Breakdown/Fee/Amount
Data Type Value: CurrencyAmountOptType
Description: Fee Amount. Example: 500 USD
Code
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/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: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TotalPrice/DetailCurrencyPrice/Fees/Breakdown/Fee/Designator
Data Type Value: CodesetValueSimpleType
Description: Fee designator. Example: USC
Priced
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/Parameters/PTC_Priced/Priced
Data Type Value: PTC_QuantityType [0..1]
Description: Actual passenger type code used for for pricing. Example: ADT
Encoding scheme: IATA (three character) Passenger Type Code
Quantity
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/Parameters/PTC_Priced/Priced/@Quantity
Data Type Value: PTC_QuantityPricedType [0..∞]
Description: Requested to be priced, and actually Priced PTC (Passenger Type Code) and associated Traveler(s) quantity.
DateTime
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TimeLimits/OfferExpiration/@DateTime
Data Type Value: xsd:dateTime [0..1]
Description: Date and time. Example: 2017-01-03T13:20:00
PriceGuaranteeTimeLimit
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TimeLimits/OtherLimits/OtherLimit/PriceGuaranteeTimeLimit
Data Type Value: PriceGuaranteeTimeLimit
Description: Price Guarantee Time Limit value. Examples: 2017-05-30T09:00:00, 2015-01-13T13:59:38Z.
Notes:
- This is the period for which an Offer price is guaranteed.
- On expiry an Offer may be re-priced up to the point an accountable document is issued.
- A Price Guarantee cannot extend beyond the Offer Expiration Time Limit unless an Order has been created.
TicketBy
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/TimeLimits/OtherLimits/OtherLimit/TicketByTimeLimit/TicketBy
Data Type Value: TicketBy
Description: Ticketing By Time Limit. Example: 2017-05-30T09:00:00.
DEPRECATON NOTICE:
This element will be deprecated in the 2015.1 publication.
Notes: This is not the Offer Expiration Time Limit that applies to offers in a shopping response. This is the date/ time when a ticket-associated offer must be ticketed, e.g. applicable to booking versus shopping. It has been left in the specification for backwards compatibility
OfferItem
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem
Data Type Value: extension of OfferPriceLeadType [1..∞]
Description: Fare Offer and Lead Calendar Pricing information.
OfferItemID
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/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.
FlightRefs
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/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.
PassengerRefs
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/Service/PassengerRefs
Data Type Value: xsd:IDREFS [1..1]
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.
BaseAmount
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/BaseAmount
Data Type Value: CurrencyAmountOptType
Description: Total Base Fare Amount. Example: 200000
Note: This includes surcharges (if applicable).
Code
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/BaseAmount/@Code
Data Type Value: CurrencySimpleType [0..1]
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
Taxes
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/Taxes
Data Type Value: TaxDetailType [0..1]
Description: Ticket Tax/fee/charge details to indicate taxes that apply to country of commencement of travel and routing.
Total
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/Taxes/Total
Data Type Value: extension of CurrencyAmountOptType [0..1]
Description: Sub-total of all applicable taxes. Monetary value and currency code.
Description
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/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: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/Taxes/Breakdown/Tax/TaxCode
Data Type Value: xs:string [0..1]
Description: Tax Code. Example: AY, GB
Amount
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/Taxes/Breakdown/Tax/Amount
Data Type Value: CurrencyAmountOptType
Description: Amount. Example: 15000 USD
Code
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/Taxes/Breakdown/Tax/Amount/@Code
Data Type Value: CurrencySimpleType [0..1]
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
Nation
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/Taxes/Breakdown/Tax/Nation
Data Type Value: string
Description: Tax Nation or Designator. Example: US, GB
TaxType
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/Taxes/Breakdown/Tax/TaxType
Data Type Value: xs:string [0..1]
Description: Tax type. Used to specify where the tax was applied. May be nice to have for auditing purposes. Example: 001, 002
RefundInd
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/Taxes/Breakdown/Tax/@RefundInd
Data Type Value: xs:boolean [0..1]
Description: When true, the tax amount is refundable.
Surcharges
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/Surcharges
Data Type Value: Surcharges
Description: Applicable Surcharge(s).
Total
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/Surcharges/Surcharge/Total
Data Type Value: extension of CurrencyAmountOptType
Description: Sub-total of all fees and charges. Monetary value and currency code.
Code
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/Surcharges/Surcharge/Total/@Code
Data Type Value: CurrencySimpleType [0..1]
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
Fee
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/Surcharges/Surcharge/Breakdown/Fee
Data Type Value: Fee[]
Description: Individual fee/ surcharge information would appear on the accountable document.
Note: Separate structure for individual TAX details is also present.
Description
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/Surcharges/Surcharge/Breakdown/Fee/Description
Data Type Value: ShortDescSimpleType [0..1]
Description: Fee/ surcharge Description. Example: U.S Customs User Fee
Designator
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/Surcharges/Surcharge/Breakdown/Fee/Designator
Data Type Value: CodesetValueSimpleType [0..1]
Description: Fee designator. Example: USC
Amount
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/Surcharges/Surcharge/Breakdown/Fee/Amount
Data Type Value: CurrencyAmountOptType
Description: Fee Amount. Example: 500 USD
Code
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/Surcharges/Surcharge/Breakdown/Fee/Amount/@Code
Data Type Value: CurrencySimpleType [0..1]
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
SimpleCurrencyPrice
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/TotalAmount/SimpleCurrencyPrice
Data Type Value: SimpleCurrencyPriceType [0..1]
Description: A (simple) CURRENCY-based Price with NO taxes and/ or fees. Examples: 100.00, 100, 100 (USD)
Code
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/TotalPriceDetail/TotalAmount/SimpleCurrencyPrice/@Code
Data Type Value: CurrencySimpleType [0..1]
Description: Currency code. Example: USD
Encoding Scheme: ISO 4217 (three alpha character) Currency Code
ServiceID
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/Service/@ServiceID
Data Type Value:
Description:
ServiceRef
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/Service/ServiceRef
Data Type Value: xs:IDREF
Description: Association to one Price Class instance. Example: pclass1
FareDetail
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/FareDetail
Data Type Value: FareDetailType[]
Description: Fare Detail, including Fare Component and Fare Rules.
Remark
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/FareDetail/Remarks/Remark
Data Type Value: Remark[]
Description: Remark Text.
TimeStamp
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/FareDetail/Remarks/Remark/@Timestamp
Data Type Value: dateTime
Description: Remark creation timestamp. Example: 2017-01-13T13:59:38Z
BaseAmount
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/FareDetail/Price/BaseAmount
Data Type Value: CurrencyAmountOptType
Description: Total Base Fare Amount. Example: 200000.
Note: This includes surcharges (if applicable).
Code
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/FareDetail/Price/BaseAmount/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
CabinTypeCode
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/FareDetail/FareComponent/FareBasis/CabinType/CabinTypeCode
Data Type Value: CabinTypeCode
Description:
CabinTypeName
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/FareDetail/FareComponent/FareBasis/CabinType/CabinTypeName
Data Type Value: CabinTypeName
Description:
Code
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/FareDetail/FareComponent/FareBasis/FareBasisCode/Code
Data Type Value: CodesetValueSimpleType
Description: Fare basis code. Example: Y26
FareBasisCityPair
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/FareDetail/FareComponent/FareBasis/FareBasisCityPair
Data Type Value: ContextSimpleType
Description: A data type for Context Value size constraint.
RBD
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/FareDetail/FareComponent/FareBasis/RBD
Data Type Value: string
Description: Reservation Booking Designator or Booking Class. Example: T.
PriceClassRef
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/FareDetail/FareComponent/PriceClassRef
Data Type Value: IDREF
Description:
SegmentRefs
XPath: AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/FareDetail/FareComponent/SegmentRefs
Data Type Value: SegmentRefs
Description:
Errors
Errors
XPath: AirShoppingRS/Errors
Data Type Value: ErrorsType [0..1]
Description: Error(s) that prevented message processing.
Error
XPath: AirShoppingRS/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: AirShoppingRS/Errors/Error/@Language
Data Type Value: xs:language [0..1]
Description: Language identification.
Type
XPath: AirShoppingRS/Errors/Error/@Type
Data Type Value: IATA_CodeType [0..1]
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: AirShoppingRS/Errors/Error/@ShortText
Data Type Value: StringLength1to64 [0..1]
Description: An error in textual format.
Code
XPath: AirShoppingRS/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: AirShoppingRS/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: AirShoppingRS/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: AirShoppingRS/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: AirShoppingRS/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: AirShoppingRS/Errors/Error/@NodeList
Data Type Value: xs:string [0..1]
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.
Metadata
MetadataKey
XPath: AirShoppingRS/Metadata/Other/OtherMetadata/CurrencyMetadatas/CurrencyMetadata/@MetadataKey
Data Type Value: ID
Description: A globally unique identifier for this Metadata instance.
Decimals
XPath: AirShoppingRS/Metadata/Other/OtherMetadata/CurrencyMetadatas/CurrencyMetadata/Decimals
Data Type Value: integer
Description: Number of decimal places. Example: 2. Note, this is the number of decimal places normally used when displaying amounts in this currency.
refs
XPath: AirShoppingRS/Metadata/Shopping/ShopMetadataGroup/Qualifier/ProgramQualifiers/ProgramQualifier/DiscountProgramQualifier/@refs
Data Type Value: InstanceClassRefSimpleType
Description: Object association(s) between this object and any other object or metadata instance(s).
refs
XPath: AirShoppingRS/Metadata/Shopping/ShopMetadataGroup/Qualifier/ProgramQualifiers/ProgramQualifier/IncentiveProgramQualifier/@refs
Data Type Value: InstanceClassRefSimpleType
Description: Object association(s) between this object and any other object or metadata instance(s).
Account
XPath: AirShoppingRS/Metadata/Shopping/ShopMetadataGroup/Qualifier/ProgramQualifiers/ProgramQualifier/DiscountProgramQualifier/Account
Data Type Value: Account
Description: Membership account or ID number. Example: 0956301007
Name
XPath: AirShoppingRS/Metadata/Shopping/ShopMetadataGroup/Qualifier/ProgramQualifiers/ProgramQualifier/DiscountProgramQualifier/Name
Data Type Value: Name
Description: Program name. Example: AARP MEMBERSHIP.
AssocCode
XPath: AirShoppingRS/Metadata/Shopping/ShopMetadataGroup/Qualifier/ProgramQualifiers/ProgramQualifier/DiscountProgramQualifier/AssocCode
Data Type Value: AssocCode
Description: Code for an organization or association which owns or sponsors a particular discount program which an airline may support (discount program support could be in on a bilateral basis). Examples: AARP, AAA.
Name
XPath: AirShoppingRS/Metadata/Shopping/ShopMetadataGroup/Qualifier/ProgramQualifiers/ProgramQualifier/IncentiveProgramQualifier/Name
Data Type Value: ProperNameSimpleType
Description: Incentive program name.
Example: RFSB (Reward for small businesses)
AccountID
XPath: AirShoppingRS/Metadata/Shopping/ShopMetadataGroup/Qualifier/ProgramQualifiers/ProgramQualifier/IncentiveProgramQualifier/AccountID
Data Type Value: AccountID
Description: Corporate or individual membership account identification for an airline sponsored incentive program (Incentive Programs are NOT Frequent Traveler Loyalty (FQTV program). Example: IBM123.
AirlineID
XPath: AirShoppingRS/Metadata/Shopping/ShopMetadataGroup/Qualifier/ProgramQualifiers/ProgramQualifier/IncentiveProgramQualifier/AirlineID
Data Type Value: AirlineID
Description: Designator of airline offering the incentive program. Example: BA. Encoding Scheme: IATA/ A4A (two or three character) Airline Designator Code.
MemberStatus
XPath: AirShoppingRS/Metadata/Shopping/ShopMetadataGroup/Qualifier/ProgramQualifiers/ProgramQualifier/IncentiveProgramQualifier/MemberStatus
Data Type Value: MemberStatus
Description: Member or participant status within the program. Examples: VP, DIRECTOR, EXEC.
ProgramStatus
XPath: AirShoppingRS/Metadata/Shopping/ShopMetadataGroup/Qualifier/ProgramQualifiers/ProgramQualifier/ProgramStatusQualifier/ProgramStatus
Data Type Value: ProgramStatus[]
Description: Program status name.
AirlineID
XPath: AirShoppingRS/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.
Contract
XPath: AirShoppingRS/Metadata/Shopping/ShopMetadataGroup/Qualifier/SpecialFareQualifiers/Contract
Data Type Value: Contract
Description: Contract ID used for pricing special fares. Example: 675124.
Fare Rules
Code
XPath: AirShoppingRS/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: AirShoppingRS/DataLists/PenaltyList/Penalty/@ObjectKey
Data Type Value: xsd:ID
Description: Object globally unique Instance ID. Example: obj1
Type
XPath: AirShoppingRS/DataLists/PenaltyList/Penalty/Details/Detail/Type
Data Type Value: PenaltySimpleType
Description: Penalty Type.
Examples: Cancellation, Change, NoShow, Upgrade, Other
CurrencyAmountValue
XPath: AirShoppingRS/DataLists/PenaltyList/Penalty/Details/Detail/Amounts/Amount/CurrencyAmountValue
Data Type Value: CurrencyAmountOptType
Description: Penalty monetary value amount and currency code.
Remark
XPath: AirShoppingRS/DataLists/PenaltyList/Penalty/ApplicableFeeRemarks/Remark
Data Type Value: xsd:string
Description: Remark Text
Application
XPath: AirShoppingRS/DataLists/PenaltyList/Penalty/Details/Detail/Application
Data Type Value: IATA_CodeType
Description: Penalty application type.
Encoding scheme: IATA Padis Codeset FAT - Fare or Application Penalty Type
ChangeFeeInd
XPath: AirShoppingRS/DataLists/PenaltyList/Penalty/@ChangeFeeInd
Data Type Value: xsd:boolean
Description: When true, Change of Itinerary fee(s) may apply.