Cancel Booking

If a booking has been placed in error, is no longer needed, or needs to be cancelled for other reasons, this section details how you can cancel a booking via our API.
If the booking simply needs editing, see this article for updating the booking information: Update Booking Information

Do note that an update request and a cancellation request will both fail if the booking status has reached or passed status #3 – On Route To Pickup;

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.

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 be left blank.

Response

There are 3 possible responses from this request:

• HTTP Status Code: 200 (OK). Successfully cancelling the booking will give this response.
• If the booking is already in progress, an error code with a plain text description will be returned instead.
• If there are issues unrelated to the submitted data

Success

The result of the request will usually be a HTTP Status Code: 200 (OK).
There will be no body content for this response.

Error – Booking In Progress.

However, you will receive a HTTP 400 (Bad Request) if you attempt to modify the booking if the status has passed the “On Route to Pick up” stage.
If the booking cannot be cancelled because it is already in progress:

{
    "error-code": "TOOLATE",
    "message": "The booking cannot be modified after its status has passed On Route to Pickup"
}

Other issues and troubleshooting

• If the reference value can’t be found in our system, a 404 error will be displayed.
• An update request and a cancellation request will both fail if the booking status has reached or passed status #3 – On Route To Pickup
  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
  • 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.