21.3 IATA_AirShoppingRS

User Guidance - Service Input Parameters

Input Parameters

Type

Optional/Mandatory

Request Object

IATA_AirShoppingRS

M

 

  • <Response>

  • <PayloadAttributes>

 

<PayloadAttributes>

<PayloadAttributes>

XML Example for the following elements

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

Elements

Details

Mandatory/Optional

PayloadAttributes

IATA payload standard attributes.

O

VersionNumber

The version of the message 

O

<Response>

<Response>

Elements

Details

Mandatory/Optional

Response

AirShopping response information.

M

<DataLists>

Elements

Details

Mandatory/Optional

DataLists

Data List definition for this message.

O

<DatedMarketingSegmentList>

Elements

Details

Mandatory/Optional

DatedMarketingSegmentList

A list of dated marketing segments used in the contained message.

O

<DatedMarketingSegment>

XML Example for the following elements

<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.1656447765628</ns2:DatedMarketingSegmentId>
                     <ns2:DatedOperatingSegmentRefId>V1_DATEDOPERATINGSEG.1656447765629</ns2:DatedOperatingSegmentRefId>
                     <ns2:Dep>
                        <ns2:AircraftScheduledDateTime>2022-07-15T01:00:00Z</ns2:AircraftScheduledDateTime>
                        <ns2:IATA_LocationCode>AYT</ns2:IATA_LocationCode>
                     </ns2:Dep>
                     <ns2:MarketingCarrierFlightNumberText>8911</ns2:MarketingCarrierFlightNumberText>
                     <ns2:OperationalSuffixText>*</ns2:OperationalSuffixText>
</ns2:DatedMarketingSegment>

Elements

Details

Mandatory/Optional

DatedMarketingSegment

The commercial designation under which a Dated Operating Segment can be booked.

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

MarketingCarrierFlightNumberText

The numerical designation of a flight as it is marketed by a carrier.

M

OperationalSuffixText

Used to distinguish two flights having the same flight number and departing from their respective Origin Stations on the same date.

O

<DatedOperatingLegList>

Elements

Details

Mandatory/Optional

DatedOperatingLegList

A list of dated operating legs 

O

<DatedOperatingLeg>

XML Example for the following elements

<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.1656447765626</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>

Elements

Details

Mandatory/Optional

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>

Elements

Details

Mandatory/Optional

DatedOperatingSegmentList

A list of dated operating segments

O

<DatedOperatingSegment>

XML Example for the following elements

<ns2:DatedOperatingSegment>
                     <ns2:DatedOperatingLegRefID>V1_EQPT.1656447765626</ns2:DatedOperatingLegRefID>
                     <ns2:DatedOperatingSegmentId>V1_DATEDOPERATINGSEG.1656447765629</ns2:DatedOperatingSegmentId>
                     <ns2:Duration>PT5H30M0.000S</ns2:Duration>
                  </ns2:DatedOperatingSegment>

Elements

Details

Mandatory/Optional

DatedOperatingSegment

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

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>

Elements

Details

Mandatory/Optional

OriginDestList

Origin Destination data list definition.

O

<OriginDest>

XML Example for the following elements

<ns2:OriginDest>
                     <ns2:DestCode>FRA</ns2:DestCode>
                     <ns2:OriginCode>AYT</ns2:OriginCode>
                     <ns2:OriginDestID>V1_OD.1656447765617</ns2:OriginDestID>
                     <ns2:PaxJourneyRefID>V1_FL.1656447765630</ns2:PaxJourneyRefID>     
</ns2:OriginDest>

Elements

Details

Mandatory/Optional

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>

Elements

Details

Mandatory/Optional

PaxJourneyList

Journey data list definition

O

<PaxJourney>

XML Example for the following elements

<ns2:PaxJourney>
                     <ns2:Duration>P0Y0M0DT5H30M0.000S</ns2:Duration>
                     <ns2:PaxJourneyID>V1_FL.1656447765630</ns2:PaxJourneyID>
                     <ns2:PaxSegmentRefID>V1_SEG.1656447765631</ns2:PaxSegmentRefID>
 </ns2:PaxJourney>

Elements

Details

Mandatory/Optional

PaxJourney

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

M

Duration

Total journey time including the combined air time and connection times.

O

PaxJourneyID

Uniquely identifies a Passenger Journey.

M

PaxSegmentRefID

Reference to a Passenger Segment ID

M

<PaxList>

Elements

Details

Mandatory/Optional

PaxList

Passenger data list definition.

O

<Pax>

XML Example for the following elements

<ns2:Pax>
                     <ns2:PaxID>V1_PAX.1656447765616</ns2:PaxID>
                     <ns2:PTC>ADT</ns2:PTC>
</ns2:Pax>

Elements

Details

Mandatory/Optional

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>

Elements

Details

Mandatory/Optional

PaxSegmentList

Segment data list definition.

O

<PaxSegment>

XML Example for the following elements

<ns2:PaxSegment>
                     <ns2:CabinTypeAssociationChoice>
                        <ns2:SegmentCabinType>
                           <ns2:CabinTypeCode>3</ns2:CabinTypeCode>
                           <ns2:CabinTypeName>ECONOMY</ns2:CabinTypeName>
                        </ns2:SegmentCabinType>
                     </ns2:CabinTypeAssociationChoice>
                     <ns2:DatedMarketingSegmentRefId>V1_DATEDMARKETINGSEG.1656447765628</ns2:DatedMarketingSegmentRefId>
                     <ns2:MarketingCarrierRBD_Code>Y</ns2:MarketingCarrierRBD_Code>
                     <ns2:PaxSegmentID>V1_SEG.1656447765631</ns2:PaxSegmentID>
</ns2:PaxSegment>

Elements

Details

Mandatory/Optional

PaxSegment

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

M

CabinTypeAssociationChoice

A choice of Cabin Type Association to leg(s) or a segment

O

SegmentCabinType

Type of compartment of an aircraft, offering specific services 

M

CabinTypeCode

Cabin Type Code

O

CabinTypeName

Name given to a cabin compartment

O

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

 <PriceClassList>

Elements

Details

Mandatory/Optional

PriceClassList

Price Class data list definition.

O

<PriceClass>

XML Example for the following elements

<ns2:PriceClass>
                     <ns2:CabinType>
                        <ns2:CabinTypeCode>Y</ns2:CabinTypeCode>
                        <ns2:CabinTypeName>ECONOMY</ns2:CabinTypeName>
                     </ns2:CabinType>
                     <ns2:Code>B</ns2:Code>
                     <ns2:Desc>
                        <ns2:DescText>Seats Left-189</ns2:DescText>
                     </ns2:Desc>
                     <ns2:Desc>
                        <ns2:DescText>FareLevel-ST</ns2:DescText>
                     </ns2:Desc>
                     <ns2:Desc>
                        <ns2:DescText>FareId-349871</ns2:DescText>
                     </ns2:Desc>
                     <ns2:FareBasisCode>TESTOB</ns2:FareBasisCode>
                     <ns2:Name>SUNECO</ns2:Name>
                     <ns2:PriceClassID>V1_PC.1656447765624</ns2:PriceClassID>
 </ns2:PriceClass>

Elements

Details

Mandatory/Optional

PriceClass

A price point within a particular Cabin Type

M

CabinType

Type of compartment of an aircraft, offering specific services 

O

CabinTypeCode

Cabin Type Code

O

CabinTypeName

Name given to a cabin compartment

O

Code

Price class code

O

Desc

An account or representation of the certain or major aspects, characteristics, or features of a person, object, or event

O

DescText

Description text value

O

FareBasisCode

Fare basis code

O

Name

Price class name

M

PriceClassID

Uniquely Identifies a Price Class

M

 <ns2:OffersGroup>

Elements

Details

Mandatory/Optional

OffersGroup

Offers grouped by Carrier

M

<ns2:CarrierOffers>

Elements

Details

Mandatory/Optional

CarrierOffers

Carrier Offers grouping of Offers returned by a single ORA.

M

<Offer>

XML Example for the following elements

<ns2:Offer>
                     <ns2:OfferID>OF1-eJw1jDsOgCAQBU.kYfktlGCgEyJgItW7-y3EwpliuiFrrNbMK4oQ5sgtgKxhp60TH3guOE.EkfqoEeluSEct9ZxQ2jsm9IEIgvQ7M8SybAI10zf675IxXwMRHFA_</ns2:OfferID>
                     <ns2:OfferItem>
                        <ns2:FareDetail>
                           <ns2:FareComponent>
                              <ns2:FareBasisCode>TESTOB</ns2:FareBasisCode>
                              <ns2:FareRule>
                                 <ns2:TicketlessInd>false</ns2:TicketlessInd>
                              </ns2:FareRule>
                              <ns2:FareTypeCode>SUNECO</ns2:FareTypeCode>
                              <ns2:PaxSegmentRefID>V1_SEG.1656447765631</ns2:PaxSegmentRefID>
                              <ns2:Price>
                                 <ns2:BaseAmount CurCode="EUR">29.77</ns2:BaseAmount>
                                 <ns2:CurConversion>
                                    <ns2:Amount CurCode="EUR">29.77</ns2:Amount>
                                    <ns2:ConversionRate>1</ns2:ConversionRate>
                                    <ns2:LocalAmount CurCode="EUR">25.77</ns2:LocalAmount>
                                 </ns2:CurConversion>
                                 <ns2:Discount>
    ��                               <ns2:DiscountAmount CurCode="EUR">4.0</ns2:DiscountAmount>
                                 </ns2:Discount>
                                 <ns2:Surcharge>
                                    <ns2:Breakdown>
                                       <ns2:Amount CurCode="EUR">15.0</ns2:Amount>
                                       <ns2:DesigText>TSC</ns2:DesigText>
                                    </ns2:Breakdown>
                                    <ns2:TotalAmount CurCode="EUR">15.0</ns2:TotalAmount>
                                 </ns2:Surcharge>
                                 <ns2:TaxSummary>
                                    <ns2:Tax>
                                       <ns2:AddlTaxCode>M6</ns2:AddlTaxCode>
                                       <ns2:Amount CurCode="EUR">3.0</ns2:Amount>
                                       <ns2:TaxCode>M6</ns2:TaxCode>
                                       <ns2:TaxName>International Flights Security Charge</ns2:TaxName>
                                    </ns2:Tax>
                                    <ns2:Tax>
                                       <ns2:AddlTaxCode>VQ</ns2:AddlTaxCode>
                                       <ns2:Amount CurCode="EUR">7.95</ns2:Amount>
                                       <ns2:TaxCode>VQ</ns2:TaxCode>
                                       <ns2:TaxName>Airport Service Tax</ns2:TaxName>
                                    </ns2:Tax>
                                    <ns2:TotalTaxAmount CurCode="EUR">10.95</ns2:TotalTaxAmount>
                                 </ns2:TaxSummary>
                                 <ns2:TotalAmount CurCode="EUR">25.77</ns2:TotalAmount>
                              </ns2:Price>
                              <ns2:PriceClassRefID>V1_PC.1656447765624</ns2:PriceClassRefID>
                              <ns2:RBD>
                                 <ns2:RBD_Code>B</ns2:RBD_Code>
                              </ns2:RBD>
                           </ns2:FareComponent>
                           <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>
                                 <ns2:Surcharge>
                                    <ns2:TotalAmount CurCode="EUR">15.0</ns2:TotalAmount>
                                 </ns2:Surcharge>
                                 <ns2:TaxSummary>
                                    <ns2:TotalTaxAmount CurCode="EUR">10.95</ns2:TotalTaxAmount>
                                 </ns2:TaxSummary>
                                 <ns2:TotalAmount CurCode="EUR">25.77</ns2:TotalAmount>
                              </ns2:Price>
                           </ns2:FarePriceType>
                           <ns2:PaxRefID>V1_PAX.1656447765616</ns2:PaxRefID>
                        </ns2:FareDetail>
                        <ns2:OfferItemID>OF1_OI1-eJwzNDM1MzExNwdSxoa6-m6Gyv6ehvGGCFEjcwCIUwee</ns2:OfferItemID>
                        <ns2:Price>
                           <ns2:BaseAmount CurCode="EUR">29.77</ns2:BaseAmount>
                           <ns2:Discount>
                              <ns2:DiscountAmount CurCode="EUR">4.0</ns2:DiscountAmount>
                           </ns2:Discount>
                           <ns2:TotalAmount CurCode="EUR">25.77</ns2:TotalAmount>
                        </ns2:Price>
                        <ns2:Service>
                           <ns2:OfferServiceAssociation>
                              <ns2:PaxJourneyRef>
                                 <ns2:PaxJourneyRefID>V1_FL.1656447765630</ns2:PaxJourneyRefID>
                              </ns2:PaxJourneyRef>
                           </ns2:OfferServiceAssociation>
                           <ns2:PaxRefID>V1_PAX.1656447765616</ns2:PaxRefID>
                           <ns2:ServiceID>V1_SRVC.1656447765606</ns2:ServiceID>
                        </ns2:Service>
                     </ns2:OfferItem>
                     <ns2:OwnerCode>AIRLINE CODE</ns2:OwnerCode>
                     <ns2:ValidatingCarrierCode>AIRLINE CODE</ns2:ValidatingCarrierCode>
                  </ns2:Offer>

Elements

Details

Mandatory/Optional

Offer

A proposal to sell a specific set of products or Services under specific conditions, for a certain price. 

O

OfferID

Carrier assigned ID which uniquely identifies a specific Offer

M

OwnerCode

Airline code assigned to a carrier. 

M

ValidatingCarrierCode

Airline code assigned to a carrier.

O

OfferItem

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

M

FareDetail

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

O

FareComponent

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

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

CurConversion

The result of converting one currency into another currency. 

O

Amount

Amount and currency specified in the converted currency. 

M

ConversionRate

Defines the rate used to convert the local currency into the billing currency.

M

LocalAmount

Amount and currency as specified by the local Country.

M

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

DesigText

Fee designator code. Example: USC

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.

M

TaxCode

IATA TTBS Tax Code.

O

TaxName

The name given to describe the tax.

O

TotalAmount

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

O

PriceClassRefID

A price point within a particular Cabin Type

O

RBD

Reservation Booking Designator. A categorization used to facilitate access to inventory, application of filed fares, and to identify cabin entitlement. Identified using a single alpha character.

O

RBD_Code

Code used to identify a particular RBD

M

FarePriceType

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

O

FarePriceTypeCode

Indicates if the fare price provided is a filed amount,

M

Price

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

M

BaseAmount

Total Base Fare Amount. 

O

Discount

Deduction from the price amount, 

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

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, 

O

PaxRefID

Reference to a Passenger ID

O

OfferItemID

Carrier assigned ID which exists uniquely within an Offer. 

M

Price

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

M

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

TotalAmount

Total monetary price amount, 

O

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

 

 

 

Â