Cancel return inventory handling

curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/ReturnInventory/CancelReturnInventoryHandling \
  --header 'Content-Type: application/json' \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>' \
  --data '
{
  "returnInventoryId": 123
}
'

{
  "correlationId": "<string>",
  "meta": {
    "status": 123,
    "data": {},
    "errorCode": "<string>",
    "error": {}
  }
}

POST

api

ReturnInventory

CancelReturnInventoryHandling

Cancel return inventory handling

curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/ReturnInventory/CancelReturnInventoryHandling \
  --header 'Content-Type: application/json' \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>' \
  --data '
{
  "returnInventoryId": 123
}
'

{
  "correlationId": "<string>",
  "meta": {
    "status": 123,
    "data": {},
    "errorCode": "<string>",
    "error": {}
  }
}

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.