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": {}
}
}Shipment
Create 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": {}
}
}Registers one or more inbound FBA shipments — i.e. tells Return Helper “Amazon dispatched a removal order with this tracking number to this warehouse, expect it.” This is metadata-only: it doesn’t create a label or trigger a physical action; it lets the warehouse correlate an arriving parcel to your removal order when it shows up.
When to call
- After you create a Removal Order in Amazon Seller Central (or via the SP-API), once you have a tracking number from the carrier Amazon assigned.
- For each shipment within a removal order — Amazon often splits a single removal order into multiple parcels with different tracking numbers; create one FBA shipment per tracking number.
Required fields
Each entry increateFbaShipmentPayloadList:
trackingNumber— non-empty, single-line, must match a recognised tracking-number format. Globally unique — you cannot reuse a tracking number that’s already on a non-expired FBA shipment record.removalOrderId— Amazon’s removal order ID (e.g.WS-1234567). Single-line, valid format.warehouseId— The warehouse that the FBA is shipping to, must be a warehouse your account is authorised for. Discover via Get all warehouses accessible to user.
Cross-payload rules
- No duplicate
trackingNumberwithin a single batch. - Same
removalOrderIdmust always map to the samewarehouseIdwithin the batch — you can’t say “removal order WS-1 → warehouse 5” and “removal order WS-1 → warehouse 7” in the same call.
Side effects
- An
FbaShipmentrecord is created per payload, linking the tracking number, removal order, and destination warehouse. - When the parcel physically arrives, the warehouse uses these records to match it and trigger the
fbaShipmentArrivedwebhook. - No label is generated — you’re not shipping; Amazon is.
Related
- Get FBA shipment details — fetch a single record by
fbaShipmentIdif a webhook event references one you don’t have cached. - Create FBA instructions — once a parcel has arrived (signalled by webhook), instruct the warehouse what to do with the inventory (dispose, recall, replenish, etc.).
- Webhooks — the FBA shipment lifecycle (arrival, instruction completion, etc.) is delivered exclusively via webhook events.
Authorizations
Your API key
Your API token — keep this private
Body
application/json
List of FBA shipment creation payloads
Show child attributes
Show child attributes
Response
Success
List of created FBA shipments
Show child attributes
Show child attributes