跳轉到主要內容
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