Hotel Packages
The Hotel Packages returns a list of hotel and flight offers for the destination and departure date specified.
The latest version number of the Hotel Packages hotelPackages resource is v1.
Version Information
The most recent version of the Hotel Packages API is version 1. Previous versions are shown below.
| Version | Status | End-of-life date |
|---|---|---|
| v1.0 | Current | N/A |
API Endpoints
Hotel Packages has a REST API endpoint. Click here for more information on using British Airways Rest APIs.
The endpoints available are:
| Endpoint | URL |
|---|---|
| Live | https://api.ba.com/rest-v1/v1/hotelPackages |
| Test | N/A |
API Methods
| Method | URL Resource | Description |
|---|---|---|
| GET | hotelPackages;origin=LHR;destination=YYZ;departureDate=2014-03-14T12:00:00Z; | Returns flight + hotel package offers for the desired departure date when from and to locations are specified. |
| GET | hotelPackages;origin=LHR;destination=NCL;departureDate=2014-03-14T12:00:00Z;checkInDate=2014-03-14T12:00:00Z; | Returns flight + hotel package offers for the desired departure and check-in dates when from and to locations are specified. |
| GET | hotelPackages;origin=LHR;destination=JFK;departureDate=2014-03-14T12:00:00Z;checkInDate=2014-03-14T12:00:00Z;returnDate=2014-03-28T12:00:00Z; | Returns flight + hotel package offers for the desired departure/return and check-in dates when from and to locations are specified. |
| GET | hotelPackages;origin=LHR;destination=BCN;departureDate=2014-03-14T12:00:00Z;duration=2; | Returns flight + hotel package offers for the desired departure date and duration when from and to locations are specified. |
| GET | hotelPackages;origin=LHR;destination=JFK;departureDate=2014-03-14T12:00:00Z;stars=5.0; | Returns flight + hotel package offers for the desired departure date and star rating of the hotel when from and to locations are specified. |
| GET | hotelPackages;origin=LHR;destination=ORY;departureDate=2014-03-14T12:00:00Z;returnDate=2014-03-28T12:00:00Z;checkInDate=2014-03-14T12:00:00Z;duration=1;stars=5.0; | Returns flight + hotel package offers for the desired departure/return, check-in date, duration and star rating of the hotel when from and to locations are specified. |
HTTP Headers
| Header Name | Description | Mandatory? | In/Outbound | Example |
|---|---|---|---|---|
| client-key | Your unique key used to authorise access to the API. | Yes | Inbound | n/a |
Search Parameters
The various search parameters are described below:
| Name | Description | Format | Default | Example | Allowed values |
|---|---|---|---|---|---|
| origin | Origin location of flight journey | IATA 3 character airport code | N/A | LHR | Valid British Airways served airports |
| destination | Destination location of flight journey | IATA 3 character airport code | N/A | JFK | Valid British Airways served airports |
| departureDate | Departure date of flight | YYYY-MM-DDTHH:MM:SSZ | N/A | 2014-03-14T12:00:00Z | => today and <= today + 365 time is ignored |
| returnDate | Return date of flight | YYYY-MM-DDTHH:MM:SSZ | N/A | 2014-03-28T12:00:00Z | => today and <= today + 365 |
| checkInDate | Date of Check-in | YYYY-MM-DDTHH:MM:SSZ | N/A | 2014-03-14T12:00:00Z | => today and <= today + 365 |
| checkOutDate | Date of Check-out | YYYY-MM-DDTHH:MM:SSZ | N/A | 2014-03-28T12:00:00Z | => today and <= today + 365 |
| duration | Duration of stay at hotel | numeric | N/A | 7 | Any single digit number |
| stars | Star rating of the hotel | numeric | N/A | 5 | Any single digit number |
stars, returnDate, checkInDate, checkOutDate, duration are optional.
Supported Status Codes
You can view the standard status codes returned by our APIs here.