HolidayTaxis Supplier Connect API Documentation

Retrieve Individual Booking

Basic Usage

In order to get the details of a booking, the following url must be used via a simple GET request (substituting :ref with a known booking reference in the format AAA(AA)-11111111):

HTTP GET: /bookings/:ref

Notes

To retrieve the notes for a booking, add /notes/ to the URL before the :ref as below:

HTTP GET: /bookings/notes/:ref

Parameters

Parameter	Description	Value(s)	Required
/notes/	Include this before :ref to return notes rather than booking details	N/A	No
:ref	:ref is the supplier reference for the booking, this will be 3-5 alphanumeric characters followed by a dash and 8 digits - AAA(AA)-11111111	Supplier reference: AAA(AA)-11111111	Yes

Response

Parameter	Description	Version
optionalextras	Lists the name and quantity of each optional extra included on the booking	2021-09
hasopenquery	Bookings in PCON or PAMM status that have an open query will display ‘Y’ as the response, all other bookings will have a blank response value.	2021-09
novehicles	The number of vehicles required for the booking. Note that this will not be included for per-person (shuttle) bookings	2022-06
bookingreference	This parameter represents the booking reference that the customer sees for their booking. It's a randomly generated string, unique to each booking, but shared across all legs of that booking.	2023-09

Example - Booking Data

HTTP GET: /bookings/ALH-4290672

JSON Response

{
  "booking": {
    "general": {
      "ref": "ALH-4290672",
      "status": "ACON",
      "bookingtype": "Single outbound only",
      "bookingreference": "BCKKAL", Version 2023-09 or later only
      "passengername": "Mr ANDREW FOX",
      "passengertelno": "+447123456789",
      "airport": "Alicante Airport",
      "airportcode": "ALC",
      "resort": "Benidorm",
      "vehicle": "Speedy Shuttle",
      "pax": null,
      "adults": 2,
      "children": 0,
      "infants": 0,
      "language": "en",
      "datebooked": "2015-04-01T20:12:55",
      "novehicles": 1, Version 2022-06 or later only
      "orderref": "abc123" Version 2023-06 or later only
    },
    "arrival": {
      "fromairport": "Alicante Airport",
      "fromairportcode": "ALC",
      "flightno": "LS271",
      "arrivaldate": "2015-06-20T11:15:00",
      "accommodationname": "Perla",
      "accommodationaddress1": "CL LEPANTO 18",
      "accommodationaddress2": null,
      "accommodationaddress3": "Playa Levante",
      "accommodationtel": "34 96 585 23 05"
      "optionalextras ": [
        {
             "extra ":  "Child Seat (9 - 18kg, 20 - 40lb, 9mths - 4yr) ",
             "quantity ": 2
        }
      ] Version 2021-09 or later only
    },
    "notes": "https://suppliers.holidaytaxis.com/bookings/notes/ALH-4290672",
    "hasopenquery":"Y", Version 2021-09 or later only
  },
  "warnings": [] Version 2021-09 or later only
}

XML Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <booking>
    <general>
      <ref>ALH-4290672</ref>
      <status>ACON</status>
      <bookingtype>Single outbound only</bookingtype>
      <bookingreference>EQS2SE</bookingreference> Version 2023-09 or later only
      <passengername>Mr ANDREW FOX</passengername>
      <passengertelno>+447123456789</passengertelno>
      <airport>Alicante Airport</airport>
      <airportcode>ALC</airportcode>
      <resort>Benidorm</resort>
      <vehicle>Speedy Shuttle</vehicle>
      <pax />
      <adults>2</adults>
      <children>0</children>
      <infants>0</infants>
      <language>en</language>
      <datebooked>2015-04-01T20:12:55</datebooked>
      <novehicles>1</novehicles> Version 2022-06 or later only
      <orderref>abc123</orderref> Version 2023-06 or later only
    </general>
    <arrival>
      <fromairport>Alicante Airport</fromairport>
      <fromairportcode>ALC</fromairportcode>
      <flightno>LS271</flightno>
      <arrivaldate>2015-06-20T11:15:00</arrivaldate>
      <accommodationname>Perla</accommodationname>
      <accommodationaddress1>CL LEPANTO 18</accommodationaddress1>
      <accommodationaddress2 />
      <accommodationaddress3>Playa Levante</accommodationaddress3>
      <accommodationtel>34 96 585 23 05</accommodationtel>
      <optionalextras>
        <optionalextra>
            <extra>Child Seat (9 - 18kg, 20 - 40lb, 9mths - 4yr)</extra>
            <quantity>2</quantity>
        </optionalextra>
      </optionalextras> Version 2021-09 or later only
    </arrival>
    <notes>https://suppliers.holidaytaxis.com/bookings/notes/ALH-4290672</notes>
    <hasopenquery>Y</hasopenquery> Version 2021-09 or later only
  </booking>
</response>

Example - Notes

If you pass the notes suffix in the url the below response will be received

HTTP GET: /bookings/notes/ALH-4290672

JSON Response

{
  "notes": {
    "note_0": {
      "notedate": "2015-04-02T08:31:50",
      "user": "Supplier: Nevada Agullo",
      "note": "Confirmed Booking",
      "flightnoquery": 0,
      "wrongresort": 0
    }
  },
  "booking": "https://suppliers.holidaytaxis.com/bookings/ALH-4290672",
  "warnings": [
    "Example Warning"
  ] Version 2021-09 or later only
}

XML Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <notes>
    <note>
      <notedate>2015-04-02T08:31:50</notedate>
      <user>Supplier: Nevada Agullo</user>
      <note>Confirmed Booking</note>
      <flightnoquery>0</flightnoquery>
      <wrongresort>0</wrongresort>
    </note>
  </notes>
  <booking>https://suppliers.holidaytaxis.com/bookings/ALH-4290672</booking>
  <warnings>
    <warning>Example Warning</warning>
  </warnings> Version 2021-09 or later only
</response>