Additional Information¶

Booking status¶

Status	Description
NEW	A new booking has been created by a customer and is yet to be accepted by the assigned supply partner.
ACCEPTED	The booking has been accepted by the supply partner.
DRIVER_ASSIGNED	A driver has been assigned to the booking by the supply partner.
PENDING_AMENDMENT	Indicates the customer has amended the booking which should be accepted or rejected.
PENDING_CANCELLATION	Indicates a customer cancellation, the cancellation should be accepted.
CANCELLED	Indicates the booking has been either cancelled by the customer or rejected by the supply partner.
COMPLETE	Indicates the booking has been completed, active bookings will be automatically transitioned to this status 6 hours after pickup time.

Warning

Rejecting a booking counts as a "Decline" and impacts your quality metrics. Target: decline rate below 1%. See Quality Expectations.

Status transitions¶

The booking status can be transitioned by accepting or rejecting a booking, the following table describes how a booking will transition between states when accepted or rejected:

Status	Booking Accepted	Booking Rejected
NEW	The booking will transition to ACCEPTED.	The booking will be declined.
ACCEPTED	Not applicable.	The booking will transition to CANCELLED.
DRIVER_ASSIGNED	Not applicable.	The booking will transition to CANCELLED.
PENDING_AMENDMENT	The booking will revert to its prior status (either ACCEPTED or DRIVER_ASSIGNED)	The booking will transition to CANCELLED.
PENDING_CANCELLATION	The booking will transition to CANCELLED.	Not applicable.
CANCELLED	Not applicable.	Not applicable.
COMPLETE	Not applicable.	Not applicable.

Cancellation reasons¶

Cancellation Reason	Description
CANT_FULFILL_CUSTOMER_REQUEST	Specific customer request which cannot be fulfilled (not child seat or extra stop related).
CHILD_SEAT_INCOMPATIBLE_VEHICLE	The car type cannot accommodate the number of child seats requested.
CHILD_SEAT_UNAVAILABLE	You do support child seats but do not have one available for this ride.
CHILD_SEAT_UNSUPPORTED	You do not support the supply of car seats. (If returned, we expect this for all rides where a car seat is requested.)
EXTRA_STOP	Additional stops are requested and cannot be fulfilled.
FORCE_MAJEURE	Circumstance beyond reasonable control (e.g. natural disaster, earthquake).
INCOMPLETE_BOOKING_DETAILS	Missing booking details such as phone number. Do not use for incorrect addresses or missing flight numbers.
INCORRECT_ADDRESS	The address is incorrect or incomplete.
LEAD_TIME_TOO_SHORT	The lead time is too short to fulfill.
MISSING_FLIGHT_NUMBER	No flight number and flight cannot be tracked from details given.
NO_AVAILABILITY	No availability to cover the ride.
RATE_ERROR	Error with the rate offered for the ride.
ROAD_CLOSURE	Ride cannot be fulfilled due to a road closure.
OTHER	Any other reason not covered above.

State hash¶

We use a state hash to ensure any updates being provided are to the latest version of the booking.

If the hash provided matches the latest version, the response will be processed and the state of the booking updated to reflect the change. Should the state hash not match the latest available booking data, a 400 Bad Request response will be returned, and you should perform a GET request to retrieve the latest version of the booking before attempting to perform any further updates.

The state hash changes when any of the following fields are modified:

Booking Reference
Pickup Location
Dropoff Location
Pickup Date Time
Vehicle Type
Passenger Count
Passenger Details
Flight Number

Note

The state hash does not change when the booking state transitions to CANCELLED, DECLINED, DRIVER_ASSIGNED, or ACCEPTED.

Pagination¶

We paginate booking data with a default page size of 400 bookings (maximum 500). You can specify the page size using the size URL parameter as described in the API reference. The response will contain a link to retrieve the next page of bookings in the links array, for example:

"links": [
    {
        "rel": "next",
        "href": "/v1/bookings?size=10&after=1588666221733",
        "type": "GET"
    }
]

In the above example, calling the endpoint provided in the href value would retrieve the next page of results.

Note

Bookings are returned in booked_date descending order (newest first).

Converting timezones¶

We return pickup times in UTC+0 for all bookings. In order to display the pickup time in the local timezone, the pickup_date_time will need to be converted using the pickup_date_time_zone.

Booking amendments¶

Plans change and sometimes our travellers need to update the details of an existing booking. These changes will cause the booking to go into the PENDING_AMENDMENT status but will remain allocated to you.

The table below shows which fields can be amended:

Field Amended	Can be updated via amendment
Pick-up time	Yes
Pick-up date	Yes
Pick-up location	No
Drop-off location	No
Passenger name	Yes
Passenger contact number	Yes
Flight number	Yes
Passengers	Yes