Skip to main content

Introduction

Welcome to the Addison Lee Quickbook API (QB3) developer documentation.

The Quickbook API introduces your application to ours through a simple, predictable REST interface. Use it to display estimated pick-up times, return price quotes, and book passenger cars and courier deliveries on demand — or up to three months in advance. Once a booking is made, Addison Lee pushes real-time status updates (allocation, driver on the way, completion, pricing, live tracking) to an endpoint you host.

What you can do​

  • Quote a journey — get prices and ETAs for one or more services.
  • Estimate pick-up times for ASAP journeys, and list bookable time slots for scheduled ones.
  • Book a journey directly or against a quote, then amend or cancel it.
  • Look up a booking's live detail, including the allocated driver and vehicle.
  • Discover the products (services) configured for an account.
  • Receive asynchronous booking status webhooks on your own endpoint.

How the docs are organized​

The documentation has three connected surfaces:

  • Guides (the section you're reading) — conceptual, cross-cutting topics that apply to the whole API: authentication, errors, rate limits, transaction IDs, versioning, and status webhooks.
  • API Reference — an interactive, endpoint-by-endpoint reference for the order API (quotes, bookings, products), generated from our OpenAPI specification. Try requests, browse schemas, and copy code samples there.
  • Webhooks — the reference for the outbound status messages Addison Lee sends to your endpoint as a booking progresses.

Use the Guides to understand how the API behaves, and the references to look up the exact shape of each message.

Base URL​

EnvironmentBase URL
Productionhttps://external.addlee-api.co.uk/shamrock-qb3-adapter-service-v1/shamrock-qb3-adapter-service/qb3
Sandboxhttps://external.api.addlee-sandbox.net/shamrock-qb3-adapter-service-v1/shamrock-qb3-adapter-service/qb3

Next steps​