HolidayTaxis Supplier Connect API Documentation

Search Bookings by Departure Date

To search for bookings based on their departure date, the following url should be used as a base using a simple GET request:

HTTP GET: /bookings/search/departures

Results can be refined by passing additional parameters in the url. You can pass all or none of these parameters to achieve a required subset of results.

HTTP GET: /bookings/search/departures/since/:datefrom
HTTP GET: /bookings/search/departures/since/:datefrom/until/:dateto *
HTTP GET: /bookings/search/departures/page/:page

* use until in combination with since, e.g. /bookings/search/departures/since/2015-05-01T00:00/until/2015-05-10T00:00

Parameters

Parameter	Description	Value(s)	Required	Default Value
/since/:datefrom	:datefrom is the start date of your search	DateTime in ISO8601 format 'YYYY-MM-DDTHH:MM:SS' (in local departure date/time). e.g. 2015-05-14T09:30:00	No	Earliest arrival of any booking
/until/:dateto	:dateto is the end date of your search	DateTime in ISO8601 format 'YYYY-MM-DDTHH:MM:SS' (in local departure date/time). e.g. 2015-05-14T09:30:00	No	Latest arrival of any booking
/page/:page	:page is the page number if more than 20 bookings are matched.	Integer above 0	No	1

Example

HTTP GET: /bookings/search/departures/since/2015-04-01T00:00:00/until/2016-11-24T00:00:00/page/1

JSON Response

{
  "bookings": {
    "booking_0": {
      "ref": "HTX-4859500",
      "status": "PCON",
      "lastactiondate": "2015-04-01T10:42:28",
      "arrivaldate": "2015-04-14T11:00:00",
      "departuredate": "2015-04-17T21:45:00",
      "passengername": "MRS R BOOKER",
      "vehicle": "Speedy Shuttle",
      "link": "https://suppliers.holidaytaxis.com/bookings/HTX-4859500",
      "orderref": "abc123" Version 2023-06 or later only
    },
    "booking_1": {
      "ref": "HTX-4859501",
      "status": "PCON",
      "lastactiondate": "2015-04-02T10:42:28",
      "arrivaldate": "2015-04-15T11:00:00",
      "departuredate": "2015-04-18T21:45:00",
      "passengername": "MR C HERBERT",
      "vehicle": "Shuttle",
      "link": "https://suppliers.holidaytaxis.com/bookings/HTX-4859501",
      "orderref": "abc123" Version 2023-06 or later only
    },
    "more": "https://suppliers.holidaytaxis.com/bookings/search/departures/since/2015-04-01T00:00:00/until/2016-11-24T00:00:00/page/2"
  },
  "warnings": [
    "Example Warning"
  ] Version 2021-09 or later only
}

XML Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <bookings>
    <booking>
      <ref>HTX-4859500</ref>
      <status>PCON</status>
      <lastactiondate>2015-04-01T10:42:28</lastactiondate>
      <arrivaldate>2015-04-14T11:00:00</arrivaldate>
      <departuredate>2015-04-17T21:45:00</departuredate>
      <passengername>MRS R BOOKER</passengername>
      <vehicle>Speedy Shuttle</vehicle>
    <link>https://suppliers.holidaytaxis.com/bookings/HTX-4859500</link>
      <orderref>abc123</orderref> Version 2023-06 or later only
    </booking>
    <booking>
      <ref>HTX-4859501</ref>
      <status>PCON</status>
      <lastactiondate>2015-04-02T10:42:28</lastactiondate>
      <arrivaldate>2015-04-15T11:00:00</arrivaldate>
      <departuredate>2015-04-18T21:45:00</departuredate>
      <passengername>MRS C HERBERT</passengername>
      <vehicle>Shuttle</vehicle>
      <link>https://suppliers.holidaytaxis.com/bookings/HTX-4859501</link>
      <orderref>abc123</orderref> Version 2023-06 or later only
    </booking>
  </bookings>
  <more>https://suppliers.holidaytaxis.com/bookings/search/departures/since/2015-04-01T00:00:00/until/2016-11-24T00:00:00/page/2</more>
  <warnings>
    <warning>Example Warning</warning>
  </warnings> Version 2021-09 or later only
</response>