Latest API Changes¶

13th February 2025¶

• Updated documentation to clarify response handling for null & non-genius cases in the search webhook

20th January 2025¶

• Updated documentation to include support for Genius parameters in search webhook.

30th December 2024¶

• Updated documentation to include BOOKING webhook in self-enrolment.

19th December 2024¶

• Updated documentation to include information about Webhook Deletion endpoint.

17th December 2024¶

• Removed documentation on v1 AssignDriver endpoint since it was deprecated.

3rd December 2024¶

• Updated documentation to include information about Webhook Registration endpoint.

23rd September 2024¶

• Updated documentation to include information about Incident webhooks, self-enrolment endpoint and webhook error responses.

23rd August 2024¶

• Fixed typo in the Incidents response documentation.

15th August 2024¶

• Updated documentation to include Survey and Incident endpoint information.

1st August 2024¶

• Removed customerPrice from documentation to reflect that it is no longer returned from APIs.

27th June 2024¶

• Updated documentation to reflect that the driver ID can now be assigned using the v2 assign driver endpoint.

26th March 2024¶

• Updated documentation to reflect the change in default page size and default pickUpDateAfter for get all bookings endpoint.

18 March 2024¶

• Updated documentation to reflect pickupImages description and altText are not compulsory fields.

11 December 2023¶

• Added ability to send pickup images for meeting points.
• Updated meeting point documentation to give more clarity around required fields.

17 October 2023¶

• Added new decline reasons for /v1/responses.
• Updated documentation to add description for both new and previous decline reasons.
• Updated documentation to add extra info for pickup time in search webhook, get bookings and get a single booking endpoints.
• Updated documentation to add extra info to Booking amendments table description.
• Removed Cancel & Rebook column and amended Pick-up time and Pick-up date field values for Booking Updated scenario in Booking amendments table.

22 August 2023¶

• Added rate limiting to the Get All Bookings endpoint. This now returns 429 Too Many Requests when too many requests are made in a short period of time.

30 March 2023¶

• The "pickupInstructions" field length limit for /v1/meetingPoint was increased to 1000.

8 November 2022¶

• Added ELECTRIC_STANDARD and ELECTRIC_LUXURY vehicle types to search webhook, and dispatch API get bookings endpoints.

30 September 2022¶

• Added v2 assign driver endpoint.
• Deprecated v1 assign driver.

22 August 2022¶

• Add customerOriginalPrice field for get booking endpoints.
• Remove email from booking webhook payload.

8 June 2022¶

• Update driver event reference to indicate that apart from DRIVER_LIVE_LOCATION duplicate events will not be processed.

30 May 2022¶

• Updated documentation for retrieve all bookings endpoint and search webhook.

6 May 2022¶

• The Sandbox search webhook validation endpoint now requires the supplier url and oauth credentials to be provided as HTTP headers.

9 March 2022¶

• It's now possible to send meeting points and pickup instructions for bookings.

24 January 2022¶

• Add customerPrice and customerCurrency to GET /v1/bookings in the price object.

11 January 2022¶

• Sandbox documentation refresh.
• Rates Search Validation Endpoint is now available for testing Search Webhook implementation.

5th January 2022¶

• Live driver tracking is now available.

2nd December 2021¶

• Booking webhooks are now available.
• driver_id optional when sending driver events.

18th June 2021¶

• A bug was fixed in the /v1/bookings endpoint which caused some bookings to be missing when paging results.
• The "page" parameter for /v1/bookings has been deprecated in favor of "after" and the documentation updated accordingly.

15th June 2021¶

• The "changed" parameter for /v1/bookings has been deprecated and is no longer recommended for use.