Skip to main content
POST
Cancel return label
Cancels a return label created by Create return shipment. Pass the labelId from the create response or from the labelGenerated webhook.

When a label can be cancelled

Every condition below must hold. If one fails, the call returns a validation soft error — HTTP 200 with meta.status: 400 and meta.errorCode: VALIDATION_FAILED — with the message in meta.error.labelId. See Error codes. cancelCutoffTime is delivered with the label in the labelGenerated webhook and returned by Get return shipment details.

After a successful cancel

Get return shipment details returns: The cancelled label is no longer returned. Keep its labelId on your side if you need it later.

Correcting a shipment

A cancelled return request cannot get a new label. To correct a shipment, cancel its label, then call Create return shipment again with the corrected details. The new call returns a new returnRequestId, shipmentId, and labelId. The cancelled return request stays at label-canceled.

Idempotency

The x-returnhelper-idempotency-key header is optional. A call without it runs normally, with no protection against duplicates. See Idempotency.

Authorizations

x-rr-apikey
string
header
required

Your API key

x-rr-apitoken
string
header
required

Your API token — keep this private

Body

application/json
labelId
integer<int64>
required

ID of the label to cancel, as returned by Create return shipment and the labelGenerated webhook

Response

Success — returns the standard response envelope with no additional payload fields. Inspect meta.status to confirm the label was cancelled.

Universal response envelope. Successful responses include the business payload as additional top-level fields alongside correlationId and meta. Failed responses (auth errors, validation errors) only populate correlationId and meta, with meta.errorCode and meta.error describing the failure.

correlationId
string | null

Unique correlation ID for tracing the request through Return Helper systems.

meta
object

Application-level metadata for every API response. Inspect status and errorCode to detect soft-error responses (validation failures arrive as HTTP 200 with meta.status: 400).