Version attr

Specify NDC schema message version. Always pass 17.2

Note: This is a mandatory attribute in NDC schema. The service will not validate what is being passed in this attribute

PrimaryLangID attr

Specifies the agent’s preferred language. Service response will be returned in this language

Note: If the requested language is not supported by BA or if this is not passed in the request then the default language will be used, which is English Example: EN

AltLangID attr

Specifies the preferred language in which the mail to be sent. eTicket receipt email and any other communication emails from BA will be sent in this language

Note: AltLangID will not be used even if it was passed in the AirShopping request, as there is no email sent at the shopping stage. If the requested language is not supported by BA or if this is not passed in the request then the default language will be used, which is English

<Document>

<Name>

<CoreQuery>

<OriginDestinations>

<OriginDestination>

 OriginDestinationKey attr 

<Departure>

<AirportCode>

<Date>

Departure date

<Time>

This must be passed if you want offers with flights departure ranges from +2 and -2 hours of the specific time.
Example: 13:00
The system will return all the offers with flights which are departing from 11:00 to 15:00. If there is no offer within +2 or -2 hour, then the system will not return any offer

1. If Arrival time is greater than 01:59 and less than 22:00, the system will return offers with Arrival within +2 and -2 hours of the requested time.

2. If Arrival time is greater than 21:59, the system will return offers only with Arrival within -2 hours of the requested time.

3. If Arrival time is less than 02:00, the system will return offers only with Arrival within +2 hours of the requested time
   
   If both Departure time and Arrival time are specified for the OD, then the system should consider only the Departure time and should return offer in +2 to -2 hours of the departure time

<Arrival>

<AirportCode>

<CalendarDates>

Indicates Calendar search date.

Calendar recommendation will only be returned if the client specifies calendar search dates in the request

DaysAfter attr

The number of days after the requested date

Example: 3

Calendar recommendation will be returned for the number of days specified after the requested date

DaysBefore attr

The number of days before the requested date

Example: 3

Calendar recommendation will be returned for the number of days specified before the requested date

<BaggageOption>

<Preference>

Fare and cabin preference can be specified here

<FarePreferences>

Specify fare preference. BA accepts the below 2 fare preferences in the shopping request:

1) Flexible fare
2) Lowest fare

 If no fare preference is specified then by default lowest fare will be returned. Also, leisure fare can be requested under FarePreferences.

<Types>

<Type>

PreferencesContext attr

IATA PADIS Codeset 9910 - Fare qualifier

BA accepts the following codes from codeset 9910 (754, 759, 758, 70G and 70J) where
754 means Flexible fare (cheapest flexible Fare of published or negotiated fares)
736 means Refundable fare
759 means Lowest fare (cheapest restricted fares of published and negotiated fares)
758 means Negotiated (Private) fare
70G means corporate fare although must be submitted with a corporate identifier also in the corporate sender section
70J means Non-Negotiated (Public) fare
758 with preference type is considered as Leisure fare

The Leisure fare should be specified as an attribute for the <Type> element.

The list of Leisure Fares are 

1. Tour Operator Deferred
2. Tour Operator Semi-Deferred 
3. Contract Bulk
4. Private Fare Adult
5. Marine (currently disabled)
6. Humanitarian

This is an XML example for the use of this attribute:

British Airways offers two separate Tour Operator products:

1. Tour Operator Deferred – Longer Ticketing Time Limit
2. Tour Operator Semi Deferred – Shorter Ticketing Time Limit

The earlier-ticketing, Semi-Deferred fares are differentiated only by their name from the Deferred Fares in NDC. In line with the existing process, agents who wish to book a British Airways Leisure fare product must specify the name as part of the AirShopping request. To book one of these products agents must use either “Tour Operator Deferred” or “Tour Operator Semi Deferred” in the Fare Preference section of the API.

Here is an XML sample for the two products:

The Leisure Fare is assigned to the 'PreferencesContext' attribute within the 'Type' element.

As part of ‘Shop by Fare Type’ feature enhancement, agents will be able to search the flight offers by fare type (Negotiated, Non-Negotiated or Cheapest fare products).

The agent can pass the desired fare type (70J or 758) along with the fare flexibility type (754, 759).

The agent can:

1. request for Non-Negotiated fares and receives Non-Negotiated fare offers
2. request for Negotiated fares and receives Negotiated fare offers
3. request for Non-Negotiated and Negotiated fares and receives the list of offers and every offer should be either Negotiated fare offer or Non-Negotiated fare offer
4. receive Cheapest fare offers if no fare type (Negotiated or Non-Negotiated) is provided

O

<FlightPreferences>

<Aircraft>

This is required to be passed if the agent wants to shop based on a particular Aircraft type.

O

<Equipment>

O

<AircraftCode>

The IATA Aircraft type 3 character code

Example - 318

M

Refs (attribute)

Reference to OriginDestinationKey for which preference is requested

Example – ‘OD1’

O

<Characteristic>

<DirectPreferences>

This will return offers with direct flight only, for all the Origin destinations in the itinerary

(pass this as an empty xml tag in the Request)

<TransferPreferences>

This should be passed if customer want to shop based on Transfer Airport preference or Maximum number of connections

O

<Connection>

M

<Codes>

O

<Code>

This should be repeated for each Transfer point per OD

Example - LHR

M

PreferencesLevel

Reference to OriginDestinationKey for which preference is requested

Example – ‘OD1’

O

<CabinPreferences>

The cabin can only be specified for the whole itinerary

Example:

LHR-JFK-LHR journey can be requested in “Economy” cabin for the whole itinerary

<CabinType>

<Code>

IATA PADIS Codeset 9873 - Cabin class of service, coded

BA accepts the following codes from codeset 9873

1, 2, 4  and 5

 Where 1 = First, 2 = Business, 4 = Premium Economy and 5 = Economy

<PassengerList>

List of all passengers with Passenger type code (PTC): 

• Young adult DOB is required as UK Air Passenger Duty (APD) is not applicable to “young adults” aged 12 to 15 years inclusive for travel after 1 March 2016