FlightPrice 16.2

1.1 Functional Description

version:  2.38

The  FlightPrice service returns a Priced Availability quote for specified products on indicated Flights and Dates. The fare and tax breakdown together with more detailed product information, such as conditions are included in the response.

There are two mode of FlightPrice:

  • Get Fare - for use when you have used our AirShoppingRQ/RS service 
  • Get Direct Fare - for use when you are using a third party Shopping engine. 

Functionality:

FlightPrice.zip message examples

Functionality  Use
Get Fare

This method to request a FlightPrice requires the previous use of the Iberia AirShoppingRQ/RS service, as you must include the AirShopping ResponseID.

It will return a Priced Availability quote for the specified products, with fare and tax breakdown together with more detailed product information..

Get Direct Fare This method to request the flight price is stateless. Including the Flights and Dates information it will return the same as the Get Fare.

(version: 2.23 )Example of validation of the currency we sell with the point of sale currency. This information will be optional.

    
<Metadata>
    <Other>
        <OtherMetadata>
            <CurrencyMetadatas>
                <CurrencyMetadata MetadataKey="EUR">
                <Decimals>2</Decimals>
                </CurrencyMetadata>
            </CurrencyMetadatas>
        </OtherMetadata>
    </Other>
</Metadata>
    

EndPoint:

1.2 Request Body

We provide two different methods to request the flight price.

  • Get Fare : Needs a previous AirShopping for returning a price breakdown.
  • Get Direct Fare:  It is stateless. Including extra data it will return the price breakdown of the selected flight.

The various search parameters are described below:

Add = New

NAME

DESCRIPTION

FORMAT

ALLOWED VALUES

MANDATORY FOR
PrimaryLangID Two character ISO Language Code, for the agent’s preferred language. This is for error messages and some other data such as legal waivers. 2 alpha
  • EN
  • ES

Version The IATA version of the message numeric any Schema
<PointOfSale>  
Location / CountryCode Country code 2 alpha List of countries If toggle feature for market validation is activated
<Document>  
ReferenceVersion The IATA Schema version. numeric any Schema
<Party>  
Sender / IATA_Number

Sender unique identifier such as:

IATA number  (if you have one)

TIDs  number  (recommended if you do not have an IATA)

Pseudo IATA (assigned by Iberia)

7 numeric 7 numbers NDC Mandatory
Sender / AgencyID Name of the Sender / Agency alphanumeric any Schema
Participant / AggregatorID

Participant / Aggregator unique identifier:

IATA number  (if you have one)

TIDs  number  (recommended if you do not have an IATA)

Pseudo IATA (assigned by Iberia)

7 numeric 7 numbers Mandatory for schema if 'Participants' tag is indicated.
<Traverlers>  
TravelerCount(PTC) Attribute Passenger Type Code
  • TravelerCount (numeric)
  • PaxType (3 alpha)
Passenger Types Schema
<Query>  Only for Get Direct Fare  
OriginDestination / Flight / Departure / AirportCode The departure city (or airport) 3 alpha any valid airport or city code Schema

OriginDestination / Flight / Arrival / AirportCode

The arrival city (or airport) 3 alpha any valid airport or city code Schema

OriginDestination / Flight / Departure / Date

Date of travel date any future date Schema
OriginDestination / Flight / MarketingCarrier / AirlineID The airline ID 2 alpha any Schema
OriginDestination / Flight / MarketingCarrier / Flight Number The number of the flight 4 numbers any Schema
<Query>  Only for Get  Fare  
Offers / Offer / OfferID ID of the Offer alphanumeric any Mandatory for schema if 'Query' tag is indicated.
Offers / Offer / OfferItemIDs / OfferItemID ID of the Offer Item alphanumeric any Mandatory for schema if 'Query' tag is indicated.
<Qualifier>  
SpecialNeedQualifiers / Code Code of the special need qualifiers 4 alpha Special Services Mandatory for schema if 'Qualifier' tag is indicated.
<ShoppingResponseIDs>  Only for Get Fare  
ResponseID ID Response of the AirShopping service alphanumeric any Mandatory for schema if 'ShoppingResponseIDs' tag is indicated.
<Preference> Only for Get Direct Fare  
FarePreferences/TicketDesigs/TicketDesig Special Discount code 15 alphanumeric Residents Discount, Large Family Discount Mandatory for schema if 'Preferences' tag is indicated.
<MetaData>
Other / OtherMetadata / CurrencyMetadatas / CurrencyMetadata / MetadataKey  Type of currency Alphabetical Any available currency Mandatory for schema if 'Metadata' tag is indicated.
Other / OtherMetadata / CurrencyMetadatas / CurrencyMetadata / Decimals  Decimals of currency Numeric Decimals currency should have

1.3 Response Body

NAME  

DESCRIPTION  

FORMAT  

Nullable  

<ShoppingResponseIDs>

ResponseID

Id of the response

Alphabetical

False

<PricedFlightOffers / PricedFlightOffer>

OfferID

Offer ID

Alphabetical

False

<PricedFlightOffers / PricedFlightOffer / OfferPrice>

RequestedDate / PriceDetail / Total Amount

Sum of Base Amount and Taxes

Numeric

False

RequestedDate / PriceDetail / Taxes

Taxes breakdown

Numeric

False

RequestedDate / Associations

Traveler references

Alphanumeric

False

FareDetail / FareComponent / FareRules / Penalty

Penalties from cancel or change the order

Penalty

True

<PricedFlightOffers / PricedFlightOffer / TimeLimits>

Payment

Timestamp - Date and Time by which payment is due

dateTime

True

OfferExpiration Timestamp - Date and Time when Offer expires and cannot be referenced.
dateTime
True

<PricedFlightOffers / PricedFlightOffer / Associations>

ApplicableFlight / FlightSegmentReference / ClassOfService / Code

Code of class of service

1 Alpha

False

ApplicableFlight / FlightSegmentReference / ClassOfService / MarketingName

Name of the cabin

Alphabetical

False

Associated Service 

 

Service reference for special needs

AlphaNumeric

True

<Commisions>

Percentage

Percentage of commision

Numeric

True

Amount

Amount of commision

Numeric

False

<Datalists / AnonymousTravelerList>

AnonymousTraveler ObjectKey Passenger Identifier (ADULT_01...) Alphanumeric False
PTC Passenger Type ( ADT, CHD, INF)
Alphabetical False
<Datalists / CarryOnAllowanceList>
CarryOnAllowance ListKey Carry on Allowance Identifier Alphanumeric False
CarryOnAllowance / PieceAllowance / ApplicableParty Text "Party" (Identifier for all conditions) Alphabetical False
CarryOnAllowance / PieceAllowance / TotalQuantity Quantity allowed  Numeric False
CarryOnAllowance / PieceAllowance / ApplicableBag Identifier (Carry-On) Alphabetical False
CarryOnAllowance / PieceAllowance / PieceMeasurements Quantity Quantity allowed Numeric False
<Datalists / CheckedBagAllowanceList>
CheckedBagAllowance ListKey Bag Allowance Identifier
Alphanumeric False
AllowanceDescription / ApplicableParty Text "Party" (Identifier for all conditions) Alphabetical False
Descriptions / Description / Text Associated quantity text Alphanumeric False
PieceAllowance PieceAllowanceCombination Piece Allowance Identifier Alphabetical False
PieceAllowance PieceAllowanceCombination / ApplicableParty Text "Party" (Identifier for all conditions) Alphabetical False
PieceAllowance PieceAllowanceCombination / TotalQuantity Quantity of allowed pieces
Numeric False
PieceAllowance PieceAllowanceCombination / Descriptions / Description / Text Associated and descriptive text (Golf equipment...) Alphanumeric False
PieceAllowance PieceAllowanceCombination / PieceMeasurements Quantity Quantity of pieces Numeric False
<Datalists / DisclosureList>
Disclosures ListKey Identifier of selected fare (BFLROES, TBAESEU...) Alphabetical False
Disclosures / Description / Text Descriptive text indicating services included in selected fare (seat selection included)
Alphanumeric False
<Datalists / FlightSegmentList>
FlightSegment SegmentKey Segment Identifier Alphanumeric False
FlightSegment / Departure / AirportCode Departure Airport Code Identifier (MAD, LIS...) Alphanumeric False
FlightSegment / Departure / Date Departure Flight Date (2018-12-27) Numeric False
FlightSegment / Departure / Time Departure Flight Time (17:50) Numeric False
FlightSegment / Departure / AirportName Departure Airport Name (Madrid Adolfo Suarez-Barajas...) Alphabetical False
FlightSegment / Departure / Terminal / Name Departure Terminal Name (4, 4S...) Alphanumeric False
FlightSegment / Arrival / AirportCode Arrival Airport Code Identifier (MAD, LIS...) Alphabetical False
FlightSegment / Arrival / Date Arrival Flight Date (2018-12-27) Numeric False
FlightSegment / Arrival / Time Arrival Flight Time (17:50) Numeric False
FlightSegment / Arrival / AirportName Arrival Airport Name (Madrid Adolfo Suarez-Barajas...) Alphabetical False
FlightSegment / Arrival / Terminal / Name Arrival Terminal Name (4, 4S...) Alphanumeric False
FlightSegment / MarketingCarrier / AirlineID Marketing airline Identifier (IB, I2...) Alphanumeric False
FlightSegment / MarketingCarrier / Name Marketing airline Name(Iberia...) Alphanumeric False
FlightSegment / MarketingCarrier / FlightNumer Marketing flight Number Identifier (4370...) Numeric False
FlightSegment / OperatingCarrier / AirlineID Operating airline Identifier (IB, I2...) Alphanumeric False
FlightSegment / OperatingCarrier / Name Operating airline Name(I2...) Alphanumeric False
FlightSegment / OperatingCarrier / Disclosures / Description / Text Operating airline text description
Alphanumeric False
FlightSegment / Equipment/ AircraftCode Aircraft identifier (32A...) Alphanumeric False
FlightSegment / Equipment/ Name Aircraft Name (Airbus Industrie A320 (Sharklets)) Alphanumeric False
<Datalists / FlightList>
Flight FlightKey Flight Identifier (MADCDG20180927175000...) Alphanumeric False
Flight / Journey / Time Flight time duration (PT2H5M) Alphanumeric False
Flight / Journey / SegmentReferences Segment Identifier (IB374020180927) Alphanumeric False
<Datalists / OriginDestinationList>
OriginDestination OriginDestinationKey Origin and destination Identifier (MADCDG) alphabetic False
OriginDestination / DepartureCode Origin and destination Identifier (MADCDG) alphabetic False
OriginDestination / ArrivalCode Arrival Airport Code (PAR...) alphabetic False
OriginDestination / FlightReferences Complete flight reference (MADCDG20180927175000) alphabetic False
<Datalists / MediaList>
 Media ListKey Identifier (Legal-Information") alphabetic False 
Media / MediaLink Link to information
alphabetic False
<Datalists / ServiceList>
Service ObjectKey Service object and reference Alphanumeric False
Service / ServiceID Identifier of special need service Alphanumeric False
Service / Name Name of special need service alphabetic False
Service / Descriptions / Description / Text Associated text of special need service alphabetic False
Service / Price / Total Code Associated text of special need service Alphanumeric False
Service  / BookingInstructions / SSRCode Special need code (BLND, WHCS...) alphabetic False
Service  / Associations /Traveler / TravelerReference Reference of passenger with special need service (ADULT_01...) Alphanumeric False

<FareList> 




FareGroup / Fare/ FareGroup

FareGroput with mandatory ObjecKey Alphabetic True

FareCode

Fares description AlphaNumeric True

FareGroup / Fare / FareCode / Code

FareGroup Service ID with mandatory service code numeric True

FareGroup / Fare / FareCode / Definition

FareGroup product mandatory definition alphabetic True

1.4 Error messages

NDC Standard allow errors and warnings to be returned inside an 200 OK response. Errors returned with 200 OK will always be controlled errors result of external limitations as "Max accepted non-infant passengers is 9".

Update Cancel

HTTP STATUS CODE

EXAMPLE MESSAGE ERROR

REASON

795 ShoppingResponseID invalid: incorrect or out-of-date We apologise for the inconvenience. Please start your search again.
486 More than one resident code Only one Resident Discount may be selected
486 Incorrect resident or large family code Incorrect resident or large family code
486 More than one large family code Only one Large Family Discount may be selected
486 Point of sale different from España El descuento de familia numerosa no está disponible.
486 No enough time between flights The difference between the arrival time of your outbound flight and the departure time of your return flight is less than the minimum connecting time required to make the connection. Please modify your last selection and try again.
118 Incorrect data in FP System Unable to Process.