AirShopping 17.2

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

Functional Description

AirShopping API returns priced availability offers for requested preferences like origin and destination, cabin, date, special discounts...

It returns an airline offer list and all their associated product descriptions, like flight details or options included in fare.

Before sending this request the Airline Profile (list of Origins & Destinations) supplied by Iberia should be checked, ensuring shopping is only done for IB marketed routes.

FunctionalityUseExamples → Complete Flow (All RQ/RS)
Basic Returns priced availability offers for requested origin and destination, cabin and date. It returns the cheapest available offer together with higher classes of service and their product descriptions.
  • AirShopping - One Way
  • AirShopping - Round Trip
  • AirShopping - 1 ADT 1 CHD 1 INF
  • AirShopping - Escalas
  • Download Examples
Resident Discount

fIt will give the possibility to obtain flights with Resident Discount, also applicable to the Large Family Discount. It is implemented for Canary Islands, Balearic Islands and Melilla and only with point of sale Spain.

To obtain the discount, the flight has to have an Origin/Destination airport included in this modality.

The types of residents are:

  • RC (Residente Canarias)
  • BP (Residente Baleares)
  • RM (Residente Melilla)
  • BI (Para en interior de Baleares)
  • DC (Para el interior de Canarias)

There are some restrictions in resident discount

All the resident discount must been selling in spain market.
Can't be two types of resident discount in the same reserve.
The routes of the trip must have the departure or arrival in once of the cities of the resident discount.

  • AirShopping - Residente Baleares
  • AirShopping - Residente Canario.
  • Download Examples
Large Family Discount

It will give the possibility to obtain orders with Large Family Discount, also applicable to the Resident Discount. Implemented to national flights only in Spain.

The types of residents are:

  • F1 (General Discount - 3 children)
  • F2 (Special Discount - More than 3 children)

There are some restrictions in large family discount

  • All the large familydiscount must been selling in Spain market.
  • Can't be two types of large familydiscount in the same reserve.
  • AirShopping - Large Family Discount.
  • AirShopping - Resident & Large Family Discount.
  •  Download Examples
Private Fares It will give the possibility to obtain private fares. To obtain this behaviour, the request must provide a fare preference type with the 758 code (private fares one) and the suitable product code to be applied.
Cheapest Fare It will give the possibility to obtain cheapest fare. It is implemented to search for all cabins type or for a specific type of cabin

 

Legend

(plus) New or modify field

HTTP Headers

api_key Your unique key used to authorise access to the API. Mandatory: Yes

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 Alphabetical
  • 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  (recommended if you are not an IATA Accredited agent)

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) Schema
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
 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 Agenc  Numeric Any
 Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Surname  Reference Agency contact surname   Alphanumeric Any
 Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Given  Reference Agency contact name  Alphanumeric 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)

 7 Numeric 7 Numbers Mandatory for schema if 'Participants' tag is indicated.
<CoreQuery / OriginDestinations / OriginDestination> Schema
Departure / AirportCode IATA 3 character code for the departure city/airport/station 3 Alphanumeric Any valid departure point listed in the AirlineProfile Schema
Departure / Date Date of departure Date (yyyy-MM-dd) Any future date Schema
Arrival / AirportCode IATA 3 character code for the arrival city/airport/station 3 Alphanumeric Any valid arrival point listed in the AirlineProfile Schema
<Preference>

FarePreferences / Types / Type

Attribute

PreferencesContext

Type of product selected. Alphanumeric

PADIS codeset element 9910 - Fare Qualifier

  • 758

Atrribute: Any avalaible product like

  • HM
  • TO
  • SO
  • DISNEY
Mandatory for schema if 'Preference' tag is indicated and don't have other preference inside
FarePreferences / TicketDesigs / TicketDesig Resident discount code Alphabetical
  • RC (Residente Canarias)
  • BP (Residente Baleares)
  • RM (Residente Melilla)
  • BI (Para el interior de Baleares)
  • DC (Para el interior de Canarias)
Mandatory for schema if 'Preference' tag is indicated and don't have other preference inside
FarePreferences / TicketDesigs / TicketDesig Large Family discount code Alphanumeric
  • F1 (General discount)
  • F2 (Special discount)
Mandatory for schema if 'Preference' tag is indicated and don't have other preference inside
FlightPreferences / Characteristic / DirectPreferences Number of stops Numeric
  • 0 - Direct Flights
  • n (1, 2, 3...) - Indirect Flights
Mandatory for schema if 'Preference' tag is indicated and don't have other preference inside
CabinPreferences / CabinType / Code IATA PADIS Cabin code (This info will be introduced as preferredCabin in QPX RQ being just a preference, so QPX will return also our preference offers and other offers too) 1 Numeric
  • 1 First
  • 2 Business
  • 4 Premium Tourist
  • 5 Economy
Mandatory for schema if 'Preference' tag is indicated and don't have other preference inside
PricingMethodPreference / BestPricingOption Code to select best pricing option 1 Alphabetical

PADIS codeset element 9873 - Cabin Class of Service

  • C (cheapest fares)
  • Y (cheapest fares for a specific cabin type)
Optional and just for NDC
<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
<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
<Document>
ReferenceVersion The IATA version of the message Numeric Any
<ShoppingResponseID>

ResponseID

Id of the response Alpnanumeric Any
<OffersGroup>
AirlineOffers List of available AirlineOffers. List Any
<OffersGroup / AirlineOffers>

Offer

Attribute

OfferID

Id of a returned offer Alphanumeric Any
<OffersGroup / AirlineOffers / Offer>
OfferExpirationDateTime Expiration date and time for the offer Alphanumeric Any

TotalPrice / SimpleCurrencyPrice

Attribute

Code

Type of currency Alphabetical Any
TotalPrice / SimpleCurrencyPrice Full price for the offer Numeric Any

FlightsOverview / FlightRef

Attribute

ODRef

Reference to the DataLists / OriginDestinationList Alphanumeric Any

FlightsOverview / FlightRef

Attribute

PriceClassRef

Reference to the DataLists / PriceClassList (with the family). Alphanumeric Any
FlightsOverview / FlightRef Reference for the flight. The value refers to the FlightList list. Alphanumeric Any

OfferItem

Attribute

OfferItemID

Id for OfferItem. Will be one OfferItem for each type of passenger in the offer Alphanumeric Any
<OffersGroup / AirlineOffers / Offer / OfferItem>

TotalPriceDetail / TotalAmount / SimpleCurrencyPrice

Attribute

Code

Type of currency Alphabetical Any
TotalPriceDetail / TotalAmount / SimpleCurrencyPrice Price for OfferItemID Numeric Any
Service / PassengerRefs
References of the passengers included at the service
Alphanumeric Any
Service / FlightRefs References of the flights included at the service Alphanumeric Any
FareDetail / PassengerRefs References of the passengers included at the fare Alphanumeric Any

FareDetail / Price / TotalAmount / SimpleCurrencyPrice

Attribute

Code

Type of currency Alphabetical Any
FareDetail / Price / TotalAmount / SimpleCurrencyPrice Unitary price for each passenger included at the fare Numeric Any

FareDetail / Price / BaseAmount

Attribute

Code

Type of currency Alphabetical Any
FareDetail / Price / BaseAmount Unitary base amount for each passenger included at the fare Numeric Any

FareDetail / Price / Taxes / Total

Attribute

Code

Type of currency Alphabetical Any
FareDetail / Price / Taxes / Total Unitary total taxes for each passenger included at the fare Numeric Any
FareDetail / FareComponent / PriceClassRef Reference at DataList / PriceClassList Alphabetical Any
FareDetail / FareComponent / SegmentRefs

Reference that contains the segment identificator, the code of the airport of origin and destination.

Example → IB343620200216MADORY

Alphanumeric Any (Ex: Example → IB343620200216MADORY)
<Commision> (Only if Sender is Real IATA)
Percentage Percentage of commision that applicates to the OfferItem Numeric Any
Amount Amount of commision that applicates to the OfferItem Numeric Any
<DataLists / PassengerList>

Passenger

Attribute

PassengerID

Type of passenger Alphanumeric Any
Passenger / PTC Attribute Passenger Type Code PaxType (3  Alphabetical) Passenger Types
<DataLists / DescriptionList>

Description / Text

Product / subproduct description Alphabetic Any
<DataLists / FareList / FareGroup>
Fare / FareCode

Code for Public fare (70J), Private fare (758) or Corporate fare(1)

Alphanumeric
  • Public fare → 70J
  • Private fare → 758
  • Corporate fare → 1
FareBasis / Code Code for fare Alphanumeric Any
<DataLists / FlightSegmentList>

FlightSegment

Attribute

SegmentKey

Flight Segment Code containing FlightId, date and the code of the airport of origin and destination

Example → IB260120200219BCNEZE

 

alphanumerical Any (Ex: Example → IB260120200219BCNEZE)
<DataLists / FlightSegmentList / FlightSegment>
Departure / AirportCode IATA 3 character code for the departure city/airport/station 3 Alphanumeric Any
Departure / Date Date of departure Date yyyy-MM-dd
Departure / Time Hour of departure Hour HH:mm
Departure / AirportName Name for the departure city/airport/station Alphanumeric Any
Departure / Terminal / Name Name for the departure terminal at city/airport/station Alphanumeric Any
Arrival / AirportCode IATA 3 character code for the arrival city/airport/station 3 Alphanumeric Any
Arrival / Date Date of arrival Date yyyy-MM-dd
Arrival / Time Hour of arrival Hour HH:mm
Arrival / ChangeOfDay Change of day between departure and arrival 1 Numeric Any
Arrival / AirportName Name for the arrival city/airport/station Alphanumeric Any
Arrival / Terminal / Name Name for the arrival terminal at city/airport/station Alphanumeric Any
MarketingCarrier / AirlineID Id for the airline that markets the flight Alphabetical Any
MarketingCarrier / Name Name for the airline that markets the flight Alphanumeric Any
MarketingCarrier / FlightNumber Number for the flight Numeric Any
OperatingCarrier / AirlineID Id for the airline that operates the flight Alphabetical Any
OperatingCarrier / Name Name for the airline that operates the flight Alphanumeric Any
OperatingCarrier / FlightNumer Number for the flight Numeric Any
Equipment / AircraftCode Code for the aircraft that operates the flight Alphanumeric Any
Equipment / Name Name for the aircraft that operates the flight Alphanumeric Any
FlightDetail / FlightDuration / Value Duration for the flight Alphanumeric Any
<DataLists / FlightList>

Flight

Attribute

FlightKey

Id for the flight Alphanumeric Any
Flight / Journey / Time Duration for the flight Alphanumeric Any
Flight / SegmentReferences

Reference that contains the segment identificator, the code of the airport of origin and destination.

Example → IB260220200217EZEBCN

Alphanumeric Any (Ex: IB260220200217EZEBCN)
<DataLists / OriginDestinationList>
OriginDestination / DepartureCode IATA 3 character code for the departure city/airport/station Alphanumeric Any
OriginDestination / ArrivalCode IATA 3 character code for the arrival city/airport/station Alphanumeric Any
OriginDestination / FlightReferences FlightReferences from DataLists / FlightList Alphanumeric Any
<DataLists / MediaList>

Media

Attribute

ListKey

Id for the Media Item Alphanumeric Any
Media / MediaLink Http link referring to the Media Item Alphanumeric Any
<DataLists / PriceClassList>

PriceClass

Attribute

PriceClassID

Id for the PriceClass Item Alphanumeric Any
PriceClass / Name Name for the PriceClass item  Alphanumeric

Any (Example: Básica, Óptima)

PriceClass / Code Code for the PriceClass item Alphanumeric Any (Example: TBAESEU, TCLESEU)

PriceClass / Descriptions / Description

Attribute

ObjectKey

Id for the condition that applies for the fare

It will only be shown when the Seller is configured as WCS in BBDD. In case of using cheaper rate it will not be shown either.

Alphanumeric Any
PriceClass / Descriptions / Description / Text Descriptive text for the condition that applies for the fare Alphanumeric Any

PriceClass / ClassOfService 

Attribute

refs

Reference of the segment and farebasis of the FareList to which the service applies:
Example --> IB344320200220ORYMAD DDNNANS4
Alphanumeric Any (Ex: IB344320200220ORYMAD DDNNANS4)

PriceClass / ClassOfService / Code

Attribute

SeatsLeft

Code for the ClassOfService item

Attribute

Number of seats left

Alphanumeric Any
PriceClass / ClassOfService / MarketingName Name for the cabin that applies for the ClassOfService item Alphanumeric Any
<Metadata>

Other / OtherMetadata / CurrencyMetadatas / CurrencyMetadata

Attribute

MetaDataKey

Type of currency Alphanumeric Any
Other / OtherMetadata / CurrencyMetadatas / CurrencyMetadata / Decimals Decimals of currency Numeric Any