IATA_AirShoppingRS
- Sreejith S R (Unlicensed)
User Guidance - Service Response Parameters | ||
Input Parameter | Type | Optional/Mandatory |
Response Object | IATA_AirShoppingRS | M |
<MessageDoc>
<PayloadAttributes>
<Response>
<AirShoppingProcessing>
<DataLists>
<OriginDestList>
<PaxJourneyList>
<PaxList>
<PaxSegmentList>
<OffersGroup>
<CarrierOffers>
<PriceCalendar>
<MessageDoc> | ||
XML Example for the following elements
<ns11:MessageDoc> <ns11:Name>NDC</ns11:Name> <ns11:RefVersionNumber>19.2</ns11:RefVersionNumber> </ns11:MessageDoc> | ||
Elements | Details | Optional/Mandatory |
<MessageDoc> | Message document information including document name and version number. | O |
<Name> | Should always be NDC | O |
<RefVersionNumber> | Should be NDC version | O |
<OffersGroup> | ||
XML Example for the following elements <ns11:OffersGroup> | ||
Elements | Details | Optional/Mandatory |
<OffersGroup> | Offers grouped by Carrier. | M |
<CarrierOffers> | This returns each offer with the total offer price, total price per passenger type, base fare and tax per passenger type along with the price class and flights applicable to the offer. This also returns the calendar offers if specified in the request. | M |
<Offer> | List of offers for the requested date. Each offer will be ordered by the lowest price first | O |
<OfferID> | A unique offer id Example: "V1_OFFER.1560995803086" | M |
<OwnerCode> | will be always set to "AIRLINECODE" | M |
<OfferItem> | This will be repeated to return the price per passenger type. Example: If you have 2 x ADT, 2 x CHD and 2 x INF then this should be repeated three times. One for ADT, one for CHD and one for INF | M |
OfferItemID | A unique offer item id Example: " V1_OFFERITEM.1560995803086" | M |
<Price> | Total price for all the passengers of this passenger type | M |
<TotalAmount> | Display Fare. Display Fare = Base Fare, when tax and surcharge are not inclusive. Base Fare or Base Amount is the actual fare defined in the system. | O |
<BaseAmount> | Total Base Amount in Point Of Origin currency Base Fare or Base Amount is the actual fare defined in the system. | O |
<Service> | This returns the service this OfferItem is entitled to. It will repeat per Origin Destination | M |
<ServiceID> | A unique service id Example: V1_SRVC.1560995803074 | M |
<PaxRefID> | This returns the passenger references for all the passengers for who the service applies to. Each reference is displayed by another tag of PaxRefID. Example: <ns11:PaxRefID>V1_PAX.1</ns11:PaxRefID> Each passenger reference should be detailed in PaxList under DataLists | M |
<ServiceAssociations> | References to the details of this Service which includes Flight Informations. | M |
<PaxJourneyRefID> | This returns all the flight references which are part of this service. Each reference is displayed by another tag of PaxJourneyRefID. Example: <ns11:PaxJourneyRefID>V1_FL.1390283009428</ns11:PaxJourneyRefID> <ns11:PaxJourneyRefID>V1_FL.1390283009439</ns11:PaxJourneyRefID> Each Flight reference should be detailed in PaxJourneyList under DataLists | M |
<FareDetail> | This returns the price detail applicable to flights & passenger type respectively applicable to this OfferItem along with the fare component. | O |
<PaxRefID> | Applicable passenger references. Each reference is displayed by another tag of PaxRefID. Example: <ns11:PaxRefID>V1_PAX.1</ns11:PaxRefID> Each passenger reference should be detailed in PaxList under DataLists | O |
<FarePriceType> | Price returned per passenger type with the total price, fare and total tax | M |
<FarePriceTypeCode> | Indicates if the fare price provided is a sell amount. | M |
<Price> | The amount of money expected, required, or given in payment for something | M |
<TotalAmount> | Total Applied Fare per passenger type for the offer | O |
<BaseAmount> | Total Base fare per passenger type for the itinerary | O |
CurCode (Attribute) | Currency Code Example: GBP | O |
<Discount> | Deduction from the price amount. | O |
<DiscountAmount> | Total Discount amount applied to a price. | O |
<Surcharges> | Total surcharge per passenger type | O |
<TotalAmount> | Summary of all fee amounts. | O |
CurCode (Attribute) | Currency Code Example: GBP | O |
<TaxSummary> | Total tax per passenger type | O |
<TotalTaxAmount> | 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. | O |
CurCode (Attribute) | Currency Code Example: GBP | O |
<FareComponent> | This will repeat for each Origin and Destination. This will have Total Amount, Base Amount, surcharges & its breakdown, taxes & its breakdown. | O |
<FareBasisCode> | This will have fare basis code. | O |
<FareRule> | Special purchasing rules and restrictions used to differentiate fare levels from one another. | O |
<Remark> | Additional, supplementary information about the service . | O |
<TicketlessInd> | When TRUE, the Fare can be purchased without issuing a ticket. | O |
<PaxSegmentRefID> | This returns references to all the segments applicable | O |
<Price> | The amount of money expected, required, or given in payment for something. | O |
<BaseAmount> | Base Fare Amount in point of origin currency | O |
<Discount> | Deduction from the price amount | |
<DiscountAmount> | Discount amount applied to a price. | |
<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 | O |
<DesigText> | Fee designator code | O |
<TotalAmount> | Summary of all fee amounts. | O |
<TaxSummary> | Tax summary information. | O |
<Tax> | Tax breakdown details | O |
<AddlTaxCode> | iFlyRes Tax Code | O |
<Amount> | Tax Amount | O |
<TaxCode> | IATA tax code | O |
<TaxName> | The name given to describe the tax | O |
<TotalTaxAmount> | 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. | O |
<RBD> | Reservation Booking Designator. A categorization used to facilitate access to inventory, application of filed fares, and to identify cabin entitlement. | O |
<RBD_Code> | Code used to identify a particular RBD (e.g. P, J, W, M, etc.). | O |
<ValidatingCarrierCode> | Airline code assigned to a carrier. IATA-defined 2-character code. | O |
<PricedCalendar> | Calendar based Offer Price | O |
<PriceCalendarDate> | Price calendar date | M |
<TotalPriceAmount> | Applied Fare. The total price for all Travelers associated with this offer. | O |
<DataLists> | ||
<PaxList> | ||
XML Example for the following elements
<ns11:PaxList> <ns11:Pax> <ns11:PaxID>V1_PAX.1</ns11:PaxID> <ns11:PTC>ADT</ns11:PTC> </ns11:Pax> <ns11:Pax> <ns11:PaxID>V1_PAX.2</ns11:PaxID> <ns11:PTC>CHD</ns11:PTC> </ns11:Pax> <ns11:Pax> <ns11:PaxID>V1_PAX.3</ns11:PaxID> <ns11:PTC>INF</ns11:PTC> </ns11:Pax> </ns11:PaxList> | ||
Elements | Details | Optional/Mandatory |
<PaxList> | List all the passengers with details as received in IATA_AirShoppingRQ | O |
Pax | Any person except members of the crew carried or to be carried with the consent of the carrier, on board of an aircraft. Holds the attributes specific to a one booking, from shopping to fulfillment. | M |
PaxID | Uniquely identifies a Passenger. | M |
PTC | Type code applying to the Passenger which typically drives pricing (e.g. ADT, CHD, etc). | O |
<PaxSegmentList> | ||
XML Example for the following elements <ns11:PaxSegmentList> <ns11:PaxSegment> <ns11:Arrival> <ns11:AircraftScheduledDateTime TimeZoneCode="LTC">2019-12-29T19:10:00.000Z</ns11:AircraftScheduledDateTime> <ns11:IATA_LocationCode>AYT</ns11:IATA_LocationCode> </ns11:Arrival> <ns11:CabinType> <ns11:CabinTypeCode>Y</ns11:CabinTypeCode> <ns11:CabinTypeName>ECONOMY</ns11:CabinTypeName> </ns11:CabinType> <ns11:DatedOperatingLeg> <ns11:Arrival> <ns11:IATA_LocationCode>AYT</ns11:IATA_LocationCode> </ns11:Arrival> <ns11:CarrierAircraftType> <ns11:CarrierAircraftTypeCode>73H</ns11:CarrierAircraftTypeCode> </ns11:CarrierAircraftType> <ns11:DatedOperatingLegID>V1_EQPT.1390283009430</ns11:DatedOperatingLegID> <ns11:Dep> <ns11:IATA_LocationCode>FRA</ns11:IATA_LocationCode> </ns11:Dep> <ns11:IATA_AircraftType> <ns11:IATA_AircraftTypeCode>800</ns11:IATA_AircraftTypeCode> </ns11:IATA_AircraftType> </ns11:DatedOperatingLeg> <ns11:Dep> <ns11:AircraftScheduledDateTime TimeZoneCode="LTC">2019-12-29T13:45:00.000Z</ns11:AircraftScheduledDateTime> <ns11:IATA_LocationCode>FRA</ns11:IATA_LocationCode> </ns11:Dep> <ns11:Duration>PT3H25M0.000S</ns11:Duration> <ns11:MarketingCarrierInfo> <ns11:CarrierDesigCode>XQ</ns11:CarrierDesigCode> <ns11:MarketingCarrierFlightNumberText>141</ns11:MarketingCarrierFlightNumberText> <ns11:RBD_Code>L</ns11:RBD_Code> </ns11:MarketingCarrierInfo> <ns11:PaxSegmentID>V1_SEG.1390283009429</ns11:PaxSegmentID> </ns11:PaxSegment> </ns11:PaxSegmentList>
| ||
Elements | Details | Optional/Mandatory |
<PaxSegmentList> | Flight segment details for the requested itinerary | O |
<PaxSegment> | Transportation of a passenger on a Segment | M |
<Arrival> | The arriving of the flight at the destined airport | 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 defined code identifying an airport. | O |
<TerminalName> | The name of the terminal. | O |
<CabinType> | Type of compartment of an aircraft (e.g. business class, economy). | O |
<CabinTypeCode> | Cabin Type Code as defined by PADIS codeset (e.g. 1, 2, 3, etc.) | O |
<CabinTypeName> | Name given to a cabin compartment (e.g. Business, First, Economy). | O |
<DatedOperatingLeg> | The nonstop operation of flight between the departure station and the arrival station. | O |
<Arrival> | The arriving of the flight at the destined airport | M |
<IATA_LocationCode> | IATA defined code identifying an airport. | O |
<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 | O |
<Dep> | Leaving of a flight from any airport. | M |
<IATA_LocationCode> | IATA defined code identifying an airport. | O |
<IATA_AircraftType> | Grouping of aircrafts with the same form, function and specification | O |
<IATA_AircraftTypeCode> | Code assigned to an aircraft type in IATA SSIM | O |
<Dep> | Leaving of a flight from any airport. | M |
<AircraftScheduledDateTime> | The Scheduled Date and Time of Departure of the aircraft at the terminal or departure gate at an airport. | O |
<IATA_LocationCode> | IATA defined code identifying an airport. | O |
<Terminal> | The name of the terminal. | O |
<Duration> | Total segment time. | O |
<MarketingCarrierInfo> | Marketing flight details | M |
<CarrierDesigCode> | Airline code assigned to a carrier | M |
<MarketingCarrierFlightNumberText> | The numerical designation of a flight | M |
<RBD_Code> | Code used to identify a particular fare class (e.g. P, J, W, M, etc.). | O |
<PaxSegmentID> | Uniquely identifies a Passenger Segment | M |
<PaxJourneyList> | ||
XML Example for the following elements
<ns11:PaxJourneyList> <ns11:PaxJourney> <ns11:Duration>P0Y0M0DT3H25M0.000S</ns11:Duration> <ns11:PaxJourneyID>V1_FL.1390283009428</ns11:PaxJourneyID> <ns11:PaxSegmentRefID>V1_SEG.1390283009429</ns11:PaxSegmentRefID> </ns11:PaxJourney> </ns11:PaxJourneyList> | ||
Elements | Details | Optional/Mandatory |
<PaxJourneyList> | Flight List for the requested itinerary | O |
<OriginDestList> | ||
XML Example for the following elements <ns11:OriginDestList> | ||
Elements | Details | Optional/Mandatory |
<OriginDestList> | List of Origin and Destination for the requested itinerary | O |
<OriginDest> | The Origin and Destination airport pair which confines a passenger journey or an aircraft flight. | M |
<DestCode> | IATA defined code identifying a city or station. | M |
<OriginCode> | IATA defined code identifying a city or station. | M |
<OriginDestID> | Uniquely identifies an Origin Destination | O |
<PaxJourneyRefID> | Uniquely identifies a Passenger Journey. It can be more than one flight which is associated to a route | O |