Get return inventory by line item ID
curl --request GET \
--url https://api.returnshelper.com/uat/user/api/ReturnInventory/GetReturnInventoryByLineItemId \
--header 'x-rr-apikey: <api-key>' \
--header 'x-rr-apitoken: <api-key>'import requests
url = "https://api.returnshelper.com/uat/user/api/ReturnInventory/GetReturnInventoryByLineItemId"
headers = {
"x-rr-apikey": "<api-key>",
"x-rr-apitoken": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-rr-apikey': '<api-key>', 'x-rr-apitoken': '<api-key>'}
};
fetch('https://api.returnshelper.com/uat/user/api/ReturnInventory/GetReturnInventoryByLineItemId', 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/ReturnInventory/GetReturnInventoryByLineItemId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.returnshelper.com/uat/user/api/ReturnInventory/GetReturnInventoryByLineItemId"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-rr-apikey", "<api-key>")
req.Header.Add("x-rr-apitoken", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.returnshelper.com/uat/user/api/ReturnInventory/GetReturnInventoryByLineItemId")
.header("x-rr-apikey", "<api-key>")
.header("x-rr-apitoken", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.returnshelper.com/uat/user/api/ReturnInventory/GetReturnInventoryByLineItemId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-rr-apikey"] = '<api-key>'
request["x-rr-apitoken"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"returnInventoryId": 123
}{
"correlationId": "<string>",
"meta": {
"status": 123,
"data": {},
"errorCode": "<string>",
"error": {}
}
}返品在庫
Line Item ID で Return Inventory を取得
GET
/
api
/
ReturnInventory
/
GetReturnInventoryByLineItemId
Get return inventory by line item ID
curl --request GET \
--url https://api.returnshelper.com/uat/user/api/ReturnInventory/GetReturnInventoryByLineItemId \
--header 'x-rr-apikey: <api-key>' \
--header 'x-rr-apitoken: <api-key>'import requests
url = "https://api.returnshelper.com/uat/user/api/ReturnInventory/GetReturnInventoryByLineItemId"
headers = {
"x-rr-apikey": "<api-key>",
"x-rr-apitoken": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-rr-apikey': '<api-key>', 'x-rr-apitoken': '<api-key>'}
};
fetch('https://api.returnshelper.com/uat/user/api/ReturnInventory/GetReturnInventoryByLineItemId', 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/ReturnInventory/GetReturnInventoryByLineItemId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.returnshelper.com/uat/user/api/ReturnInventory/GetReturnInventoryByLineItemId"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-rr-apikey", "<api-key>")
req.Header.Add("x-rr-apitoken", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.returnshelper.com/uat/user/api/ReturnInventory/GetReturnInventoryByLineItemId")
.header("x-rr-apikey", "<api-key>")
.header("x-rr-apitoken", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.returnshelper.com/uat/user/api/ReturnInventory/GetReturnInventoryByLineItemId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-rr-apikey"] = '<api-key>'
request["x-rr-apitoken"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"returnInventoryId": 123
}{
"correlationId": "<string>",
"meta": {
"status": 123,
"data": {},
"errorCode": "<string>",
"error": {}
}
}このページはAIによって自動翻訳されています。API技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。
在庫画像
レスポンスの各在庫レコードには、line item に紐づく画像を列挙するreturnRequestLineItemImages[] 配列が含まれます。このエンドポイントは URL ではなく S3 キーを返します — 画像を表示・取得するには、お客様の環境のホスト名と S3 キーを連結して URL を組み立ててください。
エントリの構造
各エントリは同一画像の 4 つのサイズ別バリアントを返却するため、UI の用途に応じて適切なものを選択できます:| フィールド | 典型的な用途 |
|---|---|
s3SmallFileKey | 一覧ビューのサムネイル |
s3MediumFileKey | 詳細ビューのプレビュー |
s3LargeFileKey | フルスクリーンプレビュー |
s3OriginalFileKey | オリジナルのアップロード(最大;リサイズなしの画像が必要な場合のみ) |
URL の組み立て方
環境ごとのホスト名:| 環境 | 画像ホスト名 |
|---|---|
| サンドボックス(UAT) | rr-dev-files.returnshelper.com |
| 本番 | file.returnhelpercentre.com |
URL = "https://" + <画像ホスト名> + "/" + <key>
s3MediumFileKey = "img/returns/202606/27_1000040536_lmpiohbx.5n3_medium.jpg"
↓ 連結
URL = "https://file.returnhelpercentre.com/img/returns/202606/27_1000040536_lmpiohbx.5n3_medium.jpg"
パスは不透明なものとして扱ってください。 Return Helper は過去に複数のパスプレフィックス(
img/returns/... や images/returns/... など)を使用してきました。ホスト名のみが安定です。パスやファイル名を解析・検証・パターンマッチしないでください。returnRequestLineItemImages: null(返品在庫詳細を取得 エンドポイントでは [])。いずれも「画像なし」として扱ってください。
このエンドポイントは問い合わせ時点の現在状態を返します。倉庫担当者が画像を追加・置換・削除したタイミングでリアルタイム通知が必要な場合は、このエンドポイントをポーリングするのではなく
changeLineItemImage webhook を購読してください。関連
- 返品在庫詳細を取得 — レスポンス構造は同じですが、在庫 ID で問い合わせます。
- Image Updated webhook — 画像変更のリアルタイム通知。
- VAS Updated webhook — VAS 結果画像のリアルタイム通知。