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
  ]
}
'

import requests

url = "https://api.returnshelper.com/uat/user/api/Recall/createRecallByReturnInventoryId"

payload = { "returnInventoryIdList": [123] }
headers = {
    "x-rr-apikey": "<api-key>",
    "x-rr-apitoken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-rr-apikey': '<api-key>',
    'x-rr-apitoken': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({returnInventoryIdList: [123]})
};

fetch('https://api.returnshelper.com/uat/user/api/Recall/createRecallByReturnInventoryId', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.returnshelper.com/uat/user/api/Recall/createRecallByReturnInventoryId",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'returnInventoryIdList' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-rr-apikey: <api-key>",
    "x-rr-apitoken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.returnshelper.com/uat/user/api/Recall/createRecallByReturnInventoryId"

	payload := strings.NewReader("{\n  \"returnInventoryIdList\": [\n    123\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-rr-apikey", "<api-key>")
	req.Header.Add("x-rr-apitoken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.returnshelper.com/uat/user/api/Recall/createRecallByReturnInventoryId")
  .header("x-rr-apikey", "<api-key>")
  .header("x-rr-apitoken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"returnInventoryIdList\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.returnshelper.com/uat/user/api/Recall/createRecallByReturnInventoryId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-rr-apikey"] = '<api-key>'
request["x-rr-apitoken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"returnInventoryIdList\": [\n    123\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "recallList": [
    {
      "apiId": 123,
      "recallId": 123,
      "warehouseId": 123,
      "recallNumber": "<string>",
      "recallStatusCode": "<string>",
      "warehouseRemarks": "<string>",
      "recallInventoryList": [
        {}
      ]
    }
  ]
}

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

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
  ]
}
'

import requests

url = "https://api.returnshelper.com/uat/user/api/Recall/createRecallByReturnInventoryId"

payload = { "returnInventoryIdList": [123] }
headers = {
    "x-rr-apikey": "<api-key>",
    "x-rr-apitoken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-rr-apikey': '<api-key>',
    'x-rr-apitoken': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({returnInventoryIdList: [123]})
};

fetch('https://api.returnshelper.com/uat/user/api/Recall/createRecallByReturnInventoryId', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.returnshelper.com/uat/user/api/Recall/createRecallByReturnInventoryId",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'returnInventoryIdList' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-rr-apikey: <api-key>",
    "x-rr-apitoken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.returnshelper.com/uat/user/api/Recall/createRecallByReturnInventoryId"

	payload := strings.NewReader("{\n  \"returnInventoryIdList\": [\n    123\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-rr-apikey", "<api-key>")
	req.Header.Add("x-rr-apitoken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.returnshelper.com/uat/user/api/Recall/createRecallByReturnInventoryId")
  .header("x-rr-apikey", "<api-key>")
  .header("x-rr-apitoken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"returnInventoryIdList\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.returnshelper.com/uat/user/api/Recall/createRecallByReturnInventoryId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-rr-apikey"] = '<api-key>'
request["x-rr-apitoken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"returnInventoryIdList\": [\n    123\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "recallList": [
    {
      "apiId": 123,
      "recallId": 123,
      "warehouseId": 123,
      "recallNumber": "<string>",
      "recallStatusCode": "<string>",
      "warehouseRemarks": "<string>",
      "recallInventoryList": [
        {}
      ]
    }
  ]
}

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

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

Create recall order — the legacy non-batch version that takes the recall payload directly. New integrations should prefer this batch endpoint.
Cancel recall by return inventory ID — undo a recall before the warehouse fulfils it.
Get all recall inventory statuses — code-to-label mappings.
Webhooks — recallUpdateStatus and the recall lifecycle events deliver progress to your endpoint.

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

Show child attributes

Overview

Api

FBA

Consolidate Shipping

Notification

Recall

Resend

ReturnInventory

ReturnShipment

ServiceType

Shipment

ShipmentServiceType

Vas

Warehouse

Create recall by return inventory IDs

Prerequisites

Required fields

Side effects

Authorizations

Body

Response

​Prerequisites

​Required fields

​Side effects

​Related

Authorizations

Body

Response

Prerequisites

Required fields

Side effects

Related