Cancel Route

The cancellation is processed asynchronously: the request is accepted and the cancellation is completed in the background.. The final outcome (success or failure) is delivered via the route.canceled webhook, so a subscription to that event is required. If the route is in draft state, its orders are unlinked from the route (leaving the orders intact and free to be added to other routes) and the route is canceled. If the route has not started, cancellation is allowed and applied to all orders under it. If any order is in progress, cancellation is not allowed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of a route.

Body Params
string

Reason for cancellation, can not be longer than 255 characters.

Headers
string
required

Burq API key for your account.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json