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 should be sent alongside every request in the form of a HTTP header named API_KEY.

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. "2021-09"

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.

YIn order to specify the request/response format you must set both the Content-Type and Accept HTTP Headers of your request to be one of the following:

For POST requests, Holiday Taxis Supplier Connect will always return a response in the same format as the included POST 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. 2018-08-20T14: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 aid our partners, this service 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:

Dictionary

Below is a list of common terms, request elements and response elements used throughout the API and short explanations about each one.

Field Name Description
bookings Contains an array of 'booking' results (see below)
booking Contains details of an individual booking.
arrival Contains details of the outbound part of a booking (gateway to accommodation).
departure Contains details of the inbound part of a booking (accommodation to gateway).
quote Contains details of the pickup and drop-off addresses for the quote booking.
ref This is the booking reference number. In the following format (ABC-1234567)
orderref The reference used by the affiliate client or travel agency that made the booking
status The current status of the booking, can be one of the following:
Status Code Status
PCON Pending Booking Voucher
ACON Booking Voucher Approved
PAMM Pending Amendment
AAMM Amendment Approved
PCAN Pending Cancellation
ACAN Cancellation Approved
passengername This is the name of the lead passenger travelling on the booking.
bookingtype This defines the type of booking, can be one of the following:
Booking Types
Return transfer
Single outbound only
Single return only
Quote
airport This is the gateway associated to the booking, this doesn't have to be an airport, it can be a port, train station, or bus stop in some cases.
resort This is the destination associated to the booking. Resort typically relates to a town/city, generally the town/city which the passenger's accommodation resides. However in some cases, this may be another gateway such as an airport, port or train station.
vehicle The vehicle requested by the passenger. E.g. Shuttle, Private Taxi or Minibus.
pax The total number of passengers travelling on the booking.
adults The number of adults travelling on the booking.
children The number of children travelling on the booking.
infants The number of infants travelling on the booking.
datebooked The date and time in which the booking was made, in the following format: 'YYYY-MM-DDTHH:MM:SS' (in UTC)
language The language the booking was made in, using a 2 letter language code. E.g. en, fr, es, de, etc.
fromairport The originating airport of the passengers flight due to arrive at the airport associated to the booking (described above) on the arrival date.
fromairportcode The 3 letter IATA Code for the 'fromairport' (above)
toairport The destination airport of the passengers flight due to depart the airport associated to the booking (described above) on the departure date.
toairportcode The 3 letter IATA Code for the 'toairport' (above)
flightno The flight number of the either the passengers arrival or departing flight. (Depending on whether it is included in the 'arrival' or 'departure' section.)
shipname The name of the ship on which the passenger is arriving or departing. (Depending on whether it is included in the 'arrival' or 'departure' section.)
cruiseline The name of the cruiseline on which the passenger is arriving or departing. (Depending on whether it is included in the 'arrival' or 'departure' section.)
cruiseterminal The terminal name of the cruise port at which the passenger is arriving or departing. (Depending on whether it is included in the 'arrival' or 'departure' section.)
trainnumber The train number which the passenger is arriving or departing on. (Depending on whether it is included in the 'arrival' or 'departure' section.)
busnumber The bus number which the passenger is arriving or departing on. (Depending on whether it is included in the 'arrival' or 'departure' section.)
arrivaldate The date and time on which the passengers flight, cruise ship, train or bus will arrive at the 'airport' associated to the booking, in the following format: 'YYYY-MM-DDTHH:MM' (in the local time zone of the transfer)
departuredate The date and time on which the passengers flight, cruise ship, train or bus will leave the 'airport' associated to the booking, in the following format: 'YYYY-MM-DDTHH:MM:SS' (in the local time zone of the transfer)
pickupdate The date and time on which the passenger will be picked up from the 'resort' associated to the booking in order for them to arrive at the 'airport' on time, in the following format: 'YYYY-MM-DDTHH:MM:SS' (in the local time zone of the transfer)
accomodationname The name of the accommodation or building at which the passengers will be picked up and dropped off. (Depending on whether it is included in the 'arrival' or 'departure' section.)
accommodationaddress1 The first line of the address of the accommodation or building at which the passengers will be picked up and dropped off. (Depending on whether it is included in the 'arrival' or 'departure' section.)
accommodationaddress2 The second line of the address of the accommodation or building at which the passengers will be picked up and dropped off. (Depending on whether it is included in the 'arrival' or 'departure' section.)
accommodationaddress3 The third line of the address of the accommodation or building at which the passengers will be picked up and dropped off. (Depending on whether it is included in the 'arrival' or 'departure' section.)
accommodationtel The telephone number of the accommodation or building at which the passengers will be picked up and dropped off. (Depending on whether it is included in the 'arrival' or 'departure' section.)
newpickupaccom The new name of accommodation or building at which the passengers will be picked up in departure section
newpickupaddress1 The new first line of the address of the accommodation or building at which the passengers will be picked up in departure section
newpickupaddress2 The new second line of the address of the accommodation or building at which the passengers will be picked up in departure section
newpickupaddress3 The new second line of the address of the accommodation or building at which the passengers will be picked up in departure section
transferdate Relating to quote bookings only. This is the date and time at which the passenger will be picked up from the address defined below in the 'pickupaddress1', 'pickupaddress2', 'pickupaddress3' and 'pickupaddress4' fields, in the following format: 'YYYY-MM-DDTHH:MM:SS' (in the local time zone of the transfer)
pickupaddress1 The first line of the address at which the passengers will be picked up from.
pickupaddress2 The second line of the address at which the passengers will be picked up from.
pickupaddress3 The third line of the address at which the passengers will be picked up from.
pickupaddress4 The fourth line of the address at which the passengers will be picked up from.
dropoffaddress1 The first line of the address at which the passengers will be dropped off at.
dropoffaddress2 The second line of the address at which the passengers will be dropped off at.
dropoffaddress3 The third line of the address at which the passengers will be dropped off at.
dropoffaddress4 The fourth line of the address at which the passengers will be dropped off at.
notes Contains an array of 'note' results (see below)
note Contains details of an individual note.
notedate The date the note was added to the booking (in UTC).
notecontent The written note itself.
hasopenquery Indicates a booking as a query that is unresolved. "Y" if, one is present, otherwise empty
flightnoquery Indicates that the 'flightno' on the booking is incorrect, incomplete or missing. Accepted values are 1 or 0. If set to 1, 'notecontent' can be left empty.
wrongresort Indicates that the 'resort' associated to the booking is incorrect. Accepted values are 1 or 0. If set to 1, 'notecontent' must contain an explanation of what is wrong, and which resort should be associated to the booking.
addedby Indicates whether it was HolidayTaxis or a partner that added the note. The name of the person that left the note will also be included (determined by which credentials are sent via this service.)
link If only a summary of an item is returned, then this returns the location of the full details. E.g. when requesting a list of bookings travelling between particular dates, we only return a small amount of information about each booking. This link, if followed will return the full booking details.
more When more than 10 items are matched by a method, we include this field. This contains the location for the next 10 items that are matched. This is designed to allow each response to be small and lightweight. If this field is not included in the response then there are no more matches.
warnings May contain messages about requests which, whilst they may not error, may produce unintended results or may be unsupported in the future