跳转到主要内容
POST
/
api
/
Fba
/
FbaShipment
/
create
Create FBA shipment
curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/Fba/FbaShipment/create \
  --header 'Content-Type: application/json' \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>' \
  --data '
{
  "createFbaShipmentPayloadList": [
    {
      "trackingNumber": "<string>",
      "warehouseId": 123,
      "removalOrderId": "<string>"
    }
  ]
}
'
{
  "data": [
    {
      "fbaShipmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "apiId": 123,
      "warehouseId": 123,
      "fbaShipmentStatusCode": "<string>",
      "removalOrderId": "<string>",
      "trackingNumber": "<string>",
      "arrivalOn": "2023-11-07T05:31:56Z",
      "createOn": "2023-11-07T05:31:56Z"
    }
  ]
}
此页面由 AI 自动翻译。API 技术规格以英文呈现为标准。如有任何疑问,请参阅英文版本
登记一个或多个入库 FBA 运货单——即告诉 Return Helper「亚马逊已用此追踪号将一个 Removal Order 派送至此仓库,请准备接收。」此为元数据登记:不会建立面单,亦不触发实体动作;仅让仓库在包裹抵达时能将之与您的 Removal Order 对应起来。

何时调用

  • 在 Amazon Seller Central(或 SP-API)建立 Removal Order 后,取得承运商分配的追踪号即可呼叫。
  • 一个 Removal Order 中每个运货单都呼叫一次——亚马逊常将单一 Removal Order 拆为多个不同追踪号的包裹;每个追踪号建一个 FBA 运货单。

必填字段

createFbaShipmentPayloadList 中每条记录:
  • trackingNumber — 非空、单行,必须符合公认的追踪号格式。全局唯一——不可重用已存在于未过期 FBA 运货单纪录中的追踪号。
  • removalOrderId — 亚马逊 Removal Order ID(例如 WS-1234567)。单行,格式有效。
  • warehouseId — FBA 包裹寄往的仓库,必须是您账户已授权的仓库。可透过 取得用户可访问的所有仓库 取得。

跨 payload 规则

  • 同一批次内 trackingNumber 不可重复。
  • 同一 removalOrderId 在批次内必须对应同一 warehouseId——不能在同一次呼叫中说「Removal Order WS-1 → 仓库 5」又说「Removal Order WS-1 → 仓库 7」。

副作用

  • 每条 payload 会建立一个 FbaShipment 记录,将追踪号、Removal Order 与目的仓库连结。
  • 包裹实际抵达时,仓库会用这些记录进行匹配并触发 fbaShipmentArrived webhook。
  • 不会产生面单——出货方是亚马逊,不是您。

相关

  • 取得 FBA 运货单详情 — 当 webhook 提及您未缓存的 fbaShipmentId 时,按 ID 取得单笔记录。
  • 建立 FBA 指示 — 包裹抵达后(由 webhook 通知),指示仓库如何处置库存(销毁、召回、补货等)。
  • Webhooks — FBA 运货单生命周期(到货、指示完成等)仅透过 webhook 推送。

授权

x-rr-apikey
string
header
必填

Your API key

x-rr-apitoken
string
header
必填

Your API token — keep this private

请求体

application/json
createFbaShipmentPayloadList
object[]
必填

List of FBA shipment creation payloads

响应

Success

data
object[]

List of created FBA shipments