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>"
}
]
}
'import requests
url = "https://api.returnshelper.com/uat/user/api/Fba/FbaShipment/create"
payload = { "createFbaShipmentPayloadList": [
{
"trackingNumber": "<string>",
"warehouseId": 123,
"removalOrderId": "<string>"
}
] }
headers = {
"x-rr-apikey": "<api-key>",
"x-rr-apitoken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-rr-apikey': '<api-key>',
'x-rr-apitoken': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
createFbaShipmentPayloadList: [{trackingNumber: '<string>', warehouseId: 123, removalOrderId: '<string>'}]
})
};
fetch('https://api.returnshelper.com/uat/user/api/Fba/FbaShipment/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.returnshelper.com/uat/user/api/Fba/FbaShipment/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'createFbaShipmentPayloadList' => [
[
'trackingNumber' => '<string>',
'warehouseId' => 123,
'removalOrderId' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-rr-apikey: <api-key>",
"x-rr-apitoken: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.returnshelper.com/uat/user/api/Fba/FbaShipment/create"
payload := strings.NewReader("{\n \"createFbaShipmentPayloadList\": [\n {\n \"trackingNumber\": \"<string>\",\n \"warehouseId\": 123,\n \"removalOrderId\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-rr-apikey", "<api-key>")
req.Header.Add("x-rr-apitoken", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.returnshelper.com/uat/user/api/Fba/FbaShipment/create")
.header("x-rr-apikey", "<api-key>")
.header("x-rr-apitoken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"createFbaShipmentPayloadList\": [\n {\n \"trackingNumber\": \"<string>\",\n \"warehouseId\": 123,\n \"removalOrderId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.returnshelper.com/uat/user/api/Fba/FbaShipment/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-rr-apikey"] = '<api-key>'
request["x-rr-apitoken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"createFbaShipmentPayloadList\": [\n {\n \"trackingNumber\": \"<string>\",\n \"warehouseId\": 123,\n \"removalOrderId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"fbaShipmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"apiId": 123,
"warehouseId": 123,
"fbaShipmentStatusCode": "<string>",
"removalOrderId": "<string>",
"trackingNumber": "<string>",
"arrivalOn": "2023-11-07T05:31:56Z"
}
]
}{
"correlationId": "<string>",
"meta": {
"status": 123,
"data": {},
"errorCode": "<string>",
"error": {}
}
}配送
FBA Shipment を作成
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>"
}
]
}
'import requests
url = "https://api.returnshelper.com/uat/user/api/Fba/FbaShipment/create"
payload = { "createFbaShipmentPayloadList": [
{
"trackingNumber": "<string>",
"warehouseId": 123,
"removalOrderId": "<string>"
}
] }
headers = {
"x-rr-apikey": "<api-key>",
"x-rr-apitoken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-rr-apikey': '<api-key>',
'x-rr-apitoken': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
createFbaShipmentPayloadList: [{trackingNumber: '<string>', warehouseId: 123, removalOrderId: '<string>'}]
})
};
fetch('https://api.returnshelper.com/uat/user/api/Fba/FbaShipment/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.returnshelper.com/uat/user/api/Fba/FbaShipment/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'createFbaShipmentPayloadList' => [
[
'trackingNumber' => '<string>',
'warehouseId' => 123,
'removalOrderId' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-rr-apikey: <api-key>",
"x-rr-apitoken: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.returnshelper.com/uat/user/api/Fba/FbaShipment/create"
payload := strings.NewReader("{\n \"createFbaShipmentPayloadList\": [\n {\n \"trackingNumber\": \"<string>\",\n \"warehouseId\": 123,\n \"removalOrderId\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-rr-apikey", "<api-key>")
req.Header.Add("x-rr-apitoken", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.returnshelper.com/uat/user/api/Fba/FbaShipment/create")
.header("x-rr-apikey", "<api-key>")
.header("x-rr-apitoken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"createFbaShipmentPayloadList\": [\n {\n \"trackingNumber\": \"<string>\",\n \"warehouseId\": 123,\n \"removalOrderId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.returnshelper.com/uat/user/api/Fba/FbaShipment/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-rr-apikey"] = '<api-key>'
request["x-rr-apitoken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"createFbaShipmentPayloadList\": [\n {\n \"trackingNumber\": \"<string>\",\n \"warehouseId\": 123,\n \"removalOrderId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"fbaShipmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"apiId": 123,
"warehouseId": 123,
"fbaShipmentStatusCode": "<string>",
"removalOrderId": "<string>",
"trackingNumber": "<string>",
"arrivalOn": "2023-11-07T05:31:56Z"
}
]
}{
"correlationId": "<string>",
"meta": {
"status": 123,
"data": {},
"errorCode": "<string>",
"error": {}
}
}このページはAIによって自動翻訳されています。API技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。
呼び出すタイミング
- 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、宛先倉庫が紐付けられます。 - パーセルが物理的に到着すると、倉庫はこれらのレコードを照合して
fbaShipmentArrivedwebhook をトリガーします。 - ラベルは生成されません——発送するのは Amazon であり、あなたではありません。
関連
- FBA シップメント詳細を取得 — webhook がキャッシュされていない
fbaShipmentIdを参照した場合に、ID で 1 件取得。 - FBA 指示を作成 — パーセルが到着したら(webhook で通知)、倉庫に在庫の取り扱い(廃棄・リコール・補充など)を指示します。
- Webhooks — FBA シップメントのライフサイクル(到着、指示完了など)はすべて webhook 経由で配信されます。