OfferPriceRQ
OfferPriceRQ
XPath: OfferPriceRQ
Data Type Value: OfferPriceRQ
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 a-la-carte ancillary services that are applicable and available for the offer provided.
EchoToken
XPath: OfferPriceRQ/@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: OfferPriceRQ/@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: OfferPriceRQ/@Target
Data Type Value: Target
Description: Used to indicate whether the request is for the Test or Production system.
Version
XPath: OfferPriceRQ/@Version
Data Type Value: string
Description: For all IATA versioned messages, the version of the message is indicated by a decimal value.
TransactionIdentifier
XPath: OfferPriceRQ/@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: OfferPriceRQ/@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: OfferPriceRQ/@TransactionStatusCode
Data Type Value: TransactionStatusCode
Description: This indicates where this message falls within a sequence of messages.
PrimaryLangID
XPath: OfferPriceRQ/@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: OfferPriceRQ/@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: OfferPriceRQ/@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: OfferPriceRQ/@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.
PointOfSale
PointOfSale
XPath: OfferPriceRQ/PointOfSale
Data Type Value: PointOfSaleType
Description: A data type for Point of Sale.
CountryCode
XPath: OfferPriceRQ/PointOfSale/Location/CountryCode
Data Type Value: CountryCode
Description: Country Code. Examples: US, FR. Encoding Scheme: ISO 3166-1 (two character) Country Code.
Code
XPath: OfferPriceRQ/PointOfSale/TouchPoint/Device/Code
Data Type Value: CodesetValueSimpleType
Description: Code value. Example: 003
TableName
XPath: OfferPriceRQ/PointOfSale/TouchPoint/Device/TableName
Data Type Value: ProperNameSimpleType
Description: Code set table name.
Document
Name
XPath: OfferPriceRQ/Document/Name
Data Type Value: ProperNameSimpleType
Description: NDC Implementation Name. Example: ThisAirline Gateway.
ReferenceVersion
XPath: OfferPriceRQ/Document/ReferenceVersion
Data Type Value: ContextSimpleType
Description: NDC Framework Version. Example: SOAP 2015.1.
Party
Name
XPath: OfferPriceRQ/Party/Participants/Participant/EnabledSystemParticipant/Name
Data Type Value: ProperNameSimpleType
Description: Intermediary Name. Example: Farelogix.
Owner
XPath: OfferPriceRQ/Party/Participants/Participant/EnabledSystemParticipant/SystemID/@Owner
Data Type Value: ContextSimpleType
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.
SystemID
XPath: OfferPriceRQ/Party/Participants/Participant/EnabledSystemParticipant/SystemID
Data Type Value: SystemID_Type
Description: A data type for Unique NDC-Enabled System ID.
IATA_Number
XPath: OfferPriceRQ/Party/Sender/TravelAgencySender/IATA_Number
Data Type Value: IATA_NbrSimpleType
Description: Agency Seller IATA number. Example: 98417900.
AgencyID
XPath: OfferPriceRQ/Party/Sender/TravelAgencySender/AgencyID
Data Type Value: AgencyID_Type
Description: A data type for Agency (Seller) ID.
AgentUserID
XPath: OfferPriceRQ/Party/Sender/TravelAgencySender/AgentUser/AgentUserID
Data Type Value: AgentUserID
Description: Agent User ID. Example: ksmith212.
Type
XPath: OfferPriceRQ/Party/Sender/TravelAgencySender/Type
Data Type Value: AgencyCategorySimpleType
Description: Agency Seller Type. Examples: TravelAgency, OnlineTravelAgency, TravelManagementCompany.
PseudoCity
XPath: OfferPriceRQ/Party/Sender/TravelAgencySender/AgentUser/PseudoCity
Data Type Value: PseudoCity
Description: Pseudo City code. Example: AAA2.
Name
XPath: OfferPriceRQ/Party/Sender/TravelAgencySender/Name
Data Type Value: ProperNameSimpleType
Description: Agency Seller Name. Example: Carson Travel.
Parameters
LanguageCode
XPath: OfferPriceRQ/Parameters/Languages/LanguageCode
Data Type Value: LanguageCodeType[]
Description: Language Code representation.
- Language code. Example: en, en-US
- Encoding Schemes: ISO 639-1 Code OR Microsoft National Language Support (NLS) Code
- Supports ISO 639-1 (two alpha character) neutral language encoding indicated by a name such as "en" for English.
- Supports MNLS geographically specific language encoding indicated by a name that includes both locale and country/region information. For example, the locale English (United States) has the language name "en-US".
CurrCode
XPath: OfferPriceRQ/Parameters/CurrCodes/FiledInCurrency/CurrCode
Data Type Value: CurrCode
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
DataLists
PassengerList
XPath: OfferPriceRQ/DataLists/PassengerList
Data Type Value: PassengerList
Description: Passenger data list definition.
Passenger
XPath: OfferPriceRQ/DataLists/PassengerList/Passenger
Data Type Value: PassengerType[]
Description: Any person except members of the crew carried or to be carried with the consent of the carrier, on board of any transport vehicle such as aircraft, train, bus, ship.
PassengerID
XPath: OfferPriceRQ/DataLists/PassengerList/Passenger/@PassengerID
Data Type Value: ID
Description: Uniquely identifies a Passenger within the context of one message.
PTC
XPath: OfferPriceRQ/DataLists/PassengerList/Passenger/PTC
Data Type Value: PassengerTypeCodeType
Description: Type code applying to the Passenger which typically drives pricing (e.g. ADT, CHD, etc).
Age
XPath: OfferPriceRQ/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.
Birthdate
XPath: OfferPriceRQ/DataLists/PassengerList/Passenger/Birthdate
Data Type Value: DateType
Description: The Date of Birth of the Passenger. Anonymous Shopping requests or when the birthdate (in Individual) is not known.
InfantRef
XPath: OfferPriceRQ/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.
Surname
XPath: OfferPriceRQ/DataLists/PassengerList/Passenger/Individual/Surname
Data Type Value: ProperNameType
Description: Individual's family name, last name. Example: SMITH.
GivenName
XPath: OfferPriceRQ/DataLists/PassengerList/Passenger/Individual/GivenName
Data Type Value: ProperNameType[]
Description: Individual's first or given name. Example: JOHN.
NameTitle
XPath: OfferPriceRQ/DataLists/PassengerList/Passenger/Individual/NameTitle
Data Type Value: ShortNameType
Description: Individual's name title. Examples: MR, MRS, DRn.
MiddleName
XPath: OfferPriceRQ/DataLists/PassengerList/Passenger/Individual/MiddleName
Data Type Value: ProperNameType[]
Description: Individual's middle name or initial. Examples: G, GEORGE.
LoyaltyProgramAccount
XPath: OfferPriceRQ/DataLists/PassengerList/Passenger/LoyaltyProgramAccount
Data Type Value: LoyaltyProgramAccountType[]
Description: An account set up for a customer within a rewards program which holds funds on behalf of that customer.
ProgramName
XPath: OfferPriceRQ/DataLists/PassengerList/Passenger/LoyaltyProgramAccount/ProgramName
Data Type Value: SimpleNameType
Description: Loyalty Program Name. Example: Miles and More.
AccountNumber
XPath: OfferPriceRQ/DataLists/PassengerList/Passenger/LoyaltyProgramAccount/AccountNumber
Data Type Value: SimpleCodeType
Description: Loyalty Program account number. Example: ABC123456.
AirlineDesignator
XPath: OfferPriceRQ/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.
FlightSegmentList
XPath: OfferPriceRQ/DataLists/FlightSegmentList
Data Type Value: FlightSegmentList
Description: List of Flight Segments.
FlightSegment
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment
Data Type Value: ListOfFlightSegmentType[]
Description: Flight origin/destination information.
SegmentKey
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/@SegmentKey
Data Type Value: KeyIdentifier
Description: A globally unique identifier for this Flight Segment instance. Example: segment1.
refs
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/@refs
Data Type Value: InstanceClassRefSimpleType
Description: Object association(s) between this object and any other object or metadata instance(s).
AirportCode
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/Departure/AirportCode
Data Type Value: AirportCode
Description: Airport or a city code. Use a three-letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory. Example: TPA.
Date
XPath: OfferPriceRQ/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: OfferPriceRQ/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).
Name
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/Departure/Terminal/Name
Data Type Value: ProperNameSimpleType
Description: Terminal name or ID. Example: Terminal C.
Gate
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/Departure/Terminal/Gate
Data Type Value: ContextSimpleType
Description: Terminal Gate Number. Example: C39.
AirportCode
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/Arrival/AirportCode
Data Type Value: AirportCode
Description: Airport or a city code. Use a three-letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory. Example: TPA.
Date
XPath: OfferPriceRQ/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: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/Arrival/Time
Data Type Value: TimeSimpleType
Description: Arrival time. Example: 09:15. Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM).
Name
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/Arrival/Terminal/Name
Data Type Value: ProperNameSimpleType
Description: Terminal name or ID. Example: Terminal C.
Gate
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/Arrival/Terminal/Gate
Data Type Value: ContextSimpleType
Description: Terminal Gate Number. Example: C39.
MarketingCarrier
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier
Data Type Value: MarketingCarrierFlightType
Description: Marketing Carrier information.
AirlineID
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/AirlineID
Data Type Value: AirlineID
Description: A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory.
Name
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/Name
Data Type Value: CarrierNameType
Description: Airline Name. Example: British Airways.
FlightNumber
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/FlightNumber
Data Type Value: FlightNumber
Description: Flight Number. Example: 1234, or OPEN, or ARNK.
FlightSegmentType
XPath: OfferPriceRQ/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
ResBookDesigCode
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/ResBookDesigCode
Data Type Value: ResBookDesigCode
Description: The Reservation Booking Designator (booking class) of the Marketing Carrier. Example: Y
OperatingCarrier
XPath: OfferPriceRQ/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.
AirlineID
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/AirlineID
Data Type Value: AirlineID
Description: A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory.
Name
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/Name
Data Type Value: CarrierNameType
Description: Airline Name. Example: British Airways.
Text
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/Disclosures/Description/Text
Data Type Value: Text
Description: Description value.
Equipment
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/Equipment
Data Type Value: AircraftSummaryType
Description: AIRCRAFT SUMMARY representation.
AircraftCode
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/Equipment/AircraftCode
Data Type Value: AircraftCode
Description: Equipment Code. Example: 737. Encoding Scheme: IATA/A4A Equipment Code.
ClassOfService
XPath: OfferPriceRQ/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: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/ClassOfService/Code
Data Type Value: Code
Description: Class of Service Code. Example: B
SeatsLeft
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/ClassOfService/Code/@SeatsLeft
Data Type Value: int
Description: Indicates how many seats are still available in this class of service.
MarketingName
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/ClassOfService/MarketingName
Data Type Value: MarketingName
Description: Cabin Class Marketing Name. Example: Premium Economy.
FlightDuration
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/FlightDetail/FlightDuration
Data Type Value: FlightDurationType
Description: FLIGHT DURATION with Application definition.
Value
XPath: OfferPriceRQ/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.
StopQuantity
XPath: OfferPriceRQ/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopQuantity
Data Type Value: integer
Description: Stop Quantity. Example: 1
OriginDestinationKey
XPath: OfferPriceRQ/DataLists/OriginDestinationList/OriginDestination/@OriginDestinationKey
Data Type Value: KeyIdentifier
Description: A globally unique identifier for this OriginDestination instance. Example: origDest1.
DepartureCode
XPath: OfferPriceRQ/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: OfferPriceRQ/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: OfferPriceRQ/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.
ServiceDefinition
XPath: OfferPriceRQ/DataLists/ServiceDefinitionList/ServiceDefinition
Data Type Value: ServiceDefinitionType[]
Description: OPTIONAL SERVICE CORE definition
Owner
XPath: OfferPriceRQ/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.
Text
XPath: OfferPriceRQ/DataLists/ServiceDefinitionList/ServiceDefinition/Descriptions/Description/Text
Data Type Value: Text
Description: Description value.
Name
XPath: OfferPriceRQ/DataLists/ServiceDefinitionList/ServiceDefinition/Name
Data Type Value: Name
Description: Service name. Example: Lounge Pass
Code
XPath: OfferPriceRQ/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).
PriceClassID
XPath: OfferPriceRQ/DataLists/PriceClassList/PriceClass/@PriceClassID
Data Type Value: ID
Description: Object globally unique Instance ID. Example: obj1
Name
XPath: OfferPriceRQ/DataLists/PriceClassList/PriceClass/Name
Data Type Value: ProperNameSimpleType
Description: Price class name. Example: SUPERSAVER
Code
XPath: OfferPriceRQ/DataLists/PriceClassList/PriceClass/Code
Data Type Value: CodesetValueSimpleType
Description: Price class code. Example: 1, ABC
Query
OfferID
XPath: OfferPriceRQ/Query/Offer/@OfferID
Data Type Value: ID
Description: Reference to the OfferID of the selected Offer (either a standard Offer or an a-la-carte Offer) returned in a previous shopping response.
Owner
XPath: OfferPriceRQ/Query/Offer/@Owner
Data Type Value: string
Description: Designator of Airline that owns/ assigned these IDs. Examples: BA
Encoding Scheme: IATA/ A4A (two or three character) Airline Designator Code
OfferItemID
XPath: OfferPriceRQ/Query/Offer/OfferItem/@OfferItemID
Data Type Value: string
Description: Reference to the OfferItemID of the selected OfferItem (contained in either a standard Offer or an a-la-carte Offer) returned in a previous shopping response.
PassengerRefs
XPath: OfferPriceRQ/Query/Offer/OfferItem/PassengerRefs
Data Type Value: IDREFS
Description: Reference to passenger(s) for which this OfferItem and selected Services (in case of Service Bundles) applies.
ResponseID
XPath: OfferPriceRQ/Query/Offer/@ResponseID
Data Type Value: string
Description: Reference to unique shopping session response ID, as provided in the airline's previous shopping response.
Qualifiers
AirlineID
XPath: OfferPriceRQ/Qualifiers/Qualifier/SpecialFareQualifiers/AirlineID
Data Type Value:
Description:
Account
XPath: OfferPriceRQ/Qualifiers/Qualifier/SpecialFareQualifiers/Account
Data Type Value:
Description:
Contract
XPath: OfferPriceRQ/Qualifiers/Qualifier/SpecialFareQualifiers/Contract
Data Type Value:
Description:
Qualifier
AirlineID
XPath: OfferPriceRQ/Qualifier/ProgramQualifiers/ProgramQualifier/PrePaidProgramQualifier/PrepaidProgramDetail/AirlineID
Data Type Value: AirlineID
Description: Program issuing airline designator code. Example: BA. Encoding Scheme: IATA/ A4A (two to three character) Airline Designator Code.
Number
XPath: OfferPriceRQ/Qualifier/ProgramQualifiers/ProgramQualifier/PrePaidProgramQualifier/PrepaidProgramDetail/Certificate/Number
Data Type Value: Number
Description: Unique certificate number. Example: 12345678.
ProgramName
XPath: OfferPriceRQ/Qualifier/ProgramQualifiers/ProgramQualifier/PrePaidProgramQualifier/PrepaidProgramDetail/ProgramName
Data Type Value: ProgramName
Description: Program Name. Example: PASSPRO.
ProgramCode
XPath: OfferPriceRQ/Qualifier/ProgramQualifiers/ProgramQualifier/PrePaidProgramQualifier/PrepaidProgramDetail/ProgramCode
Data Type Value: CodesetValueSimpleType
Description: Program Code. Example: PP01.
ProgramStatus
XPath: OfferPriceRQ/Qualifier/ProgramQualifiers/ProgramQualifier/ProgramStatusQualifier/ProgramStatus
Data Type Value: ProgramStatus[]
Description: Program status name.