IATA_OfferPriceRS
- Sreejith S R (Unlicensed)
User Guidance - Service Response Parameters | ||
Input Parameter | Type | Optional/Mandatory |
Response Object | IATA_OfferPriceRS | M |
<MessageDoc>
<PayloadAttributes>
<AugmentationPoiint>
<Response>
<DataLists>
<BaggageAllowanceList>
<OriginDestList>
<PaxJourneyList>
<PaxList>
<PaxSegmentList>
<PricedOffer>
<OfferExpirationTimeLimitDateTime>
<OfferId>
<OwnerCode>
<PTC_OfferParameters>
<OfferItem>
<OfferItemId>
<Price>
<Service>
<FareDetails>
<FareComponent>
<FarePriceType>
<MessageDoc> | ||
 XML Example for the following elements | ||
<ns9:MessageDoc> </ns9: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(19.2) | O |
<PayloadAttributes> | ||
|---|---|---|
XML Example for the following elements | ||
<ns9:PayloadAttributes> | ||
Elements | Details | Optional/Mandatory |
VersionNumber | Specify NDC schema message version. Always pass 19.2 | O |
<AugmentationPoint> | ||
|---|---|---|
XML Example for the following elements | ||
<ns9:AugmentationPoint> </ns9:AugmentationPoint> | ||
Elements | Details | Optional/Mandatory |
<ItineraryAmountDetailAugPoint> | The price details of itinerary are provided here including the pending amount | M |
<TotalPriceAmount >      | Total Price amount of the Itinerary | M |
<TotalFeeAmount> | Total Fee amount of the itinerary. | M |
<TotalAmount> | Total amount(Itinerary total) | M |
<Datalists>Â | ||
|---|---|---|
<BaggageAllowanceList> | ||
XML Example for the following elements | ||
 <ns9:BaggageAllowanceList> </ns9:BaggageAllowanceList> | ||
Elements | Details | Optional/Mandatory |
<BaggageAllowanceList> | Baggage allowance data list definition | O |
<BaggageAllowance> | This explains the allowance limit of check in baggage, provided by the airline, for a given traveller type and OandD. | M |
<BaggageAllowanceID> | Uniquely identifies a baggage allowance | M |
<TypeCode> | Additional BDT to specify baggage type code. | M |
<WeightAllowance> | Weight allowance of the baggage | O |
<ApplicablePartyText> | Baggage weight restriction application. Examples: ADT | O |
<MaximumWeightMeasure> | Maximum weight value and unit of measure | M |
<OriginDestList> | ||
|---|---|---|
XML Example for the following elements | ||
<ns9:OriginDestList> </ns9:OriginDestList> | ||
Elements | Details | Optional/Mandatory |
<OriginDest> | The Origin and Destination airport pair which confines the itinerary. | M |
<OriginCode> | IATA airport code . | 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 |
<DestCode> | IATA airport code. | M |
<PaxJourneyList> | ||
|---|---|---|
XML Example for the following elements | ||
<ns9:PaxJourneyList> | ||
Elements | Details | Optional/Mandatory |
<PaxJourneyList> | Flight List for the requested itinerary | O |
<PaxJourney> | Collection of flights from origin to destination | M |
<PaxJourneyID> | Uniquely identifies a passengers journey or flight | O |
<PaxSegmentRefID> | Reference to Passenger SegmentID | M |
<PaxList> | ||
|---|---|---|
XML Example for the following elements | ||
<ns9:PaxList> | ||
Elements | Details | Optional/Mandatory |
<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 | ||
 <ns9:PaxSegmentList> </ns9: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. | M |
<IATA_LocationCode> | IATA defined code identifying an airport. | M |
<DatedOperatingLeg> | The nonstop operation of flight between the departure station and the arrival station. | 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 |
<MarketingCarrierInfo> | Marketing flight details | M |
<CarrierDesigCode> | Airline code assigned to a carrier | M |
<Â MarketingCarrierFlightNumberText | The numerical designation of a flight | M |
<Â MarketingCarrierRBD_Code> | Code used to identify a particular fare class (e.g. P, J, W, M, etc.). | O |
<PricedOffer>Â | ||
|---|---|---|
<OfferExpirationTimeLimitDateTime> | ||
XML Example for the following elements | ||
<ns9:OfferExpirationTimeLimitDateTime TimeZoneCode="LTC">2020-04-07T08:29:08.187Z</ns9:OfferExpirationTimeLimitDateTime> | ||
Elements | Details | Optional/Mandatory |
<OfferExpirationTimeLimitDateTime > | The expiry date and time of offer(Currently is not applicable for the offer) | MÂ |
<OfferID> | ||
|---|---|---|
XML Example for the following elements | ||
<ns9:OfferID>OF1-eJxlyzsKgDAQhOETKdk1j90yhYKNYIxgqrn-LdyQwsIpf.Yj5Fa3kkFBohJ714fntBCR96NivQsaFk5BBVeFfZF49joxTJrvWDix.7CnH9aBeWC4F.78IOE_</ns9:OfferID> | ||
Elements | Details | Optional/Mandatory |
<OfferID> | Uniquely Identifies an Offer within the context of one message. | Â M |
<OwnerCode> | ||
|---|---|---|
XML Example for the following elements | ||
<ns9:OwnerCode>XQ</ns9:OwnerCode> | ||
Elements | Details | Optional/Mandatory |
<OwnerCode> | will be always set to "AIRLINECODE" | MÂ |
<PTC_OfferParameters> | ||
|---|---|---|
XML Example for the following elements | ||
 <ns9:PTC_OfferParameters> | ||
Elements | Details | Optional/Mandatory |
<PricedPaxNumber> | Number of Passenger(s) for associated passenger type. Example: 2 | O |
<PTC_PricedCode> | Actual passenger type code used for pricing. Example: ADT | O |
<PTC_RequestedCode> | Requested passenger type code for pricing. Example: CHD Encoding scheme: IATA (three character) Passenger Type Code | O |
<RequestedPaxNumber> | Number of Passenger(s) for associated passenger type. Example: 2 | O |
<OfferItem>Â | ||
|---|---|---|
<Price> | ||
XML Example for the following elements | ||
<ns9:Price> </ns9:Price> | ||
Elements | Details | Optional/Mandatory |
<Price> | Total price for all the passengers to which the OfferItem is associated | M |
<BaseAmount> | Total Base Amount in Point Of Origin currency Base Fare or Base Amount is the actual Fare is defined currency in the system | O |
<TotalAmount> | Display Fare. Display Fare = Base Fare, when tax and surcharge are not inclusive. Base Fare or Base Amount is the actual fare in defined currency in the system | O |
<OfferItemID> | ||
|---|---|---|
XML Example for the following elements | ||
 <ns9:OfferItemID>OF1_OI1-eJxlyzsKgDAQhOETKdk1j90yhYKNYIxgqrn-LdyQwsIpf.Yj5Fa3kkFBohJ714fntBCR96NivQsaFk5BBVeFfZF49joxTJrvWDix.7CnH9aBeWC4F.78IOE_</ns9:OfferItemID> | ||
Elements | Details | Optional/Mandatory |
<OfferItemID> | Uniquely Identifies an Offer Item within the context of one message. | M |
<Service> | ||
|---|---|---|
XML Example for the following elements | ||
<ns9:Service> Â </ns9:Service> | ||
Elements | Details | Optional/Mandatory |
<Service> | This returns the service this OfferItem is entitled to. It will repeat per Origin Destination | M |
<PaxRefID> | Reference to a Passenger ID within this message. The Passenger is the recipient entitled to receive/consume the Service(s) offered by the Airline, whether the Service(s) are flight-related or not Example: <ns9:PaxRefID>V1_PAX.1</ns9:PaxRefID> | M |
<ServiceAssociations> | References to the details of this Service which includes Flight Informations. | M |
<PaxJourneyRefID> | DataListsReference to one Journey in the Datalists that are being sold as part of this OfferItem/Service. | M |
<ServiceID> | A unique service id Example:V1_SRVC.1560995803074 | M |
<FareDetails> | ||
|---|---|---|
<FareComponent> | ||
XML Example for the following elements | ||
<ns9:FareComponent> | ||
Elements | Details | Optional/Mandatory |
<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 |
<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 |
<RemarkText> | Additional, supplementary information about the service . | O |
<TicketlessInd> | When TRUE, the Fare can be purchased without issuing a ticket | OÂ |
< FareTypeCode> | Fare Level Type | O |
<PaxSegmentRefID> | This returns references to all the segments applicable | O |
<Price> | The total price details of the passenger corresponds to the fare component of the offeritem. | O |
<BaseAmount> | Total Base Amount in Point Of Origin currency Base Fare or Base Amount is the actual fare in defined currency. | O |
CurCode           | Currency code in which pricing is done | O |
<Discount> | Discount defined for the farecomponent in POS currency | O |
<DiscountAmount > | Total Discount amount applied to a price. | O |
<Surcharge> | Total surcharge per passenger | O |
<Breakdown> | Amount added on to a charge for a specific product, purpose, or service . | O |
<Amount>Â | Surcharge Amount | M |
<DescText> | Surcharge Details Text | O |
<DesigText> | Surcharge code | OÂ |
<TotalAmount> | Total Surcharge for the fare Component. | O |
<TaxSummary> | Tax summary information. | O |
<Tax> | Tax breakdown details | O |
<AddlTaxCode> | iFlyRes Tax Code | O |
<Country>Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â | Tax Country Code. | O |
<CountryCode> | Country code | O |
<TaxCode> | IATA tax code | 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 |
<FarePriceType> | ||
|---|---|---|
XML Example for the following elements | ||
<ns9:FarePriceType> </ns9:FarePriceType> | ||
Elements | Details | Optional/Mandatory |
<FarePriceType> | Â Price returned per passenger with the total price, fare and total tax of all the fare components associated to the offeritem. | 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 |
<BaseAmount> | Total Base amount of the passenger of all the fare components associated to the offeritem | O |
<Discount> | Discount defined for the offeritem in POS currency | O |
<DiscountAmount> | Total Discount amount applied to passenger associated to the offeritem | O |
<Surcharge> | Total surcharge applied to the offeritem associated to the passenger | O |
CurCode (Attribute) | Currency Code in which pricing is done Example:Â GBP | O |
<TaxSummary> | Total tax of the offeritem associated to the passenger | 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 |
<TotalAmount> | Total Amount of the OfferItem associated to the passenger | O |