FlightPrice

Our 17.2 version is available for trial in BETA: OfferPriceVersion 17.2

1.1 Functional Description

version:  2.49

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.45) Include in the request to QPX the department code associated with the requested product.

(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 Specifies preferred language by the agency 2 alphabetic any
Version

The IATA version of the message

numeric any Schema
<PointOfSale>

Location / CountryCode

Country code

2 alpha

List of countries

NDC Mandatory if toggle feature for market validation is activated.
<Document> Schema

ReferenceVersion

The IATA Schema version.

numeric

any


<Party / Sender / TravelAgencySender> Schema

IATA_Number

Sender IATA or Pseudo IATA number

7 numeric

7/8 numbers

NDC Mandatory

AgencyID

Agency identification

alphanumeric

any

Schema
Name

Agency Name

alphanumeric any
<Party / Sender / TravelAgencySender / Contacts / Contact> Mandatory for schema if 'Contacts' tag is indicated.
EmailContact / Address Email to contact the Agency alphanumeric any Mandatory for schema if 'EmailContact' tag is indicated.
PhoneContact / Application Agency phone type alphabetic
  • BUSINESS
  • MOBILE

PhoneContact / Number

Attribute

CountryCode

Country code phone number to contact the Agency alphanumeric any
Name / Surname Reference Agency contact surname alphanumeric any Mandatory for schema if 'Name' tag is indicated.
Name / Given Reference Agency contact given alphanumeric any Mandatory for schema if 'Participants' tag is indicated.
<Party / Participants>

Participants / Participant

Attribute

SequenceNumber

Number of aggregator secuency connection numeric any
Participant / AggregatorID Aggregator ID of the participant which is connecting numeric 7/8 numbers
<Travelers / Traveler> Schema

AnonymousTraveler / PTC

Attribute

Quantity

Quantity and type of anonymous passenger

  • This info is not validated against passengers introduced in previous Air Shopping request, is it only informed because of Travelers tag is mandatory for IATA schema.
  • Quantity
  • PaxType (3 alpha)

Passenger Types


(plus)RecognizedTraveler

Attribute

ObjectKey

Recognized traveler information. alphanumeric
Mandatory if passenger has Frecuent Flyer information associated
(plus)RecognizedTraveler / PTC Type of recognized passenger

PaxType (3 alpha)

Passenger Types Mandatory if passenger has Frecuent Flyer information associated
(plus)RecognizedTraveler / Name / Surname Surname of recognized passenger alphanumeric any Mandatory if passenger has Frecuent Flyer information associated
(plus)RecognizedTraveler / Name / Given Name of recognized passenger alphanumeric any Mandatory if passenger has Frecuent Flyer information associated
(plus)RecognizedTraveler / FQTVs / AirlineID Airline carrier for Frecuent Flyer number 2 alpha any Mandatory if passenger has Frecuent Flyer information associated
(plus)RecognizedTraveler / FQTVs / Account / Number Frecuent Flyer number numeric any Mandatory if passenger has Frecuent Flyer information associated
<Query>  Only for Direct Fare Schema

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 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

Attribute

MetadataKey

Type of currency alphanumeric any available currency Mandatory for schema if 'Metadata' tag is indicated.
Other / OtherMetadata / CurrencyMetadatas / CurrencyMetadata / Decimals Decimals of Currency numeric any

 

1.3 Response Body

 

NAME

DESCRIPTION

FORMAT

ALLOWED VALUES
<ShoppingResponseIDs>

ResponseID

Id of the response Alphabetical Any
<PricedFlightOffers / PricedFlightOffer>

OfferID

Offer ID Alphabetical Any
<PricedFlightOffers / PricedFlightOffer / OfferPrice>
RequestedDate / PriceDetail / Total Amount Sum of Base Amount and Taxes Numeric Any
RequestedDate / PriceDetail / Taxes Taxes breakdown Numeric Any
RequestedDate / Associations Traveler references Alphanumeric Any
FareDetail / FareComponent / FareRules / Penalty Penalties from cancel or change the order Penalty Any
<PricedFlightOffers / PricedFlightOffer / TimeLimits>
PaymentDateTime Timestamp - Date and Time by which payment is due. Date
OfferExpiration Timestamp - Date and Time when Offer expires. Date
<PricedFlightOffers / PricedFlightOffer / Associations>
ApplicableFlight / FlightSegmentReference / ClassOfService / Code Code of class of service 1 Alpha 1 Alpha
ApplicableFlight / FlightSegmentReference / ClassOfService / MarketingName Name of the cabin Alphabetical Any
AssociatedService  Service reference for special needs Alphanumeric Any
<Commission> (Only if Sender is Real IATA)

Percentage

Percentage of commission Numeric Any

Amount

Amount of commission Numeric Any
<Datalists / AnonymousTravelerList>

AnonymousTraveler 

Attribute

ObjectKey

Passenger Identifier (ADULT_01...) Alphanumeric Any
PTC Passenger Type (ADT, CHD, INF) Alphabetical Passenger Types
(plus)<Datalists / RecognizedTravelerList>

(plus)RecognizedTraveler

Attribute

ObjectKey

Passenger Identifier (ADULT_01...) Alphanumeric Any
(plus)PTC Passenger Type (ADT, CHD, INF) Alphabetical Passenger Types
(plus)Name / Surname Recognized passenger surname Alphabetical Any
(plus)Name / Given Recognized passenger name Alphabetical Any
(plus)FQTVs / AirlineID Airline carrier for Frecuent Flyer number 2 Alpha 2 Alpha
(plus)FQTVs / Account / Number Frecuent Flyer number Numeric Number
<Datalists / CarryOnAllowanceList>

CarryOnAllowance 

Attribute

ListKey

Carry on Allowance Identifier Alphanumeric Any
CarryOnAllowance / PieceAllowance / ApplicableParty Text "Party" (Identifier for all conditions) Alphabetical Any
CarryOnAllowance / PieceAllowance / TotalQuantity Quantity allowed Numeric Number
CarryOnAllowance / PieceAllowance / ApplicableBag Identifier (Carry-On) Alphabetical Any
CarryOnAllowance / PieceAllowance / PieceMeasurements Quantity Quantity allowed Numeric Number
<Datalists / CheckedBagAllowanceList>

CheckedBagAllowance

Attribute

ListKey

Bag Allowance Identifier  Alphanumeric Any
AllowanceDescription / ApplicableParty Text "Party" (Identifier for all conditions) Alphabetical Any
Descriptions / Description / Text Associated quantity text Alphanumeric Any
PieceAllowance PieceAllowanceCombination

Piece Allowance Identifier

It will not be shown when the quantity text is 0
Alphabetical Any
PieceAllowance PieceAllowanceCombination / ApplicableParty

Text "Party" (Identifier for all conditions)

It will not be shown when the quantity text is 0

Alphabetical Any
PieceAllowance PieceAllowanceCombination / TotalQuantity

Quantity of allowed pieces 

It will not be shown when the quantity text is 0

Numeric Number
PieceAllowance PieceAllowanceCombination / Descriptions / Description / Text

Associated and descriptive text (Golf equipment...)

It will not be shown when the quantity text is 0

Alphanumeric Any
PieceAllowance PieceAllowanceCombination / PieceMeasurements Quantity

Quantity of pieces

It will not be shown when the quantity text is 0

Numeric Number
<Datalists / DisclosureList>

Disclosures

Attribute

ListKey

Identifier of selected fare (BFLROES, TBAESEU...) Alphabetical Any
Disclosures / Description / Text Descriptive text indicating services included in selected fare (Selección de asiento: Incluido) Alphanumeric Any
<Datalists / FlightSegmentList>

FlightSegment

Attribute

SegmentKey

Segment Identifier Alphanumeric Any
FlightSegment / Departure / AirportCode Departure Airport Code Identifier (MAD, LIS...) Alphabetical Any
FlightSegment / Departure / Date Departure Flight Date (2018-12-27) numeric yyyy-MM-dd
FlightSegment / Departure / Time Departure Flight Time (17:50) numeric hh:mm
FlightSegment / Departure / AirportName Departure Airport Name (Madrid Adolfo Suarez-Barajas...) Alphabetical Any
FlightSegment / Departure / Terminal / Name Departure Terminal Name (4, 4S...) Alphanumeric Any
FlightSegment / Arrival / AirportCode Arrival Airport Code Identifier (MAD, LIS...) Alphabetical Any
FlightSegment / Arrival / Date Arrival Flight Date (2018-12-27) numeric yyyy-MM-dd
FlightSegment / Arrival / Time Arrival Flight Time (17:50) numeric hh:mm
FlightSegment / Arrival / AirportName Arrival Airport Name (Madrid Adolfo Suarez-Barajas...) Alphabetical Any
FlightSegment / Arrival / Terminal / Name Arrival Terminal Name (4, 4S...) Alphanumeric Any
FlightSegment / MarketingCarrier / AirlineID Marketing airline Identifier (IB, I2...) Alphanumeric Any
FlightSegment / MarketingCarrier / Name Marketing airline Name(Iberia...) Alphanumeric Any
FlightSegment / MarketingCarrier / FlightNumer Marketing flight Number Identifier (4370...) numeric Number
FlightSegment / OperatingCarrier / AirlineID Operating airline Identifier (IB, I2...) Alphanumeric Any
FlightSegment / OperatingCarrier / Name Operating airline Name(I2...) Alphanumeric Any
FlightSegment / OperatingCarrier / Disclosures / Description / Text Operating airline text description  Alphanumeric Any
FlightSegment / Equipment/ AircraftCode Aircraft identifier (32A...) Alphanumeric Any
FlightSegment / Equipment/ Name Aircraft Name (Airbus Industrie A320 (Sharklets)) Alphanumeric Any
<Datalists / FlightList>

Flight

Attribute

FlightKey

Flight Identifier (MADCDG20180927175000...) Alphanumeric Any
Flight / Journey / Time Flight time duration (PT2H5M)  Alphanumeric PT'hh'H'mm'M
Flight / Journey / SegmentReferences Segment Identifier (IB374020180927)  Alphanumeric Any
<Datalists / OriginDestinationList>

OriginDestination

Attribute

OriginDestinationKey

Origin and destination Identifier (MADCDG) alphabetic Any
OriginDestination / DepartureCode Departure Airport Code (MAD...) alphabetic Any
OriginDestination / ArrivalCode Arrival Airport Code (PAR...) alphabetic Any
OriginDestination / FlightReferences Complete flight reference (MADCDG20180927175000) alphabetic Any
<Datalists / MediaList>

Media

Attribute

ListKey

Identifier (Legal-Information") alphabetic Any
Media / MediaLink Link to information  alphabetic Any
<Datalists / ServiceList>

Service

Attribute

ObjectKey

Service object and reference alphanumeric Any
Service / ServiceID Identifier of special need service alphanumeric Any
Service / Name Name of special need service alphabetic Any
Service / Descriptions / Description / Text Associated text of special need service alphabetic Any
Service / Price / Total Code Associated amount and currency of special need service alphanumeric Any
Service  / BookingInstructions / SSRCode Special need code (BLND, WHCS...) alphabetic Special Needs
Service  / Associations /Traveler / TravelerReference Reference of passenger with special need service (ADULT_01...) alphanumeric Any
<FareList>

FareGroup

Attribute

ObjectKey

FareGroup with mandatory alphabetic Any
FareGroup / Fare / FareCode Fares description alphanumeric Any
FareGroup / Fare / FareCode / Code FareGroup Service ID with mandatory service code numeric Any
FareGroup / Fare / FareCode / Definition FareGroup product mandatory definition alphabetic Any

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.