Skip to main content
POST
/
api
/
Recall
/
cancelRecallByReturnInventoryId
Cancel recall by return inventory ID
curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/Recall/cancelRecallByReturnInventoryId \
  --header 'Content-Type: application/json' \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>' \
  --data '
{
  "returnInventoryIdList": [
    123
  ]
}
'
{
  "recallList": [
    {
      "apiId": 123,
      "recallId": 123,
      "warehouseId": 123,
      "recallNumber": "<string>",
      "recallStatusCode": "<string>",
      "warehouseRemarks": "<string>",
      "recallInventoryList": [
        {}
      ]
    }
  ]
}
Cancels a pending recall request previously created via Create recall by return inventory IDs. Identifies the recall by returnInventoryId. Only works while the recall is still cancellable; once the warehouse has begun fulfilment, you’ll need to contact support.

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
​
returnInventoryIdList
integer<int64>[]
required

List of return inventory IDs

Response

Success

​
recallList
object[]

List of cancelled recalls