Skip to main content
PATCH
/
returns
/
{id}
/
cancel
{
  "message": "Cancellation requested successfully"
}
Not all carriers support upstream label cancellation via an API request, therefore this endpoint will only send a cancellation request. A successful response indicates that the request is received and the carrier supports label cancellation. You can check the parent_status of the return via the Retrieve a return endpoint to confirm whether the actual cancellation was successful.
You can find more information about carriers which do not support label cancellation requests in our help center.

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Path Parameters

​
id
integer
required

The Sendcloud unique identifier of this return

Example:

1751075

Response

Cancellation has successfully been requested

​
message
string
required

Message detailing more if the cancellation request was successful or not

Example:

"Cancellation requested successfully"