OfferPrice Request Field Descriptions
/DistributionChainLink/DistributionChainLink/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <Ordinal> | The number defining the position of the distribution chain link in the distribution chain indicating the order in which the organization participated. | Integer | Required |
| <OrgRole> | The distribution chain role performed by the participating organization. That is, the Seller (end buyer facing), the Distributor (an intermediary), or the Carrier (the Responsible Supplier). For clarity this is different to the business model used by the participating organization, and the Nature of Business typically registered during incorporation as one of the organization's business activities. |
Enumeration:
Aggregator B2C:
OTA Direct Connect:
|
Required |
/DistributionChainLink/DistributionChainLink/ParticpatingOrg/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <OrgID> | Organization code or identifier. | Token: IATA number | Required |
| <Name> | Name of the organization. | Token | Required |
/Request/DataLists/PaxList/Pax/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <PTC (passenger type code)> | Type code applying to the passenger which typically drives pricing (e.g. ADT, CHD, etc). | String | Optional |
| <PaxID> | Uniquely identifies a Passenger within the context of one message. | Token | Required |
/Request/PricedOffer/SelectedOfferList/SelectedOffer/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <OfferRefID> | Reference to the OfferID of the selected Offer (either a standard Offer or an a-la-carte Offer) returned in a previous shopping response. | Token | Required |
| <OwnerCode> | Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. | Token | Optional |
/Request/PricedOffer/SelectedOfferList/SelectedOffer/SelectedOfferItem/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <OfferItemRefID> | 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. | Token | Optional |
| <PaxRefID> | Reference to passenger(s) for which this OfferItem and selected Services (in case of Service Bundles) applies. | Token | Optional |
OfferPrice Response Field Descriptions
/Response/DataLists/BaggageAllowanceList/BaggageAllowance/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <BaggageAllowanceID> | Unique identifier of this Baggage Allowance. | Token | Required |
| <DescText> |
Baggage allowance description and additional information. Example: The data are always separated by comma and first field is the RFISC, 2nd is carrier, 3rd is the baggage description (name, weight), 4th field is the price and last field is the currency. |
String | Required |
| <RFISC> | Reason for issuance sub code. Examples: 0CC (first checked bag) 0B1 (in-flight entertainment) 0BX (Lounge). | String | Required |
| <TypeCode> | Type of Baggage Allowance. E.g. Checked or CarryOn. | Token | Required |
| <CarrierDesigCode> | Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. | Token | Required |
| <TotalQty> | Maximum pieces of baggage allowed. Example: 4 | Decimal | Required |
/Response/DataLists/DatedMarketingSegmentList/DatedMarketingSegment/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <IATA_LocationCode> | IATA 3-letter code defining the city or airport code. | Token | Required |
| <MarketingCarrierFlightNumberText> | The numerical designation of a flight as it is marketed by a carrier. | String | Required |
| <AircraftScheduledDateTime> | The scheduled date and time of arrival of the aircraft at the terminal or departure gate in an airport. | DateTime | Required |
| <CarrierDesigCode> | Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. | Token | Required |
| <DatedOperatingSegmentRefId> | Reference to a unique identifier of a dated operating segment used in a message. | Token | Required |
| <DatedMarketingSegmentID> | Unique identifier of a dated marketing segment used in a message. | Token | Required |
| <CarrierName> | Commercial name of the carrier. | Token | Optional |
/Response/DataLists/PaxJourneyList/PaxJourney/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <PaxJourneyID> | Uniquely identifies a Passenger Journey within the context of one message. | Token | Required |
| <PaxSegmentRefID> | Reference to a Passenger Segment ID within this message. | Token | Required |
| <DistanceMeasure (@unitCode)> | Total distance between the beginning and end stations of a leg, measured by the great circle of the earth. | Decimal | Required |
| <Duration> | Total journey time including the combined airtime and connection times. In case of stopover, this may or may not include stopover durations. | Integer | Required |
/Response/DataLists/PaxSegmentList/PaxSegment/CabinTypeAssociationChoice/LegCabinAssociations/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <CabinTypeName> | Name given to a cabin compartment (e.g. Business, First, Economy). | Token | Optional |
| <DatedOperatingLegRefID> | Uniquely identifies a leg within the context of one message. | Token | Required |
/Response/DataLists/PaxList/Pax/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <PTC> | Type code applying to the passenger which typically drives pricing (e.g. ADT, CHD, etc). | String | Required |
| <PaxID> | Uniquely identifies a Passenger within the context of one message. | Token | Required |
/Response/DataLists/PriceClassList/PriceClass/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <CabinTypeCode> |
Cabin Type Code as defined by ATSB codeset 9873. For AS NDC:
|
Token | Optional |
| <CabinTypeName> | Name given to a cabin compartment (e.g. Business, First, Economy). | Token | Optional |
| <FareBasisCode> | Fare basis code. Example: Y26. | Token | Optional |
| <Name> | Price class name. Ecample: SUPERSAVER. | Token | Required |
| <PriceClassID> | Uniquely identifies a price class within the context of one message. | Token | Required |
/Response/DataLists/PaxSegmentList/PaxSegment/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <DatedMarketingSegmentRefId> | A reference to a unique identifier of a dated marketing segment used in a message. | Token | Required |
| <PaxSegmentID> | Uniquely identifies a Passenger segment within the context of one message. | Token | Required |
/Response/DataLists/DatedOperatingSegmentList/DatedOperatingSegment/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <DatedOperatingSegmentId> | Unique identifier of a dated operating segment used in a message. For the airline that is operating the flight. May be different from the Marketing airline. | Token | Required |
| <DatedOperatingLegRefID> | Uniquely identifies a leg within the context of one message. Identifies one or more flight legs within this segment. | Token | Required |
| <CarrierDesigCode> | Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. | Token | Required |
| <Duration> | Total segment time including the combined airtime and connection times of any legs. | Duration | Optional |
/Response/DataLists/DatedOperatingLegList/DatedOperatingLeg/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <DatedOperatingLegID> | Uniquely identifies a leg within the context of one message. | Token | Required |
| <DistanceMeasure (@UnitCode)> | Total distance between the beginning and end stations of a leg, measured by the great circle of the earth. | Decimal | Required |
| <IATA_AircraftType> | Grouping of aircrafts with the same form, function and specification, currently flown, or soon to be flown. Possible types are defined in the IATA SSIM. The same type may include aircrafts with different technical specifications such as engines, range, cockpit configuration. Business Identifier Fields: - IATA Aircraft Type Code. | Token | Optional |
| <AircraftScheduledDateTime> | The Scheduled Date and Time of Arrival of the aircraft at the terminal or departure gate at an airport. | DateTime | Required |
| <IATA_LocationCode> | IATA 3-letter code defining the city or airport code. | Token | Required |
| <TerminalName> | The name of the terminal. | Token | Optional |
| <CarrierAircraftTypeCode> | Internal code used by a carrier to identify the type of aircraft. | Token | Optional |
| <CarrierAircraftName> | Internal name given by the carrier to this aircraft type. | Token | Optional |
/Response/DataLists/ServiceDefinitionList/ServiceDefinition/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <ServiceDefinitionID> | Uniquely identifies a service definition within the context of one message. | Token | Optional |
| Desc/<DescText> | Description text value. | String | Required |
| <Name> | Service Name. Example: Lounge Pass. | Token | Required |
| <OwnerCode> | Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. | Token | Required |
| <BaggageAllowanceRefID> | Reference to a Bag Allowance ID within this message. If there are multiple Allowance ID's, then this should be treated as choice and one baggage item as defined in the referred baggage allowance element can be selected. | Token | Required |
/Response/DataLists/PenaltyList/Penalty/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <TypeCode> | Penalty type information. Examples: Cancellation, Change, NoShow, Upgrade, Other. | Token | Required |
| <PenaltyID> | Unique identifier of this Penalty instance. | Token | Required |
| <DescText> | Description of the applicable penalty. Currently using to describe the JourneyStageCode (Prior to Departure, After Departure or No Show). | String | Optional |
/Response/PricedOffer/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <OwnerCode> | Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. | Token | Required |
| <OfferID> | Carrier assigned ID which uniquely identifies a specific Offer across several messages. Offer ID facilitates the tracking and verification of individually priced offer(s) selected from the shopping response. Only the Offer IDs of the ORA (Offer Responsible Airline) are returned in shopping responses. Offer ID is unique to each individually priced offer in the shopping response even if the offer price is zero. Offer ID may be specific to individual passengers in the offer, and may be associated with a segment or a journey. The set of Offer IDs returned in a response are referenced by a Shopping Response ID. | Token | Required |
/Response/PricedOffer/OfferItem/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <OfferItemID> | Carrier assigned ID which exists uniquely within an Offer. Exceeding 64 characters or use of dashes is not recommended. | Token | Required |
/Response/PricedOffer/OfferItem/ChangeRestrictions/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <AllowedModificationInd> | This flags if this condition allows any modification. If this is set to FALSE then the condition further identified by the other attributes indicates that no Change is allowed. | Boolean | Optional |
| <JourneyStageCode> | Valid Stage Codes are defined in the Journey Stage Type Code ENUM PRIOR TO DEPARTURE NO SHOW AFTER DEPARTURE This will be used either in addition to other BBIE's or individually to qualify a condition. Example: After Departure, No Show, Prior To Departure. |
Token | Optional |
/Response/PricedOffer/OfferItem/CancelRestrictions/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <AllowedModificationInd> | Flags if cancellation is allowed used in conjunction with defined date ranges. | Boolean | Optional |
| <JourneyStageCode> | Valid Stage Codes are defined in the Journey Stage Type Code ENUM PRIOR TO DEPARTURE NO SHOW AFTER DEPARTURE This will be used either in addition to other BBIE's or individually to qualify a condition. Example: After Departure, No Show, Prior To Departure. |
Token | Optional |
/Response/PricedOffer/OfferItem/FareDetail/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <PenaltyRefID> | Reference to a Penalty ID. | Token | Optional |
/Response/PricedOffer/OfferItem/FareDetail/FareComponent/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <PaxSegmentRefID> | Reference to a Pax Segment ID. | Token | Optional |
| <FareTypeCode> | Fare Amount Type Code, ex: ADC (Additional Charge), IT (Tour Inclusive), NOADC (No additional charge). | Token | Optional |
| <FareBasisCode> | Fare basis code. Example: Y26. | Token | Optional |
/Response/PricedOffer/OfferItem/FareDetail/FareComponent/CabinType/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <CabinTypeCode> |
Cabin Type Code as defined by ATSB codeset 9873. For AS NDC:
|
Token | Optional |
| <CabinTypeName> | Name given to a cabin compartment (e.g. Business, First, Economy). | String | Optional |
/Response/PricedOffer/OfferItem/Price/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <BaseAmount (@CurCode)> | Total Base Fare Amount. Example: 200000. | Decimal | Optional |
/Response/PricedOffer/OfferItem/Service/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <ServiceDefintionRefID> | References a service definition ID within this message. | Token | Required |
| <PaxRefID> | Reference to a Passenger ID within this message. | Token | Required |
| <ServiceID> | Uniquely Identifies a Service within the context of one message. | Token | Required |
/Response/PricedOffer/TotalPrice/TaxSummary/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <TotalTaxAmount (@CurCode)> | Total of all applicable tax amounts included in the price. If tax breakdowns are provided, this amount should match the sum of the tax breakdown amounts. | Decimal | Optional |
/Response/PricedOffer/TotalPrice/TaxSummary/Tax/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <AddlTaxCode> | A qualifier to the Tax Code to distinguish taxes/fees/charges with the same tax code but with different business uses. | Token | Optional |
| <Amount (@CurCode)> | Tax Amount. Example 1500 USD. | Decimal | Required |
| <DescText> | Tax short description. Example: $4 per flight segment, per passenger (U.S. domestic segment tax). | String | Optional |
| <TaxCode> | IATA TTBS Tax Code. Example: AY, GB. | Token | Optional |
| <TaxTypeCode> | Tax type code (e.g. Applied or Exempt). | Token | Optional |
/Response/PricedOffer/TotalPrice/TaxSummary/Tax/CollectionPointTax/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <AirportAmount (@CurCode)> | Amount filed by the airport in the currency applicable to the geographical location of the airport. | Decimal | Required |
| <Station/IATA_LocationCode> | IATA 3-letter code defining the city or airport code. | Token | Required |
| <Country/CountryCode> | ISO Country Code 3166-1 alpha-2 (can be extended by bilateral agreement in case of exceptions, e.g. Kosovo). Examples: US, FR. | Token | Optional |
/PayloadAttributes/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <CorrelationID> | Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message. | Token | Required |
| <VersionNumber> | For all IATA versioned messages, the version of the message is indicated by a decimal value. | Decimal | Required |