Set Booking Status

After placing a test booking, and only for the purposes of modifying test bookings, you can modify a booking status via the Zoom2u API.

This can be helpful for troubleshooting call responses, validating correct receipt of return calls, or assisting with webhook troubleshooting.

This section will detail how you can do so.

Request

Endpoint

Request Headers

{
  "Authorization" : "Bearer your-token-goes-here",
  "Content-Type"  : "application/json"
}

You will need to retrieve the bearer token by logging into your customer account and navigating to the “My Account” section.
There is a short guide here on how to access that information!

Note: This is a secret key and links to your account. For your own security, please do not share it or expose the key publicly.

Body

The body of the request should contain the new status that you would like to update the test booking to.
Example:

{
    "NewStatus": "Accepted"
}

A list of statuses can be found here;

1. Unassigned – Your new booking is being offered to couriers, and a courier will be allocated shortly.
2. Accepted – Booking has been accepted by a courier
3. On Route to Pickup – Courier is heading towards the pick up location
4. Picked up – Courier has picked up the parcel
5. On Route to Dropoff – Courier has the parcel and is heading to the drop off location
6. Tried to deliver – Parcel has attempted to be delivered. Contact courier or Zoom2u for redelivery options.
7. Dropped Off – Booking is complete!

There are 3 other statuses that aren’t part of a standard booking flow, but may still occur on occasion.
A booking cannot be updated or cancelled in any of these status’ either, and an error message will be returned if attempted.

• Cancelled – The booking has been cancelled
• Returning – The booking has been requested to be returned to the pickup location.
• Returned – The booking has been returned to the pickup location. Usually due to failed delivery or by request.
• On Hold - With Courier – The booking has been paused temporarily.

Response

Note:

• If the reference value can’t be found in our system, a 404 error will be displayed.
• If you attempt to change the status of a non-test booking, an error will be returned.

Success

If a submission is successful, a HTTP Status Code 200 (OK) will be returned.
There will be no body or header content.

Issues and troubleshooting