Skip to main content
POST
Cancel return inventory handling
Cancels a pending handling instruction on a return inventory record. If the warehouse has not yet acted on the instruction, this returns the inventory to the pending state, ready for a new instruction.

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
returnInventoryId
integer<int64>
required

Return inventory ID to cancel handling for

Response

Success

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).