16.1 AirShopping Overview





 

 16.1 AirShopping

 

VersionDescriptionRelease StatusPre-Live DateLive Date
0.9Implementation of a new IT Fare Product TBC
0.8
Updated fare product names
 
0.8
Updated changes related to calendar recommendation and Fare Indicator (Private Vs Published fare)
 
0.7
Updated changes related to fare products
 
0.6
Updated Calendar Shopping changes
 
0.5
Updated MultiCity Itinerary changes
 
0.4
Updated Leisure Fare changes
 
0.3Updated Price Class changes 
0.2Updated AirShoppingRS with journey duration elements 
0.1
AirShopping – Interface Specification
  

 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 the next higher cabins (normally the next two). For example, if the 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.

Although the Air Shopping API is stateless, it is recommended (and assumed) that it will be called as part of the following sequence of Shop and Order APIs 

  1. AirShopping
  2. FlightPrice
  3. SeatAvailability (where advance seat selection is requested)
  4. OrderCreate

 AirShopping Webservice

Interface Design

This web service is called with the following inputs:

  • Origin and Destination (O&D)
  • Cabin for the itinerary
  • Number of passengers (anonymous) with passenger type
  • Restriction Type (flexible or lowest) – “lowest” by default if not specified
  • Leisure Fare Type

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

 Mandatory Headers

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

 Web Service URLs

 General Message Elements

Field Type

Data Type

Schema Definition (http://www.ba.com/schema/)

Optional/Mandatory

Comments

Party

 

 

M


Sender

 

 

M

Message sender information

TravelAgencySender



M

Specify the travel agency details

Populate TravelAgencySender section only if the request is originated by the Travel Agent

Name


Party/Sender/TravelAgencySender/Name

O

Travel agency name

Example: ABC

Note: This is an optional element in NDC schema. BA will neither use nor validate this element even if it was  passed

Contacts



O

This is an optional element in NDC schema but for calling BA service this must be passed with requesting agent’s email address only if the requesting agent is an IATA agent

Note: Agent contact will only be used in OrderCreate service. Therefore it is up to the client to pass agent email address in AirShopping, FlightPrice and SeatAvailability services

Contact



M


EmailContact



O

This is an optional element in NDC schema but for calling BA service (OrderCreate) this must be passed, if the requesting agent is an IATA agent. This is important as the eTicket confirmation email will only be sent to this email address for IATA agent’s bookings

For non-IATA agents, this element need not be passed as the eTicket confirmation email will only be sent to the customer’s email address. However, BA will record this email address to the booking if provided for non-IATA agents

Address


Party/Sender/TravelAgencySender/Contacts/Contact/EmailContact/Address

M

Travel agency’s email address

Example: abc@tc.com

This is the requesting agent’s email address

OtherIDs



O

Specify Non-IATA agent details

Note: This is an optional element in NDC schema but for calling BA services this must be passed if the requesting agent is a non- IATA agent

OtherID


Party/Sender/TravelAgencySender/OtherIDs/OtherID

M

Non-IATA agent code

Example: 01010101

IATA_Number


Party/Sender/TravelAgencySender/IATA_Number

O

Travel agent’s IATA number

Example: 12345678

Note: This is an optional element in NDC schema but for calling BA services this must be passed if the requesting agent is an IATA agent

AgencyID


Party/Sender/TravelAgencySender/AgencyID

M

Travel agency name

Example: ABC

Note: This is a mandatory element in NDC schema but BA will neither use nor validate this element. Suggestion is to pass travel agency name

CorporateSender




Specify corporate details

Populate CorporateSender section only if the request is originated by the Corporate

Contacts



O

This is an optional element in NDC schema. Populate this section with the requesting corporate’s email address only if the corporate is directly creating a booking with BA via NDC Services

Do not populate this section if Travel Management Company (TMC) is creating a booking on behalf of the corporate 

Note: Corporate contact will only be used in OrderCreate service. Therefore it is up to the client to pass corporate email address in AirShopping, FlightPrice and SeatAvailability services

Contact



M


EmailContact



O

This is an optional element in NDC schema but for calling BA service (OrderCreate) this must be passed, if the corporate is directly creating a booking with BA via NDC Services and the corporate has an IATA number. This is important as the eTicket confirmation email will only be sent to this email address for IATA agent’s bookings

For corporates that have non-IATA number, this element need not be passed as the eTicket confirmation email will only be sent to the customer’s email address. However, BA will record this email address to the booking if provided for non-IATA corporates

Address


Party/Sender/CorporateSender/Contacts/Contacts/EmailContact/Address

M

Corporate’s email address

Example: abc@tc.com

This is the requesting corporate’s email address

ID


Party/Sender/CorporateSender/ID

M

Corporate’s JBID

Example: IN3642FR

Unique ID provided by BA

IATA_Number


Party/Sender/CorporateSender/IATA_Number

O

Corporate’s IATA or non-IATA number

Example: 12345678

Do not populate this section if Travel Management Company (TMC) is creating a booking on behalf of the corporate

Note: This is an optional element in NDC schema. Populate this element with the requesting corporate’s IATA or non-IATA number only if the corporate is directly creating booking with BA via NDC Services

Participants



O

Specify Service Provider details

Note: This is an optional element in NDC schema but if the calling client is a Service Provider then Participants details must be populated. If the calling client is not a Service Provider then Participants details should not be populated.

Participant



M


TravelAgencyParticipant



O

Populate this section only if the participant is a Travel Management Company (TMC) and is creating a booking for the corporate customer i.e request is originated by the corporate

SequenceNumber (Attribute)


Party/Participants/Participant/TravelAgencyParticipant/SequenceNumber (Attribute)

M

Unique number

Example: 2

Note: It is recommended that each participant increment the sequence number by 1.

Example: If participant 1 gives sequence number as “2” participant 2 is advised to give sequence number as “3”

Contacts



O

This is an optional element in NDC schema. Populate this section with the requesting agent’s (TMC’s) email address only if the requesting agent is an IATA agent

Note: Agent contact will only be used in OrderCreate service. Therefore it is up to the client to pass agent email address in AirShopping, FlightPrice and SeatAvailability services

Contact



M


EmailContact



O

This is an optional element in NDC schema but for calling BA service (OrderCreate) this must be passed, if the requesting agent (TMC) is an IATA agent. This is important as the eTicket confirmation email will only be sent to this email address for IATA agent’s bookings

For non-IATA agents, this element need not be passed as the eTicket confirmation email will only be sent to the customer’s email address. However, BA will record this email address to the booking if provided for non-IATA agents (TMCs)

Address


Party/Participants/Participant/TravelAgencyParticipant/Contacts/Contact/ EmailContact/Address

M

Travel agency’s(TMC’s) email address

Example: abc@tc.com

This is the requesting agent’s email address

OtherIDs



O

Specify Non-IATA agent details

Note: This is an optional element in NDC schema but for calling BA services this must be passed if the requesting agent (TMC) is a non- IATA agent

OtherID


Party/Participants/Participant/TravelAgencyParticipant/OtherIDs/OtherID

M

TMC’s Non-IATA agent code

Example: 01010101

IATA_Number


Party/Participants/Participant/TravelAgencyParticipant/IATA_Number

O

Travel agent’s (TMC’s) IATA number

Example: 12345678

Note: This is an optional element in NDC schema but for calling BA services this must be passed if the requesting agent (TMC) is an IATA agent

AgencyID


Party/Participants/Participant/TravelAgencyParticipant/AgencyID

M

Travel agency name

Example: ABC

Note: This is a mandatory element in NDC schema but BA will neither use nor validate this element. A suggestion is to pass travel agency name

AggregatorParticipant



O

Populate this section only if the calling client is a Service Provider

SequenceNumber (Attribute)


Party/Participants/Participant/AggregatorParticipant/ SequenceNumber (Attribute)

M

Unique number

Example: 2

Note: It is recommended that each participant increments the sequence number by 1.

Example: If participant 1 gives sequence number as “2” participant 2 is advised to give sequence number as “3”

Name


Party/Participants/Participant/AggregatorParticipant/Name

O

Service Provider name

Example: XYZ

Note: This is an optional element in NDC schema. BA will neither use nor validate this element even if it was  passed

AggregatorID


Party/Participants/Participant/AggregatorParticipant/AggregatorID

M

Service Provider ID provided by BA

Example: 00123456

All BA NDC services will validate this ID and allow only if the AggregatorID provided is valid



 General Usage Guidelines

The AirShopping Service:

Calendar Recommendation:

General: