Skip to main content

Quickstart

This quickstart takes you from zero to a confirmed booking: quote → book → track.

1. Get your credentials​

You authenticate with a client id and client secret, passed together in the Authorization header in the format AL client_id:client_secret. See Authentication for the full details.

export QB_AUTH="AL your_client_id:your_client_secret"
export QB_BASE="https://external.api.addlee-sandbox.net/shamrock-qb3-adapter-service-v1/shamrock-qb3-adapter-service/qb3"

2. Request a price quote​

Ask for a quote for a journey between two points. You can request several services at once — here, a standard car and an executive car:

curl -X POST "$QB_BASE/v1/quote/price" \
  -H "Authorization: $QB_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
  "payment_method": "Account",
  "services": [
    {
      "code": "standard_car"
    },
    {
      "code": "exec_car"
    }
  ],
  "locations": [
    {
      "source": "Address",
      "street_address": "Barbican Centre, 10 Silk St",
      "town": "London",
      "postcode": "EC2Y 8DS",
      "country": "GB",
      "lat": 51.520024,
      "long": -0.092447
    },
    {
      "source": "Address",
      "street_address": "189 Earlsfield Road",
      "town": "London",
      "postcode": "SW18 3DD",
      "country": "GB"
    }
  ]
}'

A successful call returns a request_id and a quote_id for each service:

{
  "request_id": "158aba9c-e8c8-42cc-ae79-b9324899ac94",
  "quotes": [
    {
      "quote_id": "57ba81a3-2a5a-4d69-b5e3-8cea49d5dfbb",
      "service": "standard_car",
      "total_price": 30.00,
      "price": 30.00,
      "discount": 0,
      "vat": 0,
      "currency": "GBP",
      "eta": "00:10:00"
    }
  ]
}

3. Create a booking​

Book the quote you just received by passing its request_id, plus a contact with passengers for the journey:

curl -X POST "$QB_BASE/v1/booking/create" \
  -H "Authorization: $QB_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
  "request_id": "158aba9c-e8c8-42cc-ae79-b9324899ac94",
  "payment_method": "Account",
  "service": "standard_car",
  "contact": {
    "name": "Jane Doe",
    "mobile": "07700900123",
    "email": "jane.doe@example.com"
  },
  "passengers": [
    {
      "name": "Jane Doe",
      "mobile": "07700900123",
      "email": "jane.doe@example.com"
    }
  ]
}'

The response confirms the booking and returns its identifiers:

{
  "job_uuid": "36b5ffa8-61f0-11e5-9d70-feff819cdc9f",
  "job_number": "654321",
  "booking_status": "booked"
}

Keep the job_uuid — you use it to look up, amend, or cancel the booking.

Other ways to book: you can also book directly without a quote, or book a courier delivery with a contact at each stop. See Creating a booking for all three variants.

4. Check the booking detail​

curl "$QB_BASE/v1/booking/detail?job_uuid=36b5ffa8-61f0-11e5-9d70-feff819cdc9f" \
  -H "Authorization: $QB_AUTH"

Once a driver is allocated, the response includes their name, telephone, and vehicle.

5. Receive status updates​

Rather than polling, you'll receive booking status updates — ALLOCATED, ONWAY, ONBOARD, COMPLETED, live TRACKING, and more — pushed to your own endpoint as the job progresses. See Status webhooks to set that up.

Next steps​