メインコンテンツへスキップ
GET
/
api
/
ReturnInventory
/
GetReturnInventory
Get return inventory details
curl --request GET \
  --url https://api.returnshelper.com/uat/user/api/ReturnInventory/GetReturnInventory \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>'
{
  "returnInventoryId": 123
}
このページはAIによって自動翻訳されています。API技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。
returnInventoryId で 1 件の返品在庫レコードの完全な内容を取得します。webhook（例：inventoryCreated）を受信した直後に呼び出して現在の状態を読み取る用途が一般的です。

​
在庫画像

レスポンスには、在庫の 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"
キーには S3 の完全なパスがすでに含まれています。組み立てた URL は公開アクセス可能で、認証ヘッダー不要、かつ期限切れもありません。URL と画像コンテンツの両方をクライアント側で安全にキャッシュできます。
パスは不透明なものとして扱ってください。 Return Helper は過去に複数のパスプレフィックス（img/returns/... や images/returns/... など）を使用してきました。ホスト名のみが安定です。パスやファイル名を解析・検証・パターンマッチしないでください。
画像が添付されていない場合の空状態：returnRequestLineItemImages: []。
このエンドポイントは問い合わせ時点の現在状態を返します。倉庫担当者が画像を追加・置換・削除したタイミングでリアルタイム通知が必要な場合は、このエンドポイントをポーリングするのではなく changeLineItemImage webhook を購読してください。

​
関連

承認

​
x-rr-apikey
string
header
必須

Your API key

​
x-rr-apitoken
string
header
必須

Your API token — keep this private

クエリパラメータ

​
returnInventoryId
integer<int64>

Return inventory identifier

レスポンス

Success

​
returnInventoryId
integer<int64>

Return inventory identifier