Create return shipment
curl --request POST \
--url https://api.returnshelper.com/uat/user/api/ReturnShipment/createReturnShipment \
--header 'Content-Type: application/json' \
--header 'x-rr-apikey: <api-key>' \
--header 'x-rr-apitoken: <api-key>' \
--data '
{
"serviceTypeCode": "fedex_ground",
"orderTitle": "Return Label Title",
"totalValue": 100,
"totalValueCurrency": "usd",
"shipment": {
"shipToWarehouseId": 2,
"boxType": "cus",
"shipFrom": {
"country": "usa",
"contactName": "Your name",
"street1": "Some address line 1",
"state": "tx",
"city": "Houston",
"postalCode": "77235",
"phone": "15622708183",
"email": "user@example.com",
"fax": "<string>",
"street2": "Some address line 2",
"street3": "<string>"
},
"parcel": {
"weight": 10.5,
"weightUnit": "g",
"length": 10,
"width": 10,
"height": 10,
"dimensionUnit": "cm",
"items": [
{
"description": "Test item",
"weight": 10.5,
"value": 100,
"weightUom": "g",
"valueCurrencyCode": "usd"
}
]
},
"sellerReferenceNumber": "<string>",
"customFieldMap": {}
},
"sellerReferenceNumber": "<string>",
"remarks": "<string>"
}
'import requests
url = "https://api.returnshelper.com/uat/user/api/ReturnShipment/createReturnShipment"
payload = {
"serviceTypeCode": "fedex_ground",
"orderTitle": "Return Label Title",
"totalValue": 100,
"totalValueCurrency": "usd",
"shipment": {
"shipToWarehouseId": 2,
"boxType": "cus",
"shipFrom": {
"country": "usa",
"contactName": "Your name",
"street1": "Some address line 1",
"state": "tx",
"city": "Houston",
"postalCode": "77235",
"phone": "15622708183",
"email": "user@example.com",
"fax": "<string>",
"street2": "Some address line 2",
"street3": "<string>"
},
"parcel": {
"weight": 10.5,
"weightUnit": "g",
"length": 10,
"width": 10,
"height": 10,
"dimensionUnit": "cm",
"items": [
{
"description": "Test item",
"weight": 10.5,
"value": 100,
"weightUom": "g",
"valueCurrencyCode": "usd"
}
]
},
"sellerReferenceNumber": "<string>",
"customFieldMap": {}
},
"sellerReferenceNumber": "<string>",
"remarks": "<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({
serviceTypeCode: 'fedex_ground',
orderTitle: 'Return Label Title',
totalValue: 100,
totalValueCurrency: 'usd',
shipment: {
shipToWarehouseId: 2,
boxType: 'cus',
shipFrom: {
country: 'usa',
contactName: 'Your name',
street1: 'Some address line 1',
state: 'tx',
city: 'Houston',
postalCode: '77235',
phone: '15622708183',
email: 'user@example.com',
fax: '<string>',
street2: 'Some address line 2',
street3: '<string>'
},
parcel: {
weight: 10.5,
weightUnit: 'g',
length: 10,
width: 10,
height: 10,
dimensionUnit: 'cm',
items: [
{
description: 'Test item',
weight: 10.5,
value: 100,
weightUom: 'g',
valueCurrencyCode: 'usd'
}
]
},
sellerReferenceNumber: '<string>',
customFieldMap: {}
},
sellerReferenceNumber: '<string>',
remarks: '<string>'
})
};
fetch('https://api.returnshelper.com/uat/user/api/ReturnShipment/createReturnShipment', 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/ReturnShipment/createReturnShipment",
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([
'serviceTypeCode' => 'fedex_ground',
'orderTitle' => 'Return Label Title',
'totalValue' => 100,
'totalValueCurrency' => 'usd',
'shipment' => [
'shipToWarehouseId' => 2,
'boxType' => 'cus',
'shipFrom' => [
'country' => 'usa',
'contactName' => 'Your name',
'street1' => 'Some address line 1',
'state' => 'tx',
'city' => 'Houston',
'postalCode' => '77235',
'phone' => '15622708183',
'email' => 'user@example.com',
'fax' => '<string>',
'street2' => 'Some address line 2',
'street3' => '<string>'
],
'parcel' => [
'weight' => 10.5,
'weightUnit' => 'g',
'length' => 10,
'width' => 10,
'height' => 10,
'dimensionUnit' => 'cm',
'items' => [
[
'description' => 'Test item',
'weight' => 10.5,
'value' => 100,
'weightUom' => 'g',
'valueCurrencyCode' => 'usd'
]
]
],
'sellerReferenceNumber' => '<string>',
'customFieldMap' => [
]
],
'sellerReferenceNumber' => '<string>',
'remarks' => '<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/ReturnShipment/createReturnShipment"
payload := strings.NewReader("{\n \"serviceTypeCode\": \"fedex_ground\",\n \"orderTitle\": \"Return Label Title\",\n \"totalValue\": 100,\n \"totalValueCurrency\": \"usd\",\n \"shipment\": {\n \"shipToWarehouseId\": 2,\n \"boxType\": \"cus\",\n \"shipFrom\": {\n \"country\": \"usa\",\n \"contactName\": \"Your name\",\n \"street1\": \"Some address line 1\",\n \"state\": \"tx\",\n \"city\": \"Houston\",\n \"postalCode\": \"77235\",\n \"phone\": \"15622708183\",\n \"email\": \"user@example.com\",\n \"fax\": \"<string>\",\n \"street2\": \"Some address line 2\",\n \"street3\": \"<string>\"\n },\n \"parcel\": {\n \"weight\": 10.5,\n \"weightUnit\": \"g\",\n \"length\": 10,\n \"width\": 10,\n \"height\": 10,\n \"dimensionUnit\": \"cm\",\n \"items\": [\n {\n \"description\": \"Test item\",\n \"weight\": 10.5,\n \"value\": 100,\n \"weightUom\": \"g\",\n \"valueCurrencyCode\": \"usd\"\n }\n ]\n },\n \"sellerReferenceNumber\": \"<string>\",\n \"customFieldMap\": {}\n },\n \"sellerReferenceNumber\": \"<string>\",\n \"remarks\": \"<string>\"\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/ReturnShipment/createReturnShipment")
.header("x-rr-apikey", "<api-key>")
.header("x-rr-apitoken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"serviceTypeCode\": \"fedex_ground\",\n \"orderTitle\": \"Return Label Title\",\n \"totalValue\": 100,\n \"totalValueCurrency\": \"usd\",\n \"shipment\": {\n \"shipToWarehouseId\": 2,\n \"boxType\": \"cus\",\n \"shipFrom\": {\n \"country\": \"usa\",\n \"contactName\": \"Your name\",\n \"street1\": \"Some address line 1\",\n \"state\": \"tx\",\n \"city\": \"Houston\",\n \"postalCode\": \"77235\",\n \"phone\": \"15622708183\",\n \"email\": \"user@example.com\",\n \"fax\": \"<string>\",\n \"street2\": \"Some address line 2\",\n \"street3\": \"<string>\"\n },\n \"parcel\": {\n \"weight\": 10.5,\n \"weightUnit\": \"g\",\n \"length\": 10,\n \"width\": 10,\n \"height\": 10,\n \"dimensionUnit\": \"cm\",\n \"items\": [\n {\n \"description\": \"Test item\",\n \"weight\": 10.5,\n \"value\": 100,\n \"weightUom\": \"g\",\n \"valueCurrencyCode\": \"usd\"\n }\n ]\n },\n \"sellerReferenceNumber\": \"<string>\",\n \"customFieldMap\": {}\n },\n \"sellerReferenceNumber\": \"<string>\",\n \"remarks\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.returnshelper.com/uat/user/api/ReturnShipment/createReturnShipment")
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 \"serviceTypeCode\": \"fedex_ground\",\n \"orderTitle\": \"Return Label Title\",\n \"totalValue\": 100,\n \"totalValueCurrency\": \"usd\",\n \"shipment\": {\n \"shipToWarehouseId\": 2,\n \"boxType\": \"cus\",\n \"shipFrom\": {\n \"country\": \"usa\",\n \"contactName\": \"Your name\",\n \"street1\": \"Some address line 1\",\n \"state\": \"tx\",\n \"city\": \"Houston\",\n \"postalCode\": \"77235\",\n \"phone\": \"15622708183\",\n \"email\": \"user@example.com\",\n \"fax\": \"<string>\",\n \"street2\": \"Some address line 2\",\n \"street3\": \"<string>\"\n },\n \"parcel\": {\n \"weight\": 10.5,\n \"weightUnit\": \"g\",\n \"length\": 10,\n \"width\": 10,\n \"height\": 10,\n \"dimensionUnit\": \"cm\",\n \"items\": [\n {\n \"description\": \"Test item\",\n \"weight\": 10.5,\n \"value\": 100,\n \"weightUom\": \"g\",\n \"valueCurrencyCode\": \"usd\"\n }\n ]\n },\n \"sellerReferenceNumber\": \"<string>\",\n \"customFieldMap\": {}\n },\n \"sellerReferenceNumber\": \"<string>\",\n \"remarks\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"returnRequestId": 123,
"returnRequestNumber": "<string>",
"shipmentId": 123,
"referenceNumber": "<string>",
"labelId": 123,
"labelRequestStatusCode": "<string>",
"cost": 123,
"costCurrencyCode": "<string>"
}
}{
"correlationId": "<string>",
"meta": {
"status": 123,
"data": {},
"errorCode": "<string>",
"error": {}
}
}退件運貨單（建立）
建立 Return Shipment
POST
/
api
/
ReturnShipment
/
createReturnShipment
Create return shipment
curl --request POST \
--url https://api.returnshelper.com/uat/user/api/ReturnShipment/createReturnShipment \
--header 'Content-Type: application/json' \
--header 'x-rr-apikey: <api-key>' \
--header 'x-rr-apitoken: <api-key>' \
--data '
{
"serviceTypeCode": "fedex_ground",
"orderTitle": "Return Label Title",
"totalValue": 100,
"totalValueCurrency": "usd",
"shipment": {
"shipToWarehouseId": 2,
"boxType": "cus",
"shipFrom": {
"country": "usa",
"contactName": "Your name",
"street1": "Some address line 1",
"state": "tx",
"city": "Houston",
"postalCode": "77235",
"phone": "15622708183",
"email": "user@example.com",
"fax": "<string>",
"street2": "Some address line 2",
"street3": "<string>"
},
"parcel": {
"weight": 10.5,
"weightUnit": "g",
"length": 10,
"width": 10,
"height": 10,
"dimensionUnit": "cm",
"items": [
{
"description": "Test item",
"weight": 10.5,
"value": 100,
"weightUom": "g",
"valueCurrencyCode": "usd"
}
]
},
"sellerReferenceNumber": "<string>",
"customFieldMap": {}
},
"sellerReferenceNumber": "<string>",
"remarks": "<string>"
}
'import requests
url = "https://api.returnshelper.com/uat/user/api/ReturnShipment/createReturnShipment"
payload = {
"serviceTypeCode": "fedex_ground",
"orderTitle": "Return Label Title",
"totalValue": 100,
"totalValueCurrency": "usd",
"shipment": {
"shipToWarehouseId": 2,
"boxType": "cus",
"shipFrom": {
"country": "usa",
"contactName": "Your name",
"street1": "Some address line 1",
"state": "tx",
"city": "Houston",
"postalCode": "77235",
"phone": "15622708183",
"email": "user@example.com",
"fax": "<string>",
"street2": "Some address line 2",
"street3": "<string>"
},
"parcel": {
"weight": 10.5,
"weightUnit": "g",
"length": 10,
"width": 10,
"height": 10,
"dimensionUnit": "cm",
"items": [
{
"description": "Test item",
"weight": 10.5,
"value": 100,
"weightUom": "g",
"valueCurrencyCode": "usd"
}
]
},
"sellerReferenceNumber": "<string>",
"customFieldMap": {}
},
"sellerReferenceNumber": "<string>",
"remarks": "<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({
serviceTypeCode: 'fedex_ground',
orderTitle: 'Return Label Title',
totalValue: 100,
totalValueCurrency: 'usd',
shipment: {
shipToWarehouseId: 2,
boxType: 'cus',
shipFrom: {
country: 'usa',
contactName: 'Your name',
street1: 'Some address line 1',
state: 'tx',
city: 'Houston',
postalCode: '77235',
phone: '15622708183',
email: 'user@example.com',
fax: '<string>',
street2: 'Some address line 2',
street3: '<string>'
},
parcel: {
weight: 10.5,
weightUnit: 'g',
length: 10,
width: 10,
height: 10,
dimensionUnit: 'cm',
items: [
{
description: 'Test item',
weight: 10.5,
value: 100,
weightUom: 'g',
valueCurrencyCode: 'usd'
}
]
},
sellerReferenceNumber: '<string>',
customFieldMap: {}
},
sellerReferenceNumber: '<string>',
remarks: '<string>'
})
};
fetch('https://api.returnshelper.com/uat/user/api/ReturnShipment/createReturnShipment', 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/ReturnShipment/createReturnShipment",
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([
'serviceTypeCode' => 'fedex_ground',
'orderTitle' => 'Return Label Title',
'totalValue' => 100,
'totalValueCurrency' => 'usd',
'shipment' => [
'shipToWarehouseId' => 2,
'boxType' => 'cus',
'shipFrom' => [
'country' => 'usa',
'contactName' => 'Your name',
'street1' => 'Some address line 1',
'state' => 'tx',
'city' => 'Houston',
'postalCode' => '77235',
'phone' => '15622708183',
'email' => 'user@example.com',
'fax' => '<string>',
'street2' => 'Some address line 2',
'street3' => '<string>'
],
'parcel' => [
'weight' => 10.5,
'weightUnit' => 'g',
'length' => 10,
'width' => 10,
'height' => 10,
'dimensionUnit' => 'cm',
'items' => [
[
'description' => 'Test item',
'weight' => 10.5,
'value' => 100,
'weightUom' => 'g',
'valueCurrencyCode' => 'usd'
]
]
],
'sellerReferenceNumber' => '<string>',
'customFieldMap' => [
]
],
'sellerReferenceNumber' => '<string>',
'remarks' => '<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/ReturnShipment/createReturnShipment"
payload := strings.NewReader("{\n \"serviceTypeCode\": \"fedex_ground\",\n \"orderTitle\": \"Return Label Title\",\n \"totalValue\": 100,\n \"totalValueCurrency\": \"usd\",\n \"shipment\": {\n \"shipToWarehouseId\": 2,\n \"boxType\": \"cus\",\n \"shipFrom\": {\n \"country\": \"usa\",\n \"contactName\": \"Your name\",\n \"street1\": \"Some address line 1\",\n \"state\": \"tx\",\n \"city\": \"Houston\",\n \"postalCode\": \"77235\",\n \"phone\": \"15622708183\",\n \"email\": \"user@example.com\",\n \"fax\": \"<string>\",\n \"street2\": \"Some address line 2\",\n \"street3\": \"<string>\"\n },\n \"parcel\": {\n \"weight\": 10.5,\n \"weightUnit\": \"g\",\n \"length\": 10,\n \"width\": 10,\n \"height\": 10,\n \"dimensionUnit\": \"cm\",\n \"items\": [\n {\n \"description\": \"Test item\",\n \"weight\": 10.5,\n \"value\": 100,\n \"weightUom\": \"g\",\n \"valueCurrencyCode\": \"usd\"\n }\n ]\n },\n \"sellerReferenceNumber\": \"<string>\",\n \"customFieldMap\": {}\n },\n \"sellerReferenceNumber\": \"<string>\",\n \"remarks\": \"<string>\"\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/ReturnShipment/createReturnShipment")
.header("x-rr-apikey", "<api-key>")
.header("x-rr-apitoken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"serviceTypeCode\": \"fedex_ground\",\n \"orderTitle\": \"Return Label Title\",\n \"totalValue\": 100,\n \"totalValueCurrency\": \"usd\",\n \"shipment\": {\n \"shipToWarehouseId\": 2,\n \"boxType\": \"cus\",\n \"shipFrom\": {\n \"country\": \"usa\",\n \"contactName\": \"Your name\",\n \"street1\": \"Some address line 1\",\n \"state\": \"tx\",\n \"city\": \"Houston\",\n \"postalCode\": \"77235\",\n \"phone\": \"15622708183\",\n \"email\": \"user@example.com\",\n \"fax\": \"<string>\",\n \"street2\": \"Some address line 2\",\n \"street3\": \"<string>\"\n },\n \"parcel\": {\n \"weight\": 10.5,\n \"weightUnit\": \"g\",\n \"length\": 10,\n \"width\": 10,\n \"height\": 10,\n \"dimensionUnit\": \"cm\",\n \"items\": [\n {\n \"description\": \"Test item\",\n \"weight\": 10.5,\n \"value\": 100,\n \"weightUom\": \"g\",\n \"valueCurrencyCode\": \"usd\"\n }\n ]\n },\n \"sellerReferenceNumber\": \"<string>\",\n \"customFieldMap\": {}\n },\n \"sellerReferenceNumber\": \"<string>\",\n \"remarks\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.returnshelper.com/uat/user/api/ReturnShipment/createReturnShipment")
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 \"serviceTypeCode\": \"fedex_ground\",\n \"orderTitle\": \"Return Label Title\",\n \"totalValue\": 100,\n \"totalValueCurrency\": \"usd\",\n \"shipment\": {\n \"shipToWarehouseId\": 2,\n \"boxType\": \"cus\",\n \"shipFrom\": {\n \"country\": \"usa\",\n \"contactName\": \"Your name\",\n \"street1\": \"Some address line 1\",\n \"state\": \"tx\",\n \"city\": \"Houston\",\n \"postalCode\": \"77235\",\n \"phone\": \"15622708183\",\n \"email\": \"user@example.com\",\n \"fax\": \"<string>\",\n \"street2\": \"Some address line 2\",\n \"street3\": \"<string>\"\n },\n \"parcel\": {\n \"weight\": 10.5,\n \"weightUnit\": \"g\",\n \"length\": 10,\n \"width\": 10,\n \"height\": 10,\n \"dimensionUnit\": \"cm\",\n \"items\": [\n {\n \"description\": \"Test item\",\n \"weight\": 10.5,\n \"value\": 100,\n \"weightUom\": \"g\",\n \"valueCurrencyCode\": \"usd\"\n }\n ]\n },\n \"sellerReferenceNumber\": \"<string>\",\n \"customFieldMap\": {}\n },\n \"sellerReferenceNumber\": \"<string>\",\n \"remarks\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"returnRequestId": 123,
"returnRequestNumber": "<string>",
"shipmentId": 123,
"referenceNumber": "<string>",
"labelId": 123,
"labelRequestStatusCode": "<string>",
"cost": 123,
"costCurrencyCode": "<string>"
}
}{
"correlationId": "<string>",
"meta": {
"status": 123,
"data": {},
"errorCode": "<string>",
"error": {}
}
}此頁面由 AI 自動翻譯。API 技術規格以英文呈現為標準。如有任何疑問，請參閱英文版本。
labelRequestStatusCode（通常為 queued），實際面單 URL 稍後透過 webhook 推送。
前置條件
呼叫前請備妥：serviceTypeCode— 從下列任一端點取得可用的退件服務：- 始發與目的地國家代碼 — 透過 取得所有始發國家 與 取得所有國家 取得。代碼使用 ISO3（
usa、gbr、chn）。 - 包裹尺寸與重量 — 必填且必須
> 0。可透過 取得所有尺寸單位 與 取得所有重量單位 驗證單位。 - 等冪鍵 — 強烈建議。請在
x-returnhelper-idempotency-key中傳入新的 UUID，以避免重試時產生重複的運貨單。詳見 等冪性章節。
重要欄位
totalValue與totalValueCurrency—totalValue必須嚴格等於parcel.items[].value之和。幣別使用 ISO 4217（例如USD、GBP、EUR）；可透過 取得所有交易類型 確認幣別代碼是否支援。parcel.items— 是否支援多明細取決於您的帳戶設定。僅支援單明細的帳戶若提交多明細，會收到驗證軟錯誤。如需調整設定，請聯絡客服。- 尺寸 —
dimension1為最長邊，dimension2為次長，dimension3為最短。 sellerReferenceNumber— 您賣家自訂的識別碼，可在三個互相獨立的層級（頂層、shipment、以及parcel.items[]內每條 item）上傳入。原樣保存並在 Webhook 事件中回傳，便於與您自己的訂單系統對帳。層級語意、省略時的回退行為，以及建議的對帳工作流見 Seller Reference Number。
面單產生為非同步
即時回應包含labelRequestStatusCode: queued。最終面單 URL 與追蹤號透過 labelGenerated webhook 事件推送（產生失敗則為 labelFailed）；倉庫收件由 markShipmentArrive 事件通知，隨後會有 inventoryCreated 事件。請訂閱 Webhooks——webhook 是運貨單生命週期的真實資料來源，並非輪詢的退路。
相關
- 依始發位置取得運送費用 — 在提交前預覽費用。
- Webhooks — 訂閱
labelGenerated、labelFailed與markShipmentArrive，以接收完整的運貨單生命週期。 - Seller Reference Number — 如何設定
sellerReferenceNumber並依據 Webhook 事件與您自己的訂單紀錄對帳。
授權
Your API key
Your API token — keep this private
主體
application/json
Return service type code
Order title / return title
Total declared value of the return
Currency code for totalValue (e.g. USD)
Shipment details including origin address and parcel info
Show child attributes
Show child attributes
Seller reference number
Additional remarks
回應
Success
Created return shipment details
Show child attributes
Show child attributes
⌘I