取得退貨庫存詳情

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
}

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 取得單筆退件庫存記錄的完整內容。常於收到 webhook（例如 inventoryCreated）後呼叫，以讀取目前狀態。

庫存圖片

回應中包含 returnRequestLineItemImages[] 陣列，列出附加到庫存對應 line item 上的圖片。此端點回傳的是 S3 key，而非 URL —— 要顯示或下載圖片，請以您所在環境的主機名稱與 key 串接出 URL。

條目結構

每筆紀錄提供同一張圖片的四種尺寸變體，方便您按 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"

key 已經包含完整的 S3 路徑。串接出來的 URL 可公開存取、不需要任何認證標頭、也不會過期；URL 與圖片內容均可在用戶端安全快取。

請將路徑視為不透明。 Return Helper 過去曾使用多種路徑前綴（例如 img/returns/... 與 images/returns/...）；只有主機名稱是穩定的。請勿解析、驗證或對路徑/檔名做任何模式比對。

無圖片時的空狀態：returnRequestLineItemImages: []。

此端點回傳的是查詢當下的狀態。如需在倉庫人員新增、替換或移除圖片時即時收到通知，請訂閱 changeLineItemImage webhook，而非反覆輪詢此端點。

庫存圖片

條目結構

構造 URL

相關

授權

查詢參數

回應

​庫存圖片

​條目結構

​構造 URL

​相關

授權

查詢參數

回應

庫存圖片

條目結構

構造 URL

相關