Skip to main content
POST
/
api
/
Recall
/
createRecall
Create recall order
curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/Recall/createRecall \
  --header 'Content-Type: application/json' \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>' \
  --data '
{
  "returnInventoryIdList": [
    123
  ]
}
'
{
  "recallId": 123,
  "recallCode": "<string>"
}
Creates a recall request from existing inventory you’ve already received. Most integrations should use createRecallByReturnInventoryId which references inventory by ID; this endpoint accepts the recall payload directly and is mainly for legacy callers.

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 for recall

Response

Success

​
recallId
integer<int64>

Created recall identifier

​
recallCode
string

Recall code