AirShopping 15.2 Live
New Functionality:
-
(RLS2019.15) allows to show in AirShopping response, for cheapest offers, the marketing name of the fare without the fare conditions. It allows to show in AirShopping response, for a Seller configured to not return fare conditions of WCS, the marketing name of the fare without show the fare conditions.
- (version 2.42) AirShopping response now returns MarketingName, Disclosures and DisclosureList when new BestPricingOption preference is filled with "C" value.
- (version 2.42) A new preference has been added to the AirShopping Request , specifically BestPricingOption "C".
EndPoint:
- IATA NDC Schema Version 15.2: https://test.api.iberia.com/iberia/beta/ndc/AirShopping/v1
Messages Examples
AirShopping.zip message examples
Request Body
New or Modified field
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 |
xmlns | IATA oficial website | alphabetic | any | Schema |
<PointOfSale> | ||||
Location / CountryCode |
Country code |
2 alpha |
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 |
|
|
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> | Schema | |||
Traveler / AnonymousTraveler / PTC |
Attribute Passenger Type Code |
PaxType (3 alpha) |
Schema | |
Traveler / AnonymousTraveler / PTC Attribute Quantity |
Quantity of this kind of passenger type | numeric | any, from 1 to 9 | |
<CoreQuery / OriginDestination> | Schema | |||
Departure / AirportCode |
IATA 3 character code for the departure city/airport/station |
3 alpha |
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 departure city/airport/station | 3 alpha | any valid arrival point listed in the AirlineProfile. | Schema |
<Preferences> | ||||
Preference / CabinPreferences / CabinType / Code |
|
1 numeric |
|
Mandatory for schema if 'Preferences' tag is indicated and dont have other preference inside |
Preference / FlightPreferences / Characteristic / NonStopPreferences |
Number of stops (With PreferencesContext="maxStops") | numeric | any | Mandatory for schema if 'Preferences' tag is indicated and dont have other preference inside |
Preference / FarePreferences / Types / Type / Definition |
Type of product selected. Needed with: Preference / FarePreferences / Types / Type / Code |
alphabetical |
any available product like:
|
Mandatory for schema if 'Preferences' tag is indicated and don't have other preference inside |
Preference / FarePreferences / Types / Type / Code |
Type of code for the fare selected. Needed with: Preference / FarePreferences / Types / Type / Definition |
numeric |
PADIS codeset element 9910 - Fare Qualifier
|
Mandatory for schema if 'Preferences' tag is indicated and don't have other preference inside |
Preference / FarePreferences / TicketDesigs / TicketDesig |
|
alphabetical |
|
Mandatory for schema if 'Preferences' tag is indicated and don't have other preference inside |
Preference / PricingMethodPreference/ BestPricingOption | List of pricing preferences | alphabetical |
PADIS codeset element 9873 - Cabin Class of Service
|
Optional and just for NDC |
<Metadata> | ||||
Other / OtherMetadata / CurrencyMetadatas / CurrencyMetadata / MetadataKey Attribute 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 | any | Mandatory for schema if 'MetadataKey' tag is indicated |
Response Body
NAME |
DESCRIPTION |
FORMAT | ALLOWED VALUES |
---|---|---|---|
Version | NDC message version | Alphanumeric | Any |
PrimaryLangID | NDC message lenguage identification | Numeric | Any (Ex: es) |
xmlns | IATA oficial website | Alphabetical | Any |
<Document> | |||
ReferenceVersion | NDC message version | Alphanumeric | Any |
<ShoppingResponseIDs> | |||
ResponseID |
Id of the response | Alphabetical | Any |
<OffersGroup> | |||
AirlineOffers / TotalOfferQuantity |
Number of offers returned in the response | Numerical | Any |
<OffersGroup / AirlineOffers / AirlineOffer> | |||
OfferID Attribute Owner |
Identification of a returned offer and its associated marketing airline | Alphanumeric | Any |
TimeLimits / OfferExpiration | Expiration time limit of the offer | Date / Time (UTC fomat) | Any |
TotalPrice / DetailCurrencyPrice / Total Attribute Code |
Total price (with taxes) of the offer and its associated currency code | Alphanumeric | Any |
TotalPrice / DetailCurrencyPrice / Taxes / Total Attribute Code |
Taxes price of the offer and its associated currency code | Alphanumeric | Any |
<AirlineOffers / AirlineOffer / PricedOffer > | |||
OfferPrice Attribute OfferItemID |
Offer price for each passenger type. OfferItemID attribute is an offer identificator for each passenger type. |
Alphanumeric | Any |
OfferPrice / RequestedDate / PriceDetail / TotalAmount / SimpleCurrencyPrice Attribute Code |
Total price with taxes for passenger type and its associated currency code | Alphanumeric | Any |
OfferPrice / RequestedDate / PriceDetail / BaseAmount Attribute Code |
Total price without taxes for passenger type and its associated currency code | Alphanumeric | Any |
OfferPrice / RequestedDate / PriceDetail / Taxes / Total Attribute Code |
Taxes price for passenger type and its associated currency code | Alphanumeric | Any |
OfferPrice / RequestedDate / Associations / AssociatedTraveler / TravelerReferences | Passenger reference associated for te specified price for the offer | Alphanumeric | Any |
OfferPrice / FareDetail / FareComponent Attribute refs |
Reference that contains the segment identificator and a code related to FareBasis element in FareList. | Alphanumeric | Any |
Associations / ApplicableFlight / OriginDestinationReferences | Flight segment reference with origin/destination airports code | Alphabetical | Any |
Associations / ApplicableFlight / FlightReferences | Flight reference code | Alphanumeric | Any |
Associations / ApplicableFlight / FlightSegmentReference Attribute ref |
Contains flight segment reference code composed by flight number and date of the flight | Alphanumeric | Any |
Associations / ApplicableFlight / FlightSegmentReference / ClassOfService / Code Attribute SeatsLeft |
Class of service code and remaining seats | Alphanumeric | Any |
Associations / ApplicableFlight /FlightSegmentReference / ClassOfService / MarketingName Attribute CabinDesignator |
Class of service marketing name and far family name | Alphanumeric | Any |
<Commission> (Only if Sender is Real IATA) | |||
Percentage |
Percentage of commission | Numeric | Any |
<DataList> | |||
AnonymousTravelerList | List of all passengers of each type | List | Any |
AnonymousTravelerList / AnonymousTraveler Attribute ObjectKey |
Anonymous Passenger key | Alphanumeric | Any |
AnonymousTravelerList / AnonymousTraveler / PTC | Anonymous Passeger Code | Alphabetical | Any |
<DisclosuresList / Disclosures> | |||
Disclosures Attribute ListKey |
IATA Disclosure values. This conditions are shown only without cheapest offers or when seller is configured to retrieve the information of WCS service. | Alphabetical | Any |
Description Attribute MetadataToken |
Key for the value inside Metadata Item | Alphabetical | Any |
Description / Text | Value of the MetaData Item | Alphanumeric | Any |
<FareList / FareGroup> | |||
FareGroup Attribute ListKey |
Unique identificator for the fare group related to FareComponent reference. | Alphanumeric | Any |
Fare / FareCode / Code |
Code for fare: 70J - Public Fares 758 - Private Fares |
alphanumerical | Any |
Fare / FareCode / Definition | Fare definition only for private fares | alphanumerical | Any |
FareBasisCode / Code | Fare basis identification code | alphanumerical | Any |
<FlightSegmentList / FlightSegment> | |||
FlightSegment Attribute SegmentKey |
Flight Segment Code containing FlightId and date | alphanumerical | Any |
<FlightSegmentList / FlightSegment / Departure> | |||
AirportCode | IATA Airport Code | alphabetical | Any |
Date | Departure Date | Date | yyyy-MM-dd |
Time | Departure Time | Time | hh:mm |
AirportName | Full Airport Name | alphabetical | Any |
Terminal / Name | Terminal name or number. Real world name for terminal | alphabetical/numerical | Any |
<FlightSegmentList / FlightSegment / Arrival> | |||
AirportCode | IATA Airport Code | alphabetical | Any |
Date | Departure Date | Date | yyyy-MM-dd |
Time | Departure Time | Time | hh:mm |
ChangeOfDay | Shows how many days after departure date flight will arrive. | numerical | Any |
AirportName | Full Airport Name | alphabetical | Any |
Terminal / Name | Terminal name or number. Real world name for terminal | alphabetical/numerical | Any |
<FlightSegmentList / FlightSegment / MarketingCarrier> | |||
AirlineID | IATA airline code | alphabetical | Any |
Name | Full Airline name. | alphabetical | Any |
FlightNumber | The flight number | numerical | Any |
<FlightSegmentList / FlightSegment / OperatingCarrier> |
|||
AirlineID | IATA airline code | alphabetical | Any |
Name | Full Airline name. | alphabetical | Any |
FlightNumber | The flight number | numerical | Any |
Disclosures / Description / Text | Text showing the disclosure | alphabetical | Any |
<FlightSegmentList / FlightSegment / Equipment> | |||
AircraftCode | Aircraft Code | numerical | Any |
Name | Full Aircraft model name | alphanumerical | Any |
<FlightSegmentList / FlightSegment / FlightDetail> | |||
FlightDuration / Value | Flight duration time (Hours and minutes) | alphanumerical | Any |
<FlightList> | |||
Flight Attribute FlightKey |
Id for the flight | alphanumerical | Any |
Flight / Journey / Time | Time for the journey | Date | Any |
Flight / SegmentReferences | Id referencing a FlightSegment | alphanumerical | Any |
<OriginDestinationList> | |||
OriginDestination Attribute OriginDestinationKey |
IATA Code referencing departure city and arrival city | alphabetical | Any |
OriginDestination / DepartureCode | IATA Code for Departure City | alphabetical | Any |
OriginDestination / ArrivalCode | IATA Code for Arrival City | alphabetical | Any |
OriginDestination / FlightReferences | Id Referencing a Flight. | alphanumerical | Any |
<MediaList> | |||
Media Attribute ListKey |
Id for the Media Item | alphabetical | Any |
Media / MediaLink | Http link referring to the Media Item | alphanumerical | Any |
1.4 Error messages
Error responses have been expanded and improved.
NDC Standard allow errors and warnings to be returned inside a 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".
HTTP STATUS CODE |
EXAMPLE MESSAGE ERROR |
REASON |
324 |
Can not be more infants than adults |
More infants than adults |
68 |
Max accepted non-infant passengers is 9 |
Number of passengers incorrect |
913 |
There are not available flights for the requested query |
No available flights |
1 |
Please check the dates of your Shopping request |
Bad Dates in the requeset |
68 |
Number of passengers |
Max number of passenger per request exceeded |
913 |
No flights |
Item/data not found or data not existing in processing host |
1 |
Departure date is before Origin date |
Please check the flight dates and try again. If the issue persists, please contact us. |
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 |
Point of sale different from España |
Los descuentos de residentes no están disponible. |
486 |
Incorrect origin or arrival |
El descuento de residente no es aplicable a los trayectos seleccionados. |
324 |
More infant than adults |
You cannot book more babies than adults. Please check the booking or contact us. |
75G |
Agency not authorized for Indicated Private Fare |
Agency not allowed to use the selected private fare |
73Y |
Incorrect Private Fare code |
No eligible fare found for requested fare type |
143 |
Incorrect type of passenger |
Invalid or Ineligible Passenger Type Code |
486 |
Passenger code not implemented for private fare |
Invalid action 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. |