Request cancellation of a specific Return

PATCH {{baseUrl}}/returns/:id/cancel

You can request cancellation for a return by providing the return parcel id to this endpoint. 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 Get a specific return endpoint to confirm whether the actual cancellation was successful.

You can find more information about carriers which do not support label cancellation requests on our Help Center.

HEADERS