FBA Shipment を作成

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"
    }
  ]
}

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技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。

1 件以上の受入 FBA シップメントを登録します——つまり Return Helper に「Amazon がこの追跡番号で Removal Order をこの倉庫宛に発送したので、到着を待ってほしい」と伝えます。これはメタデータ登録のみで、ラベルを発行したり物理アクションを起こしたりはしません。倉庫がパーセル到着時に Removal Order と紐付けられるようにするためのものです。

呼び出すタイミング

Amazon Seller Central（または SP-API）で Removal Order を作成した後、Amazon が割り当てたキャリアの追跡番号を取得した時点で。
Removal Order 内の各シップメントごとに——Amazon は単一の Removal Order を異なる追跡番号の複数パーセルに分割することがしばしばあります。追跡番号 1 つにつき FBA シップメント 1 件を作成してください。

必須フィールド

createFbaShipmentPayloadList 内の各エントリ：

trackingNumber — 非空、単一行、認識される追跡番号フォーマットに一致する必要があります。グローバルに一意 — 期限切れでない FBA シップメントレコードで使われている追跡番号は再利用できません。
removalOrderId — Amazon の Removal Order ID（例：WS-1234567）。単一行で有効なフォーマット。
warehouseId — FBA パーセルが届く倉庫。アカウントが認可されている倉庫である必要があります。ユーザーがアクセスできるすべての倉庫を取得で取得してください。

ペイロード横断ルール

同一バッチ内で trackingNumber の重複は不可。
同一 removalOrderId はバッチ内で常に同じ warehouseId にマッピングされる必要があります — 同じ呼び出しで「Removal Order WS-1 → 倉庫 5」と「Removal Order WS-1 → 倉庫 7」と矛盾させることはできません。

副作用

ペイロードごとに FbaShipment レコードが作成され、追跡番号、Removal Order、宛先倉庫が紐付けられます。
パーセルが物理的に到着すると、倉庫はこれらのレコードを照合して fbaShipmentArrived webhook をトリガーします。
ラベルは生成されません——発送するのは Amazon であり、あなたではありません。

呼び出すタイミング

必須フィールド

ペイロード横断ルール

副作用

関連

承認

ボディ

レスポンス

​呼び出すタイミング

​必須フィールド

​ペイロード横断ルール

​副作用

​関連

承認

ボディ

レスポンス

呼び出すタイミング

必須フィールド

ペイロード横断ルール

副作用

関連