在有用之處,業務術語會以其傳輸線上的形式出現在程式碼片段中(例如
returnInventoryId、labelGenerated)。本術語表中提到的 Webhook 事件或 schema 欄位名,與 API 實際產生或接受的名稱完全一致。抵達倉庫前
Return Shipment
您透過 API 建立的到倉前物件,用於宣告一個包裹正在返回 Return Helper 倉庫。攜帶 service type、起寄地址、parcel 尺寸、物品清單與申報總值。以shipmentId 標識。
- 建立:Create Return Shipment
- 列表(僅歷史回填):List Shipments
- Schema:
CreateReturnShipmentRequest
Label
為 Return Shipment 產生的運貨面單。產生是非同步的 — 建立運貨單的 API 呼叫會把面單請求入隊並回傳labelRequestStatusCode: queued;真實的面單 URL 之後透過 Webhook 推送。
- Webhook:Label result(
category: labelGenerated/action: labelGenerated) - 關鍵欄位:
labelUrl、trackingNumber、shipmentId(比對時請用shipmentId,絕不要用labelId)
RMA(Return Merchandise Authorization)
包裹到達時由倉庫指派的全域唯一識別碼。Return Helper 將 RMA — 而不是承運商 tracking number — 作為主要溝通識別碼,因為 tracking number 可能在不同或同一承運商之間發生衝突,而且單一包裹可能因 VAS 拆分為多個 RMA。- 格式:
<倉庫前綴>-<倉庫 ID>-<YYMMDD>-<環境字母><序號>-<校驗位>(拆分包裹追加 2 位拆分序號) - Webhook:RMA updated(
category: notifyUserRmaSwapped) - 詳情:Getting Started → RMA
Custom Field Map
您附加到 Return Shipment 的任意鍵值 metadata。Return Helper 原樣儲存並在相關 Webhook 事件中回傳。每個 return 最多 24 條。- 欄位:Return Shipment、parcel item 及多個 Webhook payload 中的
customFieldMap
抵達倉庫
Return Inventory
包裹簽收並處理後,倉庫建立的到倉後物件。以returnInventoryId 標識。一份 Return Shipment 可能產生多筆 Return Inventory 記錄(每件包裹或每條 line item 一筆,視運貨單而定)。
- 取得:Get Return Inventory Details
- 列表(僅歷史回填):List Return Inventories
- Webhook:Inventory created(
category: newInventoryCreated)
Unknown Shipment
抵達倉庫時沒有對應的賣家 Return Shipment、但後來被識別為屬於某位賣家的包裹。一旦被指派,就以 Return Inventory 的形式進入您的帳戶。- Webhook:Unknown shipment assigned(
category: rsl/action: assignUnknown) - Payload 包含:
returnInventoryId、shipmentId、returnRequestId,以及指派前已採集的庫存圖片
Inventory Image
在倉庫拍攝、展示包裹內容與狀態的相片。倉庫每次新增、替換或刪除圖片時,URL 清單會經 Webhook 推送。- Webhook:Image updated(
category: rrli/action: changeLineItemImage)
Warehouse Arrival Event
倉庫將包裹標記為已簽收的時刻。經 Webhook 推送 — 這是「包裹到了」的標準訊號。- Webhook:Warehouse shipment arrived (v2)(
category: rsl/action: markShipmentArrive)
抵達後處理
Handling Instruction
告訴倉庫該如何處理某條 Return Inventory 的指令。可選的 handling type 包括 Dispose、On-hold、Resend、Recall 與 VAS(定義見下文)。- 更新:Update Return Inventory Handling
- 取消:Cancel Return Inventory Handling
- Webhook:Inventory handling complete(
category: rinv/action: completeInventoryHandling)
Dispose
倉庫銷毀/丟棄庫存。透過標準 handling instruction 使用 dispose handling code 觸發。On-hold
倉庫暫存庫存、暫不處理。需要時間決定時使用。透過標準 handling instruction 使用 on-hold handling code 觸發。Resend
倉庫把庫存重新寄至新的目的地(通常是另一位買家)。會建立一個引用一個或多個returnInventoryId 的獨立物件。
- 建立:Create Resend Order
- 取消:Cancel Resend Order
- Webhook:Resend status update(
category: resend/action: updateResendStatus)
Recall
倉庫把庫存寄至 Return Helper 的香港集中倉進行集中處理。每次呼叫最多 100 個returnInventoryId。若要把一批庫存寄至您自行選定的目的地,請改用 Consolidate Shipping Order。
- 建立:Create Recall by Return Inventory IDs
- Webhook:Recall status update(
category: recall/action: recallUpdateStatus)
VAS(Value-Added Services)
倉庫對庫存執行的一系列操作 — 例如把一件庫存拆分為多件物品、重新包裝或物品檢查。當 VAS 拆分庫存時,每件衍生包裹會獲得自己的 RMA。- 建立:Create VAS by Return Inventory ID
- Webhook(完成):VAS update(
category: rrliv/action: vasUpdated) - Webhook(拆分):Split line item(
category: lineItemVasReturnInventoryLineItem/action: splitLineItem)
FBA(Fulfilled by Amazon)
FBA Shipment
把 FBA 適配的商品寄到 Return Helper 倉庫供後續處理(restock、replenish、recall、dispose 等)的運貨單。以fbaShipmentId 標識。
- 建立:Create FBA Shipment
- 列表(僅歷史回填):List FBA Shipments
FBA Instruction
對倉庫中 FBA 庫存的指令 — restock、replenish、recall、dispose 或 “others”。按 FNSKU + 數量發起,而不是按returnInventoryId。
- 建立:Create FBA Instructions
- 列表(僅歷史回填):List FBA Instructions
FNSKU
Amazon 的單品物流 SKU。一切涉及 FBA 庫存的地方都用它,而不是returnInventoryId。
Consolidate Shipping
Consolidate Shipping Order
多筆 Return Inventory 一起打包後作為一組對外包裹一併寄出。用於在把庫存寄回賣家時降低運輸成本。- 建立:Create Consolidate Shipping Order
- 確認:Confirm Consolidate Shipping Order
- Webhook(費用):Consolidate shipping cost updated
- Webhook(完成):Consolidate order completed
認證與整合基礎
API Key 與 API Token
您的伺服器在每次需要認證的請求中透過x-rr-apikey 與 x-rr-apitoken 標頭送出的一對憑證。在 User Portal 的 Settings → Signing Key and API Token 中發放。
Signing Key
Return Helper 用來簽署 Webhook 請求的 Base64 編碼的共用密鑰。您的接收端用它對照原始 body 驗證returnhelper-signature 標頭。在 User Portal 與 API key 同一處發放。
Webhook / Notification
Return Helper 把非同步事件(面單結果、倉庫事件、handling 完成等)推送至您伺服器的機制。以帶簽章 body 的 HTTPS POST 形式投遞。Webhook 是標準的資料交換通道 — list 端點僅供一次性歷史回填。- 詳情:Webhooks
Idempotency Key
您為每個會變更狀態的請求產生的唯一值,作為x-returnhelper-idempotency-key 標頭送出。Return Helper 對同一 key 的重試進行去重,避免網路重試產生重複的 shipment / resend / recall / VAS / FBA shipment。