跳转到主要内容
此页面由 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 的任意键值元数据。Return Helper 原样存储并在相关 Webhook 事件中回传。每个 return 最多 24 条。
  • 字段:Return Shipment、parcel item 及多个 Webhook payload 中的 customFieldMap

到仓

Return Inventory

包裹被签收并处理后,仓库创建的到仓后对象。以 returnInventoryId 标识。一份 Return Shipment 可能产生多条 Return Inventory 记录(每件包裹或每条行项目一条,取决于运货单情况)。

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,对重复投递的事件去重。