跳轉到主要內容
此頁面由 AI 自動翻譯。如有任何疑問或不一致之處,請以英文版本為準。
供非工程讀者(專案經理、營運、客戶成功)使用的簡要參考,協助把「倉庫怎麼叫它」與「API 與 Webhook 怎麼叫它」對應起來。條目按生命週期階段分組。每個術語提供一句話定義、它對應的 API 物件或 Webhook 事件,以及最相關的端點或文件頁面的指引。
在有用之處,業務術語會以其傳輸線上的形式出現在程式碼片段中(例如 returnInventoryIdlabelGenerated)。本術語表中提到的 Webhook 事件或 schema 欄位名,與 API 實際產生或接受的名稱完全一致。

抵達倉庫前

Return Shipment

您透過 API 建立的到倉前物件,用於宣告一個包裹正在返回 Return Helper 倉庫。攜帶 service type、起寄地址、parcel 尺寸、物品清單與申報總值。以 shipmentId 標識。

Label

為 Return Shipment 產生的運貨面單。產生是非同步的 — 建立運貨單的 API 呼叫會把面單請求入隊並回傳 labelRequestStatusCode: queued;真實的面單 URL 之後透過 Webhook 推送。
  • WebhookLabel resultcategory: labelGenerated / action: labelGenerated
  • 關鍵欄位labelUrltrackingNumbershipmentId(比對時請用 shipmentId,絕不要用 labelId

RMA(Return Merchandise Authorization)

包裹到達時由倉庫指派的全域唯一識別碼。Return Helper 將 RMA — 而不是承運商 tracking number — 作為主要溝通識別碼,因為 tracking number 可能在不同或同一承運商之間發生衝突,而且單一包裹可能因 VAS 拆分為多個 RMA。
  • 格式<倉庫前綴>-<倉庫 ID>-<YYMMDD>-<環境字母><序號>-<校驗位>(拆分包裹追加 2 位拆分序號)
  • WebhookRMA updatedcategory: 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 一筆,視運貨單而定)。

Unknown Shipment

抵達倉庫時沒有對應的賣家 Return Shipment、但後來被識別為屬於某位賣家的包裹。一旦被指派,就以 Return Inventory 的形式進入您的帳戶。
  • WebhookUnknown shipment assignedcategory: rsl / action: assignUnknown
  • Payload 包含returnInventoryIdshipmentIdreturnRequestId,以及指派前已採集的庫存圖片

Inventory Image

在倉庫拍攝、展示包裹內容與狀態的相片。倉庫每次新增、替換或刪除圖片時,URL 清單會經 Webhook 推送。
  • WebhookImage updatedcategory: rrli / action: changeLineItemImage

Warehouse Arrival Event

倉庫將包裹標記為已簽收的時刻。經 Webhook 推送 — 這是「包裹到了」的標準訊號。

抵達後處理

Handling Instruction

告訴倉庫該如何處理某條 Return Inventory 的指令。可選的 handling type 包括 Dispose、On-hold、Resend、Recall 與 VAS(定義見下文)。

Dispose

倉庫銷毀/丟棄庫存。透過標準 handling instruction 使用 dispose handling code 觸發。

On-hold

倉庫暫存庫存、暫不處理。需要時間決定時使用。透過標準 handling instruction 使用 on-hold handling code 觸發。

Resend

倉庫把庫存重新寄至新的目的地(通常是另一位買家)。會建立一個引用一個或多個 returnInventoryId 的獨立物件。

Recall

倉庫把庫存寄至 Return Helper 的香港集中倉進行集中處理。每次呼叫最多 100 個 returnInventoryId。若要把一批庫存寄至您自行選定的目的地,請改用 Consolidate Shipping Order

VAS(Value-Added Services)

倉庫對庫存執行的一系列操作 — 例如把一件庫存拆分為多件物品、重新包裝或物品檢查。當 VAS 拆分庫存時,每件衍生包裹會獲得自己的 RMA。

FBA(Fulfilled by Amazon)

FBA Shipment

把 FBA 適配的商品寄到 Return Helper 倉庫供後續處理(restock、replenish、recall、dispose 等)的運貨單。以 fbaShipmentId 標識。

FBA Instruction

對倉庫中 FBA 庫存的指令 — restock、replenish、recall、dispose 或 “others”。按 FNSKU + 數量發起,而不是按 returnInventoryId

FNSKU

Amazon 的單品物流 SKU。一切涉及 FBA 庫存的地方都用它,而不是 returnInventoryId

Consolidate Shipping

Consolidate Shipping Order

多筆 Return Inventory 一起打包後作為一組對外包裹一併寄出。用於在把庫存寄回賣家時降低運輸成本。

認證與整合基礎

API Key 與 API Token

您的伺服器在每次需要認證的請求中透過 x-rr-apikeyx-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 端點僅供一次性歷史回填。

Idempotency Key

您為每個會變更狀態的請求產生的唯一值,作為 x-returnhelper-idempotency-key 標頭送出。Return Helper 對同一 key 的重試進行去重,避免網路重試產生重複的 shipment / resend / recall / VAS / FBA shipment。

correlationId

每次 API 回應信封中回傳的請求識別碼。請在您一側記錄;Return Helper support 用它追蹤特定請求。

notificationId

每個 Webhook 事件的唯一識別碼。請在您的 Webhook 接收端用它作為冪等 key,對重複投遞的事件去重。