Car Packages
The Car Packages service returns a list of car rental and flight offers for the destination and departure date specified.
The latest version number of the Car Packages carPackages resource is v1.
Version Information
The most recent version of the Car Packages API is version 1. Previous versions are shown below.
| Version | Status | End-of-life date |
|---|---|---|
| v1.0 | Current | N/A |
API Endpoints
Car 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/carPackages |
| Test | N/A |
API Methods
| Method | URL Resource | Description |
|---|---|---|
| GET | carPackages;origin=LHR;destination=NCL;departureDate=2014-03-16T12:00:00Z; | Returns flight + car package offers for the desired origin and destination on a specified departure date. |
| GET | carPackages;origin=LHR;destination=NCL;departureDate=2014-03-16T12:00:00Z;returnDate=2014-03-26T12:00:00Z | Returns flight + car package offers for the desired origin and destination on a specified departure and return date. |
| GET | carPackages;origin=LHR;destination=NCL;departureDate=2014-03-16T12:00:00Z;returnDate=2014-03-26T12:00:00Z;pickUpDate=2014-03-16T12:00:00Z" | Returns flight + car package offers for the desired origin and destination on a specified departure/return and pick-up date. |
| GET | carPackages;origin=LHR;destination=JFK;departureDate=2014-03-16T12:00:00Z;returnDate=2014-03-26T12:00:00Z;pickUpDate=2014-03-16T12:00:00Z;dropOffDate=2014-03-26T12:00:00Z | Returns flight + car package offers for the desired origin and destination on a specified departure/return and pick-up/drop-off date. |
| GET | carPackages;origin=LHR;destination=NCL;departureDate=2014-03-16T12:00:00Z;returnDate=2014-03-26T12:00:00Z;pickUpDate=2014-03-16T12:00:00Z;dropOffDate=2014-03-26T12:00:00Z;cabinCodeOutbound=M;cabinCodeInbound=M | Returns flight + car package offers for the desired origin and destination on a specified departure/return,pick-up/drop-off date along with cabin details. |
| GET | carPackages;origin=LHR;destination=NCL;departureDate=2014-03-16T12:00:00Z;returnDate=2014-03-26T12:00:00Z;pickUpDate=2014-03-16T12:00:00Z;dropOffDate=2014-03-26T12:00:00Z;cabinCodeOutbound=M;cabinCodeInbound=M;type=Automatic | Returns flight + car package offers for the desired origin and destination on a specified departure/return,pick-up/drop-off date along with cabin details and type. |
| GET | carPackages;origin=LHR;destination=NCL;departureDate=2014-03-16T12:00:00Z;returnDate=2014-03-26T12:00:00Z;pickUpDate=2014-03-16T12:00:00Z;dropOffDate=2014-03-26T12:00:00Z;cabinCodeOutbound=M;cabinCodeInbound=M;groupIdentifier=A; | Returns flight + car package offers for the desired origin and destination on a specified departure/return,pick-up/drop-off date along with cabin details and groupIdentifier. |
| GET | carPackages;origin=LHR;destination=NCL;departureDate=2014-03-16T12:00:00Z;returnDate=2014-03-26T12:00:00Z;pickUpDate=2014-03-16T12:00:00Z;dropOffDate=2014-03-26T12:00:00Z;cabinCodeOutbound=M;cabinCodeInbound=M;groupIdentifier=A;type=Manual | Returns flight + car package offers for the desired origin and destination on a specified departure/return,pick-up/drop-off date along with cabin details, type and groupIdentifier. |
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 |
|---|---|---|---|---|---|
| destination | Destination where car is required for hire | IATA 3 character city code | N/A | MIA | Valid British Airways served airports |
| departureDate | Date of onward flight | YYYY-MM-DDTHH:MM:SSZ | N/A | 2014-03-10T12:00:00Z | => today and <= today + 365 |
| returnDate | Date of return flight | YYYY-MM-DDTHH:MM:SSZ | N/A | 2014-03-10T12:00:00Z | => today and <= today + 365 |
| pickUpDate | Date from when on you need the car | YYYY-MM-DDTHH:MM:SSZ | N/A | 2014-03-10T12:00:00Z | => today and <= today + 365 |
| dropOffDate | Date till when you need the car | YYYY-MM-DDTHH:MM:SSZ | N/A | 2014-03-10T12:00:00Z | => today and <= today + 365 |
| duration | Number of days car is required | Numeric | N/A | 2 | Any number |
| cabinCodeOutbound | CabinCode of outbound journey | char | N/A | M | Any valid cabin code |
| cabinCodeInbound | CabinCode of inbound journey | char | N/A | M | Any valid cabin code |
| type | Type of the car required | Text | N/A | Automatic | Automatic / Manual |
| groupIdentifier | Group of the car required | char | N/A | V | Any valid group Identifier |
returnDate, cabinCodeOutbound, cabinCodeInbound, type, groupIdenitifer are optional.
Either drop-off Date or duration must be specified.
Supported Status Codes
You can view the standard status codes returned by our APIs here.