OfferPrice 17.2

EndPoint: https://test.api.iberia.com/iberia/beta/ndc/OfferPrice/17.2/v1

Functionality

Use

Examples → Complete Flow (All RQ/RS)

Get Fare

Returns a Priced Availability quote for the specified flight product, with Fare and Tax breakdown together with more detailed product information.

This methods to request the flight price needs a previous AirShopping for returning a price breakdown.

OfferPrice - Get Fare - Real IATA.
OfferPrice - Get Fare - Pseudo IATA
OfferPrice - Get Fare - 1 ADT 1 CHD 1 INF
OfferPrice - Get Fare - Special Needs
Download Examples

Direct Fare

This methods to request the flight price it is stateless. Including extra data it will return the price breakdown of the selected flight.

OfferPrice - Direct Fare - Real IATA
OfferPrice - Direct Fare - Pseudo IATA
OfferPrice - Direct Fare - One Way
OfferPrice - Direct Fare - Round Trip
OfferPrice - Direct Fare - 1 ADT 1 CHD 1 INF
OfferPrice - Direct Fare - Resident & Large Family Discount
OfferPrice - Direct Fare - Special Needs
Download Examples

v17 - R2.66 - R2019.24

Legend

New or Modified field

HTTP Headers

api_key

Your unique key used to authorise access to the API.

Yes

n/a

Change Log

In the version 15.2 for FlightPrice Get Fare the fields are:

<Preference> Only for Direct Fare
<ShoppingResponseIDs> Only for Get Fare
ResponseID	ID Response of the AirShopping service	alphanumeric	any
OfferItemID	OffterItem ID	alphanumeric	any
FarePreferences/TicketDesigs/TicketDesig	Special Discount code	15 alphanumeric	Resident Discount, Large Family Discount

Request Body

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 Alphabetical	List of countries	If toggle feature for market validation is activated.
<Document>				Schema
ReferenceVersion	The IATA Schema version.	numeric	any
<Party / Sender> Only for Real IATA				Schema
TravelAgencySender / IATA_Number	Sender unique identifier such as: IATA number (if you have one) TIDs number (re ended if you do not have an IATA)	Numeric	7/8 Numbers	NDC Mandatory
<Party / Sender> Only for Pseudo IATA				Schema
TravelAgencySender / OtherIDs / OtherID	Pseudo IATA (assigned by Iberia)	Numeric	7/8 Numbers	NDC Mandatory
<Party>				Schema
Sender / TravelAgencySender / Name	Agency Name	Alphanumeric	Any
Sender / TravelAgencySender / Contacts / Contact / EmailContact / Address	Email to contact the Agency	Alphanumeric	Any	Mandatory for schema if 'EmailContact' tag is indicated.
Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Application	Agency phone type	Alphabetical	Business Mobile
Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Number	Phone number to contact the Agency	Numeric	Any
Sender / TravelAgencySender / Contacts / Contact / Name / Surname	Reference Agency contact surname	Alphanumeric	Any
Sender / TravelAgencySender / Contacts / Contact / Name / Given	Reference Agency contact name	Alphanumeric	Any	Mandatory for schema if 'Name' tag is indicated.
Sender / TravelAgencySender / AgencyID	Name of the Sender / Agency	Alphanumeric	Any	Schema
Participants / Participant / AggregatorParticipant / 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.
<Party> (With Corporates)
Sender / CorporateSender / ID	ID for the Corporate	Alphanumeric	Any	NDC Mandatory
Participants / Participant / TravelAgencyParticipant / Name	Agency Name	alphanumeric	Any
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / EmailContact / Address	Email to contact the Agency	alphanumeric	Any	Mandatory for schema if 'EmailContact' tag is indicated.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Application	Agency phone type	alphabetical	Business Mobile
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Number	Phone number to contact the Agency	alphanumeric	Any
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Surname	Reference Agency contact surname	alphabetic	Any
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Given	Reference Agency contact name	alphabetic	Any	Mandatory for schema if 'Name' tag is indicated.
Participants / Participant / TravelAgencyParticipant / IATA_Number	Sender unique identifier such as: IATA number (if you have one) TIDs number (recommended if you do not have an IATA)	numeric	7/8 Numbers	NDC Mandatory
Participants / Participant / TravelAgencyParticipant / AgencyID	Id for the Agency	alphanumeric	Any	Schema
Participants / Participant / AggregatorParticipant / 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)	numeric	7/8 Numbers	Mandatory for schema if 'Participants' tag is indicated.
<Preference>
FarePreferences / TicketDesigs / TicketDesig	Special Discount code	Alphanumeric	Resident & Large Family Discount	Mandatory for schema if 'Preferences' tag is indicated.
FarePreferences / Types / Type Attribute PreferencesContext	Type of product selected	Alphanumeric	Any avalaible product	Mandatory for schema if 'Preference' tag is indicated and don't have other preference inside
<JourneyData> Only for Direct Fare				Schema
Flight / Flight / Departure / AirportCode	IATA 3 character code for the departure city/airport/station	3 Alphanumeric	Any valid departure point listed in the AirlineProfile	Schema
Flight / Flight / Departure / Date	Date of departure	Date (yyyy-MM-dd)	Any future date	Schema
Flight / Flight / Arrival / AirportCode	IATA 3 character code for the departure city/airport/station	3 Alphanumeric	Any valid departure point listed in the AirlineProfile	Schema
Flight / Flight / MarketingCarrier / AirlineID	Id for the airline that markets the flight	Alphabetical	Any	Schema
Flight / Flight / MarketingCarrier / FlightNumber	Number for the flight that markets the flight	Numeric	Any	Schema
<Query> Only for Get Fare				Schema
Offer Attribute OfferID Attribute ResponseID	Id of a returned offer Id of the response	Alphanumeric Alphanumeric	Any Any	Schema
Offer / OfferItem Attribute OfferItemID	Id for OfferItem	Alphanumeric	Any	Schema
Offer / OfferItem / PassengerRefs	Type of passenger	Alphanumeric	Type of Passengers	Schema
<Qualifier>
SpecialNeedQualifiers / Code	Code of the special need qualifiers	4 Alphabetical	Special Services	Mandatory for schema if 'Qualifier' tag is indicated.
<Datalists / PassengerList>				Schema
Passenger Attribute PassengerID	Type of passenger	Alphanumeric	Type of Passengers	Schema
Passenger / PTC	Attribute Passenger Type Code	PaxType (3 Alphabetical)	Type of Passengers	Schema
Passenger / Individual / GivenName	Name of recognized passenger	Alphanumeric	Any	Mandatory if passenger has Frecuent Flyer information associated
Passenger / Individual / Surname	Surname of recognized passenger	Alphanumeric	Any	Mandatory if passenger has Frecuent Flyer information associated
Passenger / LoyaltyProgramAccount / Airline / AirlineDesignator	Airline carrier for Frecuent Flyer number	2 Alphanumeric	Any	Mandatory if passenger has Frecuent Flyer information associated
Passenger / LoyaltyProgramAccount / AccountNumber	Frecuent Flyer number	Numeric	Any	Mandatory if passenger has Frecuent Flyer information associated
<Metadata>
Other / OtherMetadata / CurrencyMetadatas / CurrencyMetadata Attribute MetadataKey	Type of currency	Alphabetical	Any available currency for the defined market	Mandatory for schema if 'Metadata' tag is indicated
Other / OtherMetadata / CurrencyMetadatas / CurrencyMetadata / Decimals	Decimals of currency	Numeric	Any

Response Body

NAME	DESCRIPTION	FORMAT	ALLOWED VALUES	Nullable
<Document>
ReferenceVersion	The IATA version of the message	Numeric	Any	False
<ShoppingResponseID>
ResponseID	Id of the response	Alphanumeric	Any	False
<PricedOffer>
PricedOffer Attribute OfferID	Id of the Offer	Alphanumeric	Any	False
OfferExpirationDateTime	Date of offer expiration	Date	Any	False
PaymentTimeLimitDateTime	Date of payment time limit	Date	Any	False
TotalPrice / SimpleCurrencyPrice Attribute Code	Price and currency for the complete offer	Alphanumeric	Any	False
<PricedOffer / OfferItem>
OfferItem Attribute OfferItemID	Id of the OfferItem	Alphanumeric	Any	False
TotalPriceDetail / TotalAmount / SimpleCurrencyPrice Attribute Code	Price and currency for the OfferItem	Alphanumeric	Any	False
Service Attribute ServiceID	Id of the Service	Alphanumeric	Any	False
Service / PassengerRefs	Passenger Identifier	Alphanumeric	Any	False
Service / FlightRefs	Flight Identifier	Alphanumeric	Any	False
<PricedOffer / OfferItem / FareDetail>
PassengerRefs	Passenger Identifier	Alphanumeric	Any	False
Price / TotalAmount / SimpleCurrencyPrice Attribute Code	Price and currecny for the fare and taxes	Alphanumeric	Any	False
Price / BaseAmount Attribute Code	Unitary total price and currency without taxes for each passenger included at the fare	Alphanumeric	Any	False
Price / Taxes / Total Attribute Code	Sum of all taxes and currency	Alphanumeric	Any	False
Price / Taxes / Breakdown / Tax / Amount Attribute Code	Single tax amount and currency	Alphanumeric	Any	False
Price / Taxes / Breakdown / Tax / TaxCode	Id of the specified tax	Alphabetical	Any	False
FareComponent / FareRules / Penalty Attribute refs	Reference of the penalty rule that applies to the fare	Alphanumeric	Any	True
FareComponent / PriceClassRef	Reference for the PriceClass	Alphanumeric	Any	False
FareComponent / SegmentRefs	Reference for the Segments	Alphanumeric	Any	False
<PricedOffer / BaggageAllowance>
FlightRefs	Reference for the Flights	Alphanumeric	Any	False
PassengerRefs	Reference for the Passengers	Alphanumeric	Any	False
BaggageAllowanceRef	Reference for the Baggage	Alphanumeric	Any	False
<PricedOffer / OtherOffers / Offer> Only for Direct Fare
Offer Attribute OfferID	Id for the Offer	Alphanumeric	Any	True
Offer Attribute Owner	Marketing airline identification and offer identification	Alphanumeric	Any	True
OfferExpirationDateTime	Date of offer expiration	Alphanumeric	Any	True
PaymentTimeLimitDateTime	Date of payment time limit	Alphanumeric	Any	True
TotalPrice / SimpleCurrencyPrice Attribute Code	Price and currency for the complete offer	Alphanumeric	Any	True
TotalPrice / SimpleCurrencyPrice Attribute MandatoryInd	Indicate if the orderittem is mandatory or not	Alphabetical	Any	True
TotalPriceDetail / TotalAmount / SimpleCurrencyPrice Attribute Code	Price and currency for offerittem	Alphanumeric	Any	True
Service Attribute ServiceID	Id of the Service	Alphanumeric	Any	True
Service / PassengerRefs	Passenger Identifier	Alphanumeric	Any	True
Service / FlightRefs	Flight Identifier	Alphanumeric	Any	True
FareDetail / PassengerRefs	Passenger Identifier	Alphanumeric	Any	True
FareDetail / Price / TotalAmount / SimpleCurrencyPrice Attribute Code	Price and currecny for the fare and taxes	Alphanumeric	Any	True
FareDetail / Price / BaseAmount Attribute Code	Unitary total price and currency without taxes for each passenger included at the fare	Alphanumeric	Any	True
FareDetail / Price / Taxes / Total Attribute Code	Sum of all taxes and currency	Alphanumeric	Any	True
FareDetail / Price / Taxes / Breakdown / Tax / Amount Attribute Code	Single tax amount and currency	Alphabetical	Any	True
FareDetail / Price / Taxes / Breakdown / Tax / TaxCode	Id of the specified tax	Alphanumeric	Any	True
FareDetail / FareComponent / FareRules / Penalty Attribute refs	Reference of the penalty rule that applies to the fare	Alphanumeric	Any	True
FareDetail / FareComponent / PriceClassRef	Reference for the PriceClass	Alphanumeric	Any	True
FareDetail / FareComponent / SegmentRefs	Reference for the Segments	Alphanumeric	Any	True
BaggageAllowance / FlightRefs	Reference for the Flights	Alphanumeric	Any	True
BaggageAllowance / PassengerRefs	Reference for the Passengers	Alphanumeric	Any	True
BaggageAllowance / BaggageAllowanceRef	Reference for the Baggage	Alphanumeric	Any	True
<OtherOffers / ALaCarteOffer>
ALaCarteOffer Attribute OfferID	Id for the Offer	Alphanumeric	Any	True
ALaCarteOffer / ALaCarteOfferItem Attribute OfferItemID	Id for the OfferItem	Alphanumeric	Any	True
ALaCarteOffer / ALaCarteOfferItem / Eligibility / PassengerRefs	Reference for the Passengers	Alphanumeric	Any	True
ALaCarteOffer / ALaCarteOfferItem / Eligibility / SegmentRefs	Reference for the Segments	Alphanumeric	Any	True
ALaCarteOffer / ALaCarteOfferItem / UnitPriceDetail / TotalAmount / SimpleCurrencyPrice	Price for the special need	Numeric	Any	True
ALaCarteOffer / ALaCarteOfferItem / Service Attribute ServiceID	Id for the Service	Alphanumeric	Any	True
ALaCarteOffer / ALaCarteOfferItem / Service / ServiceDefinitionRef	Type of special need	Alphabetical	Any	True
<Commision> (Only if Sender is Real IATA)
Amount	Amount of commision that applicates to the OfferItem	Numeric	Any	True
Percentage	Percentage of commision that applicates to the OfferItem	Numeric	Any	True
<DataLists>
PassengerList / Passenger Attribute PassengerID	Identification of passenger	Alphanumeric	Any	False
PassengerList / Passenger / PTC	Attribute Passenger Type Code	PaxType (3 Alphabetical)	Passenger Types	False
Passenger / Individual / GivenName	Name of recognized passenger	Alphanumeric	Any	True
Passenger / Individual / Surname	Surname of recognized passenger	Alphanumeric	Any	True
Passenger / LoyaltyProgramAccount / Airline / AirlineDesignator	Airline carrier for Frecuent Flyer number	2 Alphanumeric	Any	True
Passenger / LoyaltyProgramAccount / AccountNumber	Frecuent Flyer number	Numeric	Any	True
<DataLists / BaggageAllowanceList>
BaggageAllowance Attribute BaggageAllowanceID	Id for the Baggage	Alphanumeric	Any	False
BaggageAllowance / BaggageCategory	Identifier	Alphabetical	Any	False
BaggageAllowance / PieceAllowance / ApplicableParty	Text "Party" (Identifier for all conditions)	Alphabetical	Any	False
BaggageAllowance / PieceAllowance / TotalQuantity	Quantity allowed	Numeric	Any	False
BaggageAllowance / PieceAllowance / BagType	Type of bag allowed	Alphabetical	Any	True
BaggageAllowance / PieceAllowance / Descriptions / Text	Associated quantity text	Alphanumeric	Any	True
BaggageAllowance / Piece Allowance / PieceMeasurements Attribute Quatity	Quantity of piece measurements	Numeric	Any	False
<DataLists / DescriptionList>
Description Attribute ObjectKey	Id for the description of the private fare	Alphabetical	Any	True
Description / Text	Descriptive text of the private fare	Alphabetical	Any	True
<DataLists / FareList>
FareGroup Attribute refs	Reference of the fare group	Alphabetical	Any	True
FareGroup Attribute ListKey	Id for the fare group	Alphanumeric	Any	False
FareGroup / Fare / FareCode	Code of the Fare	Alphanumeric	Any	False
FareGroup / Fare / FareBasisCode	Code of the FareBasis	Alphanumeric	Any	False
<DataLists / FlightSegmentList / FlightSegment>
FlightSegment Attribute SegmentKey	Id for the segment	Alphanumeric	Any	False
Departure / AirportCode	IATA 3 character code for the departure city/airport/station	3 Alphanumeric	Any	False
Departure / Date	Date of departure	Date	yyyy-MM-dd	False
Departure / Time	Hour of departure	Hour	HH:mm	False
Departure / AirportName	Name of the departure city/airport/station	Alphanumeric	Any	False
Departure / Terminal / Name	Name for the departure terminal at city/airport/station	Alphanumeric	Any	False
Arrival / AirportCode	IATA 3 character code for the arrival city/airport/station	3 Alphanumeric	Any	False
Arrival / Date	Date of arrival	Date	yyyy-MM-dd	False
Arrival / Time	Hour of arrival	Hour	HH:mm	False
Arrival / ChangeOfDay	Change of day between departure and arrival	1 Numeric	Any	False
Arrival / AirportName	Name of the arrival city/airport/station	Alphanumeric	Any	False
Arrival / Terminal / Name	Name for the arrival terminal at city/airport/station	Alphanumeric	Any	False
MarketingCarrier / AirlineID	Id for the airline that markets the flight	Alphabetical	Any	False
MarketingCarrier / Name	Name for the airline that markets the flight	Alphanumeric	Any	False
MarketingCarrier / FlightNumber	Number for the flight	Numeric	Any	False
OperatingCarrier / AirlineID	Id for the airline that operates the flight	Alphabetical	Any	False
OperatingCarrier / Name	Name for the airline that operates the flight	Alphanumeric	Any	False
OperatingCarrier / FlightNumber	Number for the flight	Numeric	Any	False
OperatingCarrier / Disclosures / Description / Text	Description of the airline	Alphanumeric	Any	False
Equipment / AircraftCode	Code for the aircraft that operates the flight	Alphanumeric	Any	False
Equipment / Name	Name for the aircraft that operates the flight	Alphanumeric	Any	False
FlightDetail / FlightDuration / Value	Duration of the flight	Alphanumeric	Any	False
<DataLists / FlightList / Flight>
Flight Attribute FlightKey	Id for the flight	Alphanumeric	Any	False
Journey / Time	Duration of the flight	Alphanumeric	Any	False
SegmentReferences	Reference for the segments	Alphanumeric	Any	False
<DataLists / OriginDestinationList / OriginDestination>
OriginDestination Attribute OriginDestinationKey	Id for the OriginDestination	Alphanumeric	Any	False
DepartureCode	IATA 3 character code for the departure city/airport/station	3 Alphanumeric	Any	False
ArrivalCode	IATA 3 character code for the arrival city/airport/station	3 Alphanumeric	Any	False
FlightReferences	FlightRefereces from DataLists / FlightList	Alphanumeric	Any	False
<DataLists / MediaList>
Media Attribute ListKey	Id for the Media Item	Alphanumeric	Any	False
Media / MediaLink	Http link referring to the Media Item	Alphanumeric	Any	False
<DataLists / PenaltyList / Penalty>
Penalty Attribute ObjectKey	Id for the penalty	Alphanumeric	Any	False
Details / Detail / Type	Type of action associated to he penalty like Cancel, Change...	Alphabetical	Any Ex: Cancel, Change	False
Details / Detail / Application	Associated Code to action refered above like Change, Cancel FAT Fare or application penalty type 1 No show 2 Prior to departure 3 After departure	Numeric	Any	False
Details / Detail / Amounts / Amount / CurrencyAmountValue Attribute Code	Amount and currency for the penalty	Alphanumeric	Any	False
Details / Detail / Amounts / Amount / AmountApplication	Identifies minimum and maximun penalty amount	Alphabetical	minPrice maxPrice	False
<DataLists / PriceClassList / PriceClass>
PriceClass Attribute PriceClassID	Id for the PriceClass	Alphanumeric	Any	False
Name	Name of the PriceClass	Alphanumeric	Any	False
Code	Code of the PriceClass	Alphanumeric	Any	False
Descriptions / Description Attribute ObjectKey	Id for the description	Alphanumeric	Any	False
Descriptions / Description / Text	Description of the ObjectKey	Alphanumeric	Any	False
ClassOfService Attribute refs	Reference of the ClassOfService	Alphanumeric	Any	False
ClassOfService / Code	Code for the ClassOfService	Alphanumeric	Any	False
ClassOfService / MarketingName	Name for the type of ClassOfService	Alphanumeric	Any	False