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": {}
}
}リコール
Return Inventory ID で Recall を作成
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": {}
}
}このページはAIによって自動翻訳されています。API技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。
前提条件
- 対象在庫アイテムはアカウントに存在している必要があります。
returnInventoryIdはnewInventoryCreatedwebhook イベントで配信されるため、統合は自社側でキャッシュしてください。 - 各在庫の現在の
handlingStatusCodeは、ハンドリング状態機械上でリコール(Handling.rtn)に進めるものでなければなりません——通常はpendingまたはohd状態が対象です。 - いずれのアイテムにも、有効な(未キャンセルの)リコールが存在してはなりません。
- いずれのアイテムのラインアイテムにも保留中の VAS が存在してはなりません——先に解決してください。
必須フィールド
returnInventoryIdList— 空でないList<long>。
副作用
- 各在庫の
handlingCodeがrtnに設定されます。 - 各在庫の RMA マッピングが、スワップ防止のためロックされます。
- リコールの履行は非同期です。状態更新は webhook(
recallShipmentDispatched、recallDeliveredなど)で配信されます。
関連
- リコール注文を作成 — リコールペイロードを直接受け付けるレガシーの非バッチ版。新規統合では本バッチエンドポイントを優先してください。
- 返品在庫 ID でリコールをキャンセル — 倉庫が履行する前にリコールを取り消します。
- すべてのリコール在庫ステータスを取得 — コード → ラベルのマッピング。
- Webhooks —
recallUpdateStatusおよび各リコール ライフサイクル イベントが進捗をエンドポイントへ配信します。
⌘I