Get return inventory by line item ID
退貨庫存
取得 退貨庫存 (依 訂單行項目ID
GET
Get return inventory by line item ID
依特定退貨申請行項目 ID 取得相關的退件庫存記錄。當您已從退貨申請中取得行項目參照、需要庫存目前狀態時使用。
公式:
生產環境範例:
key 已經包含完整的 S3 路徑。串接出來的 URL 可公開存取、不需要任何認證標頭、也不會過期;URL 與圖片內容均可在用戶端安全快取。
此端點的空狀態為:
庫存圖片
回應中每筆庫存紀錄都包含returnRequestLineItemImages[] 陣列,列出附加到 line item 上的圖片。此端點回傳的是 S3 key,而非 URL —— 要顯示或下載圖片,請以您所在環境的主機名稱與 key 串接出 URL。
條目結構
每筆紀錄提供同一張圖片的四種尺寸變體,方便您按 UI 用途選用:| 欄位 | 典型用途 |
|---|---|
s3SmallFileKey | 列表視圖的縮圖 |
s3MediumFileKey | 詳細視圖的預覽 |
s3LargeFileKey | 全螢幕預覽 |
s3OriginalFileKey | 原始上傳(最大;僅在需要未縮放圖時使用) |
構造 URL
依環境選擇主機名稱:| 環境 | 圖片主機名稱 |
|---|---|
| 沙箱(UAT) | rr-dev-files.returnshelper.com |
| 生產 | file.returnhelpercentre.com |
returnRequestLineItemImages: null(取得退貨庫存詳情 端點上為 [])。兩者皆視為「無圖片」。
此端點回傳的是查詢當下的狀態。如需在倉庫人員新增、替換或移除圖片時即時收到通知,請訂閱
changeLineItemImage webhook,而非反覆輪詢此端點。相關
- 取得退貨庫存詳情 —— 回應結構相同,依庫存 ID 查詢。
- Image Updated webhook —— 圖片變更的即時通知。
- VAS Updated webhook —— VAS 結果圖片的即時通知。