21.3 IATA_OfferPriceRS

User Guidance - Service Input Parameters

Input Parameters

Type

Optional/Mandatory

Request Object

IATA_OfferPrice_RS

M

XML Example for the following elements

<ns4:PayloadAttributes>
            <ns2:VersionNumber>21.3</ns2:VersionNumber>
 </ns4:PayloadAttributes>

PayloadAttributes

IATA payload standard attributes.

O

VersionNumber

The version of the message 

O

XML Example for the following elements

<ns4:AugmentationPoint>
            <ns5:ItineraryAmountDetailAugPoint>
               <TotalPriceAmount Code="EUR">51.72</TotalPriceAmount>
               <TotalFeeAmount Code="EUR">0.0</TotalFeeAmount>
               <TotalAmount Code="EUR">51.72</TotalAmount>
            </ns5:ItineraryAmountDetailAugPoint>
</ns4:AugmentationPoint>

AugmentationPoint

Augmented Structure.

O

ItineraryAmountDetailAugPoint

Itinerary Amount details

M

TotalPriceAmount

The total Price Amount

M

TotalFeeAmount

The total Fee Amount

M

TotalAmount

TotalAmount of the Price and fee

M

Elements

Details

Mandatory/Optional

Response

Offer Price RS response information.

M

Elements

Details

Mandatory/Optional

DataLists

Data List definition for this message.

O

XML Example for the following elements

<ns2:BaggageAllowanceList>
                <!--1 or more repetitions:-->
                  <ns2:BaggageAllowance>
                     <ns2:BaggageAllowanceID>V1_BAG.1656602568327</ns2:BaggageAllowanceID>
                     <ns2:TypeCode>CHECKED</ns2:TypeCode>
                    <!--1 or more repetitions:-->
                     <ns2:WeightAllowance>
                        <ns2:MaximumWeightMeasure>20</ns2:MaximumWeightMeasure>
                        <ns2:WeightUnitOfMeasurement>LBR</ns2:WeightUnitOfMeasurement>
                     </ns2:WeightAllowance>
                  </ns2:BaggageAllowance>
</ns2:BaggageAllowanceList>

Elements

Details

Mandatory/Optional

BaggageAllowanceList

Baggage allowance data list definition

O

BaggageAllowance

The amount of checked or carry-on luggage the airline will allow per passenger.

M

BaggageAllowanceID

Unique identifier of this Baggage Allowance.

M

TypeCode

Type of Baggage Allowance.

M

WeightAllowance

Baggage weight allowance

O

MaximumWeightMeasure

Maximum weight value and unit of measure. 

O

WeightUnitOfMeasurement

The unit of measurement of weight defined as imperial or metric.

O

<DatedMarketingSegmentList>

XML Example for the following elements

<ns2:DatedMarketingSegmentList>
                <!--1 or more repetitions:-->
                  <ns2:DatedMarketingSegment>
                     <ns2:Arrival>
                        <ns2:AircraftScheduledDateTime>2022-07-15T05:30:00Z</ns2:AircraftScheduledDateTime>
                        <ns2:IATA_LocationCode>FRA</ns2:IATA_LocationCode>
                     </ns2:Arrival>
                     <ns2:CarrierDesigCode>AIRLINE CODE</ns2:CarrierDesigCode>
                     <ns2:DatedMarketingSegmentId>V1_DATEDMARKETINGSEG.1656602568344</ns2:DatedMarketingSegmentId>
                     <ns2:DatedOperatingSegmentRefId>V1_DATEDOPERATINGSEG.1656602568345</ns2:DatedOperatingSegmentRefId>
                     <ns2:Dep>
                        <ns2:AircraftScheduledDateTime>2022-07-15T01:00:00Z</ns2:AircraftScheduledDateTime>
                        <ns2:IATA_LocationCode>AYT</ns2:IATA_LocationCode>
                     </ns2:Dep>
                  </ns2:DatedMarketingSegment>
</ns2:DatedMarketingSegmentList>

Elements

Details

Mandatory/Optional

DatedMarketingSegmentList

A list of dated marketing segments 

O

DatedMarketingSegment

The commercial designation under which a Dated Operating Segment can be booked, either under the operating carrier's designator or that of another carrier 

M

Arrival

Arrival Transport point location

M

AircraftScheduledDateTime

The Scheduled Date and Time of Arrival of the aircraft at the terminal or departure gate at an airport.

O

IATA_LocationCode

IATA 3-letter code defining the city or airport code.

M

CarrierDesigCode

Airline code assigned to a carrier. 

M

DatedMarketingSegmentId

Unique identifier of a dated marketing segment

M

DatedOperatingSegmentRefId

Reference to a unique identifier of a dated operating segment 

M

Dep

Departure Transport point Location

M

<DatedOperatingLegList>

XML Example for the following elements

<ns2:DatedOperatingLegList>
                <!--1 or more repetitions:-->
                  <ns2:DatedOperatingLeg>
                     <ns2:Arrival>
                        <ns2:IATA_LocationCode>FRA</ns2:IATA_LocationCode>
                     </ns2:Arrival>
                     <ns2:CarrierAircraftType>
                        <ns2:CarrierAircraftTypeCode>738</ns2:CarrierAircraftTypeCode>
                     </ns2:CarrierAircraftType>
                     <ns2:DatedOperatingLegID>V1_EQPT.1656602568347</ns2:DatedOperatingLegID>
                     <ns2:Dep>
                        <ns2:IATA_LocationCode>AYT</ns2:IATA_LocationCode>
                     </ns2:Dep>
                     <ns2:IATA_AircraftType>
                        <ns2:IATA_AircraftTypeCode>800</ns2:IATA_AircraftTypeCode>
                     </ns2:IATA_AircraftType>
                  </ns2:DatedOperatingLeg>
</ns2:DatedOperatingLegList>

Elements

Details

Mandatory/Optional

DatedOperatingLegList

A list of dated operating legs 

O

DatedOperatingLeg

The nonstop operation of a transport vehicle between the departure station and the arrival station

M

Arrival

Arrival transport point location

M

IATA_LocationCode

IATA 3-letter code defining the city or airport code.

M

CarrierAircraftType

Carrier defined internal grouping of aircrafts with the same form, function and specification.

O

CarrierAircraftTypeCode

Internal code used by an carrier to identify the type of aircraft.

O

DatedOperatingLegID

Uniquely identifies a leg

M

Dep

Departure transport point location

M

IATA_AircraftType

Grouping of aircrafts with the same form, function and specification, currently flown, or soon to be flown

O

IATA_AircraftTypeCode

Code assigned to an aircraft type in IATA SSIM.

O

<DatedOperatingSegmentList>

XML Example for the following elements

<ns2:DatedOperatingSegmentList>
                <!--1 or more repetitions:-->
                  <ns2:DatedOperatingSegment>
                     <ns2:CarrierDesigCode>AIRLINE CODE</ns2:CarrierDesigCode>
                    <!--1 or more repetitions:-->
                     <ns2:DatedOperatingLegRefID>V1_EQPT.1656602568347</ns2:DatedOperatingLegRefID>
                     <ns2:DatedOperatingSegmentId>V1_DATEDOPERATINGSEG.1656602568345</ns2:DatedOperatingSegmentId>
                     <ns2:Duration>P0Y0M0DT0H0M0.000S</ns2:Duration>
                  </ns2:DatedOperatingSegment>
  </ns2:DatedOperatingSegmentList>

Elements

Details

Mandatory/Optional

DatedOperatingSegmentList

A list of dated operating segments 

O

DatedOperatingSegment

An operation between board point and any subsequent off point within the same flight designator. Could be one or more legs

M

CarrierDesigCode

Airline code assigned to a carrier

M

DatedOperatingLegRefID

Uniquely identifies a leg 

O

DatedOperatingSegmentId

Unique identifier of a dated operating segment

M

Duration

Total segment time including the combined air time and connection times of any legs

O

<OriginDestList>

XML Example for the following elements

<ns2:OriginDestList>
                  <!--1 or more repetitions:-->
                  <ns2:OriginDest>
                     <ns2:DestCode>FRA</ns2:DestCode>
                     <ns2:OriginCode>AYT</ns2:OriginCode>
                     <ns2:OriginDestID>V1_OD.1656602568326</ns2:OriginDestID>
                    <!--1 or more repetitions:-->
                     <ns2:PaxJourneyRefID>V1_FL.1</ns2:PaxJourneyRefID>
                  </ns2:OriginDest>
</ns2:OriginDestList>

Elements

Details

Mandatory/Optional

OriginDestList

Origin Destination data list definition.

O

OriginDest

The Origin and Destination airport/city pair which confines a passenger journey or an aircraft flight.

M

DestCode

IATA defined code identifying Destination city or station.

M

OriginCode

IATA defined code identifying Origin city or station.

M

OriginDestID

Uniquely identifies an Origin Destination

M

PaxJourneyRefID

Uniquely identifies a Passenger Journey

O

<PaxJourneyList>

XML Example for the following elements

<ns2:PaxJourneyList>
                <!--1 or more repetitions:-->
                  <ns2:PaxJourney>
                     <ns2:PaxJourneyID>V1_FL.1</ns2:PaxJourneyID>
                    <!--1 or more repetitions:-->
                     <ns2:PaxSegmentRefID>V1_SEG.1656447765631</ns2:PaxSegmentRefID>
                  </ns2:PaxJourney>
</ns2:PaxJourneyList>

Elements

Details

Mandatory/Optional

PaxJourneyList

Journey data list definition.

O

PaxJourney

A collection of segments which satisfies transportation of a passenger for a given origin and destination.

M

PaxJourneyID

Uniquely identifies a Passenger Journey.

M

PaxSegmentRefID

Reference to a Passenger Segment ID

M

<PaxList>

XML Example for the following elements

<ns2:PaxList>
                <!--1 or more repetitions:-->
                  <ns2:Pax>
                     <ns2:PaxID>V1_PAX.1656447765616</ns2:PaxID>
                     <ns2:PTC>ADT</ns2:PTC>
                  </ns2:Pax>
 </ns2:PaxList>

Elements

Details

Mandatory/Optional

PaxList

Passenger data list definition

O

Pax

Any person except members of the crew carried or to be carried with the consent of the carrie

M

PaxID

Uniquely identifies a Passenger 

M

PTC

Type code applying to the Passenger

O

<PaxSegmentList>

XML Example for the following elements

<ns2:PaxSegmentList>
                <!--1 or more repetitions:-->
                  <ns2:PaxSegment>
                     <ns2:DatedMarketingSegmentRefId>V1_DATEDMARKETINGSEG.1656602568344</ns2:DatedMarketingSegmentRefId>
                     <ns2:MarketingCarrierRBD_Code>B</ns2:MarketingCarrierRBD_Code>
                     <ns2:PaxSegmentID>V1_SEG.1656447765631</ns2:PaxSegmentID>
                  </ns2:PaxSegment>
</ns2:PaxSegmentList>

Elements

Details

Mandatory/Optional

PaxSegmentList

Segment data list definition.

O

PaxSegment

Transportation of a passenger on a Dated Operating Segment. - [Dated Marketing Segment] (All identifying fields) - [Order] Order ID - [Individual]

M

DatedMarketingSegmentRefId

A reference to a unique identifier of a dated marketing segment 

M

MarketingCarrierRBD_Code

Code used to identify a particular RBD 

O

PaxSegmentID

Uniquely identifies a Passenger Segment

M

 <PricedOffer>

Elements

Details

Mandatory/Optional

PricedOffer

A proposal to sell a specific set of products or Services under specific conditions, for a certain price. Can be the response to a shopping request. Can be a regular Offer or an A La Carte Offer. A La Carte Offer is defined as a container for A La Carte Offer Items. 

M

OfferExpirationTimeLimitDateTime

The length of time an offer will persist in an airline's offer management system for use in subsequent transactions.

O

OfferID

Carrier assigned ID which uniquely identifies a specific Offer across several messages. 

M

OwnerCode

Airline code assigned to a carrier. 

M

<OfferItem>

Elements

Details

Mandatory/Optional

OfferItem

A priced grouping of one or more services within an Offer.

M

OfferItemID

Carrier assigned ID which exists uniquely within an Offer. 

M

<FareDetail>

Elements

Details

Mandatory/Optional

FareDetail

The amount charged by the carrier for the carriage of a passenger and his allowable free baggage.

O

<FareComponent>

XML Example for the following elements

<!--1 or more repetitions:-->
<ns2:FareComponent>
                        <ns2:CabinType>
                           <ns2:CabinTypeCode>3</ns2:CabinTypeCode>
                           <ns2:CabinTypeName>ECONOMY</ns2:CabinTypeName>
                        </ns2:CabinType>
                        <ns2:FareBasisCode>TESTOB</ns2:FareBasisCode>
                        <!--1 or more repetitions:-->
                        <ns2:FareRule>
                           <ns2:TicketlessInd>false</ns2:TicketlessInd>
                        </ns2:FareRule>
                        <ns2:FareTypeCode>SUNECO</ns2:FareTypeCode>
                        <!--1 or more repetitions:-->
                        <ns2:PaxSegmentRefID>V1_SEG.1656447765631</ns2:PaxSegmentRefID>
                        <ns2:Price>
                           <ns2:BaseAmount CurCode="EUR">29.77</ns2:BaseAmount>
                           <ns2:Discount>
                              <ns2:DiscountAmount CurCode="EUR">4.0</ns2:DiscountAmount>
                           </ns2:Discount>
                        <!--1 or more repetitions:-->
                           <ns2:Surcharge>
                            <!--1 or more repetitions:-->
                              <ns2:Breakdown>
                                 <ns2:Amount CurCode="EUR">15.0</ns2:Amount>
                                 <ns2:DescText>Ticket Sales Charge</ns2:DescText>
                                 <ns2:DesigText>TSC</ns2:DesigText>
                              </ns2:Breakdown>
                              <ns2:TotalAmount CurCode="EUR">15.0</ns2:TotalAmount>
                           </ns2:Surcharge>
                        <!--1 or more repetitions:-->
                           <ns2:TaxSummary>
                            <!--1 or more repetitions:-->
                              <ns2:Tax>
                                 <ns2:AddlTaxCode>VQ</ns2:AddlTaxCode>
                                 <ns2:Amount CurCode="EUR">7.95</ns2:Amount>
                                 <ns2:Country>
                                    <ns2:CountryCode>TR</ns2:CountryCode>
                                 </ns2:Country>
                                 <ns2:TaxCode>VQ</ns2:TaxCode>
                              </ns2:Tax>
                              <ns2:Tax>
                                 <ns2:AddlTaxCode>M6</ns2:AddlTaxCode>
                                 <ns2:Amount CurCode="EUR">3.0</ns2:Amount>
                                 <ns2:Country>
                                    <ns2:CountryCode>TR</ns2:CountryCode>
                                 </ns2:Country>
                                 <ns2:TaxCode>M6</ns2:TaxCode>
                              </ns2:Tax>
                              <ns2:TotalTaxAmount CurCode="EUR">10.95</ns2:TotalTaxAmount>
                           </ns2:TaxSummary>
                           <ns2:TotalAmount CurCode="EUR">51.72</ns2:TotalAmount>
                        </ns2:Price>
                        <ns2:RBD>
                           <ns2:RBD_Code>B</ns2:RBD_Code>
                        </ns2:RBD>
</ns2:FareComponent>                  

Elements

Details

Mandatory/Optional

FareComponent

A portion of an itinerary between two consecutive fare construction points. 

O

CabinType

Type of compartment of an aircraft, offering specific services

O

CabinTypeCode

Cabin Type Code 

O

CabinTypeName

Name given to a cabin compartment 

O

FareBasisCode

Fare basis code.

O

FareRule

Special purchasing rules and restrictions used to differentiate fare levels from one another.

O

TicketlessInd

When TRUE, the Fare can be purchased without issuing a ticket.

O

FareTypeCode

Fare Amount Type Code

O

PaxSegmentRefID

Reference to a Pax Segment ID.

O

Price

The amount of money expected, required, or given in payment for something.

O

BaseAmount

Total Base Fare Amount. 

O

Discount

Deduction from the price amount, made in advance of its payment.

O

DiscountAmount

Discount amount applied to a price.

O

Surcharge

Amount added on to a usual charge for a specific product, purpose, or service.

O

Breakdown

Amount added on to a charge for a specific product, purpose, or service.

O

Amount

Fee Amount

M

DescText

Fee/ surcharge Description

O

DesigText

Fee designator code.

O

TotalAmount

Summary of all fee amounts.

O

TaxSummary

Tax summary information.

O

Tax

A compulsory contribution to state revenue, levied by the government on workers' income and business profits or added to the cost of some goods, services, and transactions.

O

AddlTaxCode

A qualifier to the Tax Code to distinguish taxes/fees/charges with the same tax code but with different business uses.

O

Amount

Tax amount

O

Country

Country

O

CountryCode

ISO Country Code

O

TaxCode

IATA TTBS Tax Code.

O

TotalTaxAmount

Total of all applicable tax amounts included in the price.

O

TotalAmount

Total monetary price amount, including all tax, surcharge, and fee amounts.

O

RBD

Reservation Booking Designator.

O

RBD_Code

Code used to identify a particular RBD

M

<FarePriceType>

XML Example for the following elements

<!--1 or more repetitions:-->
<ns2:FarePriceType>
                        <ns2:FarePriceTypeCode>Net</ns2:FarePriceTypeCode>
                        <ns2:Price>
                           <ns2:BaseAmount CurCode="EUR">29.77</ns2:BaseAmount>
                           <ns2:Discount>
                              <ns2:DiscountAmount CurCode="EUR">4.0</ns2:DiscountAmount>
                           </ns2:Discount>
                            <!--1 or more repetitions:-->
                           <ns2:Surcharge>
                              <ns2:TotalAmount CurCode="EUR">15.0</ns2:TotalAmount>
                           </ns2:Surcharge>
                        <!--1 or more repetitions:-->
                           <ns2:TaxSummary>
                              <ns2:TotalTaxAmount CurCode="EUR">10.95</ns2:TotalTaxAmount>
                           </ns2:TaxSummary>
                           <ns2:TotalAmount CurCode="EUR">51.72</ns2:TotalAmount>
                        </ns2:Price>
</ns2:FarePriceType>                        

Elements

Details

Mandatory/Optional

FarePriceType

An additional specified fare pricing such as 'Net' and 'Filed'.

O

FarePriceTypeCode

Indicates if the fare price provided is a filed amount, net amount, or a sell amount.

M

Price

The amount of money expected, required, or given in payment

M

BaseAmount

Total Base Fare

O

Discount

Deduction from the price amount, made in advance of its payment.

O

DiscountAmount

Discount amount applied to a price.

O

Surcharge

Amount added on to a usual charge for a specific product,

O

TotalAmount

Summary of all fee amounts.

O

TaxSummary

Tax summary information.

O

TotalTaxAmount

Total of all applicable tax amounts included in the price.

O

TotalAmount

Total monetary price amount, including all tax, surcharge, and fee amounts.

O

<Price>

XML Example for the following elements

<ns2:Price>
                     <ns2:BaseAmount CurCode="EUR">51.72</ns2:BaseAmount>
                     <ns2:TotalAmount CurCode="EUR">51.72</ns2:TotalAmount>
</ns2:Price>

Elements

Details

Mandatory/Optional

Price

The amount of money expected, required, or given in payment for something.

O

BaseAmount

Total Base Fare 

O

TotalAmount

Total monetary price amount, including all tax, surcharge, and fee amounts.

O

<Service>

XML Example for the following elements

<!--1 or more repetitions:-->
<ns2:Service>
                     <ns2:OfferServiceAssociation>
                        <ns2:PaxJourneyRef>
                            <!--1 or more repetitions:-->
                           <ns2:PaxJourneyRefID>V1_FL.1</ns2:PaxJourneyRefID>
                        </ns2:PaxJourneyRef>
                     </ns2:OfferServiceAssociation>
                        <!--1 or more repetitions:-->
                     <ns2:PaxRefID>V1_PAX.1656447765616</ns2:PaxRefID>
                     <ns2:ServiceID>V1_SRVC.1656602568346</ns2:ServiceID>
 </ns2:Service>

Elements

Details

Mandatory/Optional

Service

Offered Service is the instance of a specific flight or Service Definition as it has been offered 

M

OfferServiceAssociation

Offer Service Association

M

PaxJourneyRef

A collection of segments which satisfies transportation of a passenger for a given origin and destination. 

M

PaxJourneyRefID

Uniquely identifies a Passenger Journey 

M

PaxRefID

Reference to a Passenger ID 

M

ServiceID

Uniquely Identifies a Service 

M

<PTC_OfferParameters>

XML Example for the following elements

<!--1 or more repetitions:-->
<ns2:PTC_OfferParameters>
                  <ns2:PricedPaxNumber>1</ns2:PricedPaxNumber>
                  <ns2:PTC_PricedCode>ADT</ns2:PTC_PricedCode>
                  <ns2:PTC_RequestedCode>ADT</ns2:PTC_RequestedCode>
                  <ns2:RequestedPaxNumber>1</ns2:RequestedPaxNumber>
</ns2:PTC_OfferParameters>

Elements

Details

Mandatory/Optional

PTC_OfferParameters

Passenger Type summary information for an offer.

O

PricedPaxNumber

umber of Passenger(s) for associated passenger type. 

O

PTC_PricedCode

Actual passenger type code used for pricing.

O

PTC_RequestedCode

Requested passenger type code for pricing. 

O

RequestedPaxNumber

Number of Passenger(s) for associated passenger type.

O