Cancel an Order

delete

https://sandbox.sendle.com/api/orders/{id}

Cancels the given order.

An order can be cancelled so long as it hasn't been collected by a driver. The way to see whether an order can still be cancelled is with the is_cancellable key when viewing an order.

If the order has already been cancelled a 200 response will be returned – this is why an idempotency key isn't needed for this endpoint. If the order has already been collected a 422 failure response will be returned.

Note: Cancelled orders aren't deleted from the system and should still be viewable on your dashboard in the 'cancelled' state.

Responses

500

Indicates that an unhandled error has occured with the Sendle API. We may have more information on the Sendle Status page. Contact [email protected] if the problem persists.

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Indicates that the order was successfully cancelled.

401Indicates that your Sendle ID or API key was incorrect or not provided. You should double-check your API credentials and confirm whether you're using sandbox or production details.

404Indicates that the given order ID, label URL, parcel reference, or other URI couldn't be found. Double-check the ID or URL before retrying. This can also mean you're trying to return an order you're not the sender/creator of.

422Indicates that the given order couldn't be cancelled. This schema differs from our regular 422 responses, so keep that in mind if you want to process this error.

503Indicates that Sendle is temporarily offline for maintenance or upgrades. We may have more information on the Sendle Status page.