HolidayTaxis Supplier Connect API Documentation

Last Updated: January 2025, Documentation Revision: 2.5

Introduction

HolidayTaxis Supplier Connect is an API for transfer companies that require an easy way to connect to HolidayTaxis and retrieve booking information. It is based on a RESTFul approach and accepts requests/returns responses in both JSON and XML.

The details of the individual requests and response formats are automatically generated from an OpenAPI 3.1 Description (direct download in YAML format).

Change Log

Information on changes, and available API versions, can be found in the Change Log

Endpoints

Environment URL Comments
Test https://suppliers.htxstaging.com Please note that our Test environment can contain different data to our Production environment.
Production https://suppliers.holidaytaxis.com

Supported Protocols: TLS 1.3, TLS 1.2

Authentication

In order to connect to Holiday Taxis Supplier Connect you will need to be issued with an API Key.

This API Key must be sent alongside every request in the form of a HTTP header named API_KEY.

API keys:

Example HTTP header:

API_KEY: htscon_a00ab74fdcd5fbdb91be31165d503f33f137587539a03bdd67e48f87c1ff1cd100dbd5196a54b4ec

Rate Limits

All GET requests are subject to a rate limit of 400 requests per minute per Supplier. Exceeding this limit will result in HTTP 429 Too Many Requests responses until the rate resets.

Versioning

In order to use the latest features you will need to send a HTTP Header named VERSION with a value set to the version date you wish to use in the format YYYY-MM eg. "2025-01"

This field is optional and if not set, you will default to the earliest version. Fields and Parameters limited to certain versions will be marked in the documentation and you will be able to find the latest version numbers in the Change Log

Response Format

Holiday Taxis Supplier Connect can return results / responses in two formats: JSON and XML.

In order to specify the request/response format you must set the Accept HTTP header on all requests to be one of the following:

For POST and PUT requests, you must also set the HTTP Content-Type header to the same value. Holiday Taxis Supplier Connect will return a response in the same format as the submitted data.

Dates and Times

Most dates and times in input and output are represented in the format YYYY-MM-DD\Thh:mm:ss, e.g. 2025-12-16T14:00:00, and must not include a time zone.

Times related to the customer's travel (e.g. departure, arrival, and pickup times) are treated as local time in the time zone where the transfer is located.

Times referring to the creation, amendment and cancellations of bookings are treated as having no location and use the time zone UTC (+00:00).

Bookings

In order for transfer companies to effectively manage their vehicles, HolidayTaxis understands that the scheduling of their bookings is extremely important. In order to ensure all booking updates are received by our partners, we recommend retrieving bookings based on their last action date. By using this function consistently and regularly, partners will not miss any create, modify or cancel actions. For example if you continuously search by last action date between now and the time you last ran the retrieval, then there is no risk of missing any updates. We recommend calling the API every hour, and using the dateFrom parameter in the URL only, to return all bookings updated in the last hour until now. See Search by Last Action Flow for a visual representation.

In addition to this, this service also allows bookings to be retrieved based on their arrival date at key transportation gateways such airports, ports, train stations and bus stops as well as based on their departure date at hotels, resorts and other points of interest.

In order to maintain the high level of customer service which is synonymous with HolidayTaxis, it is key to communicate efficiently with our partners. This service allows HolidayTaxis and our partners to leave notes on bookings regarding potential clerical errors and customer service issues.

Driver Events

Transfer companies will use this service to send key information such as driver contact details & tracking data directly to HolidayTaxis systems, which is then available in a customer portal. This will improve operational efficiency for suppliers, and provide an enhanced customer experience, reducing no-shows and customer complaints.

If you are planning to start sending any Driver Events data, please kindly inform spm@holidaytaxis.com.

Driver Events Booking Flow

Services

The following services are available: