Taxi Supplier API

Home

References

Receiving a booking

To receive new bookings via our webhooks, you need to implement the following:

POST /v2/bookings

Payload Fields

Fields Type Description Required
bookingReference String The booking reference. Yes
customerReference String The customer reference. Yes
searchResultId String A UUID representing the search result with a maximum length of 100 characters.
This field is mandatory for suppliers that only provide rates via the API.		 No
title String The lead passengers title. Yes
firstName String The lead passengers first name. Yes
lastName String The lead passengers last name. Yes
phoneNumber String The lead passengers phone number in E.164 format. Yes
customerId String A state hash ID calculated from the lead passenger details. Yes
flightNumber String The flight number (airport pickups only). No
comment String Comments provided by the lead passenger. No
services Array An array containing name & value objects for services requested. Currently supported services:

meetAndGreet		 Yes

Sample Payload

{
    "bookingReference": "44225562",
    "customerReference": "87654321",
    "searchResultId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "leadPassenger": {
        "title": "Mr",
        "firstName": "John",
        "lastName": "Doe",
        "phoneNumber": "+441632960881",
        "customerId": "191e8c71a3f2c19092baf027a96962989493c07a5dadb146b73df653c837a2fa"
    },
    "flightNumber": "BA123",
    "comment": "Need a pet friendly car",
    "services": [
        {
            "name": "meetAndGreetMessage",
            "value": "Welcome John Doe"
        }
    ]
}

Response Fields

Fields Type Description Required
supplierBookingId String The suppliers booking ID. This field is mandatory for suppliers that only provide rates via the API. No

Response Sample

{
  "supplierBookingId":"1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed"
}

Responses

HTTP 204 - No Content

HTTP 4xx - Client error - Error response format

HTTP 5xx - Server error - Error response format

Receiving a booking update

To receive a booking updates via our webhooks, you need to implement the following:

PATCH /v2/bookings/:bookingReference

Payload Fields

Fields Type Description Required
title String The lead passengers title. Yes
firstName String The lead passengers first name. Yes
lastName String The lead passengers last name. Yes
phoneNumber String The lead passengers phone number. Yes
comment String Comments provided by the lead passenger. Yes
flightNumber String The flight number (airport pickups only). Yes
pickupDateTime String The pickup timestamp in UTC (ISO 8601) Yes
services Array An array containing name & value objects for services requested. Currently supported services:

meetAndGreet		 Yes
action String The action carried out, one of the following:

AMENDMENT
CANCELLATION		 Yes
cancellationReason String The cancellation reason. Yes

Sample Payload

{
    "leadPassenger": {
        "title":"Mr",
        "firstName":"John",
        "lastName":"Doe",
        "phoneNumber":"+441632960881"
    },
    "comment":"Need a pet friendly car",
    "flightNumber":"BA123",
    "pickupDateTime":"2021-12-07T12:30:00Z",
    "services":[
        {
            "name":"meetAndGreetMessage",
            "value":"Welcome John Doe"
        }
    ],  
    "action" : "AMENDMENT",
    "cancellationReason": ""
}

Responses

HTTP 204 - No Content

HTTP 4xx - Client error - Error response format

HTTP 5xx - Server error - Error response format

Is this page helpful?    Yes   |    No