Skip to main content
POST
/
api
/
Recall
/
createRecallByReturnInventoryId
Create recall by return inventory IDs
curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/Recall/createRecallByReturnInventoryId \
  --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": [
        {}
      ]
    }
  ]
}
Creates a recall request for one or more return inventory items already received at a warehouse. A recall ships the items back out from the warehouse to a our Hong Kong warehouse.

​
Prerequisites

  • The target inventory items must already exist in your account. The returnInventoryId values come from the newInventoryCreated webhook event — your integration should cache them on your side as parcels are logged at the warehouse.
  • Each inventory’s current handlingStatusCode must be reachable from the recall transition (Handling.rtn) per the handling state machine — typically items in pending or ohd status are eligible.
  • None of the items can already have an active (non-cancelled) recall.
  • None of the items’ line items can have pending VAS requests — resolve those first.

​
Required fields

  • returnInventoryIdList — non-empty List<long>.

​
Side effects

  • Each inventory’s handlingCode is set to rtn.
  • The RMA mapping for each inventory is locked to prevent swap operations.
  • Recall fulfilment is asynchronous; status updates flow via webhook (recallShipmentDispatched, recallDelivered, etc.).

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 created recalls