Introduction

This service returns priced availability for each flight for the requested origin and destination, date and cabin. The service also returns priced availability for higher cabins (normally the next two). For example, if availability is requested for Economy, the service will return priced availability for Economy, Premium Economy and Business (assuming these cabins are offered on the route requested).

The service also returns brand attributes for each cabin for which availability is returned.
 

 

Interface Design

This web service is called with the following inputs:

• Origin and Destination (O&D)
• Cabin for the itinerary
• Number of passengers with passenger type
• Restriction Type (flexible or lowest) – “lowest” by default if not specified
• Fare Type (Negotiated, Non-Negotiated or Cheapest) – “Cheapest” by default if not specified  
• Leisure Fare Type
• Baggage Option – Returns offers with baggage if specified and without baggage if not specified 

The output data this service returns include:

• Brand attributes for cabins for which availability is returned
• List of airline offers where each airline offer contains
  - Total offer price for all passengers for the requested itinerary (contains one or more O&D)
  - Price per passenger type per cabin with fare and tax split
  - Flight details such as flight number, selling class etc.

• List of calendar offers (if requested where each calendar offer contains
  - Lowest available single adult price for +/- 3 days of the requested date
  - Total price for the itinerary for various outbound and inbound combination

HttpHeaders

In order to access our API, you will need to pass the following two http headers for each call

Client-key: Your 24-bit API connection key
SOAPAction: AirShopping17_2_V1

 

Endpoints

LIVE	PRE-LIVE	BETA
https://api.ba.com/selling-distribution/AirShopping/17.2/V1	https://test.api.ba.com/selling-distribution/AirShopping/17.2/V1	https://test.api.ba.com/selling-distribution/sandbox/AirShopping/17.2/V1

WSDL

https://test.api.ba.com/selling-distribution/AirShopping/17.2/V1?WSDL

Please update your WSDL to point to the correct endpoint.

 

1. Copy the Test URL ie  https://test.api.ba.com/selling-distribution/AirShopping/api/V1

2. Paste this URL into the SOAP address location.
   Example:

   WSDL Snippet Example

   <service name="AirShoppingDistributionAdapter">     <port name="AirShoppingDistributionAdapterSoap11" binding="tns:AirShoppingDistributionAdapterSoap11">       <soap:address location="[Paste the Test URL here]"/>     </port> </service>

 

Service Features and Restrictions

Returns priced availability for the requested cabin and (up to) the next 2 higher cabins

The service returns priced availability for the requested cabin and (up to) the next 2 higher cabins, if applicable. Example: If the requested cabin is “Economy”, the AirShopping response returns OfferGroup for “Economy”,”  Premium Economy” and “Business” cabins as well

Returns brand attributes only when the OfferGroup contains flights that are both BA operated and marketed

The service returns brand attributes only when the OfferGroup contains flights that are both BA operated and marketed. For connection journeys and journeys that involve Codeshare flights (BA marketed and other carrier operated) brand attributes will not be returned

Returns availability for the nearest day (if applicable) when there is no availability or the flight is not operating on the requested date.

The service returns availability for the nearest day (if applicable) when there is no availability or the flight is not operating on the requested date.

Returns prices in the currency of the agent’s country provided that currency is accepted by the BSP (Billing and Settlement Plan).

The service will return prices in the currency of the agent’s country provided that currency is accepted by the BSP (Billing and Settlement Plan). For countries that support more than one currency, the service will return in the currency that is accepted by the BSP for IATA Accredited agents, and the currency accepted by  ba.com  for other retailers. For example, Mexico supports both USD and MXN but the service returns the price in MXN for IATA accredited agents, as MXN is what is accepted by the BSP. Other retailers will receive a price in USD.

Returns flights based on British Airways carrier preferred availability.

The service returns flights based on British Airways carrier preferred availability.

Returns the lowest available Adult, Young Adult, Child and Infant prices.

The service returns the lowest available Adult, Young Adult, Child and Infant prices.

Returns airline offers sorted by Total Price in an ascending order.

The service returns airline offers sorted by Total Price in an ascending order. This will mean that the Airline Offer will get more expensive as you work through the response.

Supports specific Leisure Fare types. 

  Clients will be able to request any of the below Leisure Fare types 

• Inclusive Tour
• Humanitarian
• Marine (currently disabled)
• Contact Bulk
• Private Fare Adult

Returns an error if the requested Leisure fare is not available

The service returns an error if the requested Leisure fare is not available i.e the service will not default to the published fare if the requested leisure fare is not available

Rejects request and returns an error if the agent is not eligible to request for leisure fare types

The service rejects the request and returns an error if the agent is not eligible to request for leisure fare types

Returns calendar recommendation if at least one O&D contains DaysBefore and DaysAfter attributes with non-zero value

The service returns calendar recommendation if at least one O&D contains DaysBefore and DaysAfter attributes with non-zero value

Expects clients to always pass the fare basis code in OfferPriceRQ

The service expects clients to always pass the fare basis code in OfferPriceRQ in order to quote the correct fare product for the itinerary even if the request is for a non-Economy cabin:- In AirShoppingRS, fare basis code is returned for each offer for each passenger type. If the client were to select one of the offers and proceed with OfferPriceRQ then it is expected that the fare basis code for the offer is provided in OfferPriceRQ

Expects clients to always pass the fare basis code in OfferPriceRQ

The service expects clients to always pass the fare basis code in OfferPriceRQ in order to quote the correct fare product for the itinerary even if the request is for a non-Economy cabin:- In AirShoppingRS, fare basis code is returned for each offer for each passenger type. If the client were to select one of the offers and proceed with OfferPriceRQ then it is expected that the fare basis code for the offer is provided in OfferPriceRQ

Returns the list of offers based on the requested fare type

The service 'negotiated’ fare offers if ‘negotiated’ fares are requested, ‘non-negotiated’ fare offers if ‘non-negotiated’ fares are requested, either ‘negotiated’ or ‘non-negotiated’ fare offer if both ‘negotiated and non-negotiated’ fares are requested and ‘cheapest of negotiated and non-negotiated’ fare offers if no fare type is requested.

Returns always Leisure fare offers if Leisure fare type is requested along with other fare types

Leisure fare type takes the preference to return the offers even if other fare types like ‘Negotiated’ and/or ‘Non-Negotiated’ fare types in the request along with leisure fare type

Baggage Allowance

• Supports both 'piece' and 'weight' only allowance types
• For 'piece' only allowance types, the maximum allowed weight per piece will also be returned. The weight will be returned in both 'kilos' and in 'pounds'
• For 'weight' only allowance type, the weight will only be returned in 'kilos'

Enable agents to shop for offers with ‘Hand Baggage’ and ‘Checked Baggage’ only Fares

• Returns only ‘Hand Baggage’ offers in Economy along with upsell offers in the next available cabins when Baggage option is specified as ‘1’ for Economy cabins
• Returns only ‘Checked Baggage’ offers in Economy along with upsell offers in the next available cabins when Baggage option is specified as ‘3’ for Economy cabins
• Returns offers for the requested cabin along with upsell offers in the next available cabins by ignoring the Baggage option when Baggage option is specified as ‘1’ or ‘3’ for Non-Economy cabins
• Returns both ‘Hand Baggage’ and ‘Checked Baggage’ offers for requested cabins if available along with upsell offers in the next available cabins when Baggage option is not specified

Enable agents to shop for offers with Baggage option and Fare preference

• Returns only ‘Hand Baggage’ offers in Economy along with upsell offers in the next available cabins by ignoring the Fare Preference when Baggage option is specified as ‘1’ Economy cabins
• Returns only ‘Checked Baggage’ offers in Economy along with upsell offers in the next available cabins by ignoring the Fare Preference when Baggage option is specified as ‘3’ for Economy cabins
• Returns offers for the requested cabin and for the requested fare preference(s) along with upsell offers in the next available cabins by ignoring the Baggage option when Baggage option is specified as ‘1’ or ‘3’ for Non-Economy cabins