Create consolidate shipping order
curl --request POST \
--url https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/create \
--header 'Content-Type: application/json' \
--header 'x-rr-apikey: <api-key>' \
--header 'x-rr-apitoken: <api-key>' \
--data '
{
"outboundWarehouseId": 123,
"destinationType": "CUSTOM_ADDRESS",
"destinationWarehouseId": 123,
"deliveryInstructions": "<string>",
"customFieldMap": {}
}
'import requests
url = "https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/create"
payload = {
"outboundWarehouseId": 123,
"destinationType": "CUSTOM_ADDRESS",
"destinationWarehouseId": 123,
"deliveryInstructions": "<string>",
"customFieldMap": {}
}
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({
outboundWarehouseId: 123,
destinationType: 'CUSTOM_ADDRESS',
destinationWarehouseId: 123,
deliveryInstructions: '<string>',
customFieldMap: {}
})
};
fetch('https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/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/outbound/consolidateShipping/order/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([
'outboundWarehouseId' => 123,
'destinationType' => 'CUSTOM_ADDRESS',
'destinationWarehouseId' => 123,
'deliveryInstructions' => '<string>',
'customFieldMap' => [
]
]),
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/outbound/consolidateShipping/order/create"
payload := strings.NewReader("{\n \"outboundWarehouseId\": 123,\n \"destinationType\": \"CUSTOM_ADDRESS\",\n \"destinationWarehouseId\": 123,\n \"deliveryInstructions\": \"<string>\",\n \"customFieldMap\": {}\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/outbound/consolidateShipping/order/create")
.header("x-rr-apikey", "<api-key>")
.header("x-rr-apitoken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"outboundWarehouseId\": 123,\n \"destinationType\": \"CUSTOM_ADDRESS\",\n \"destinationWarehouseId\": 123,\n \"deliveryInstructions\": \"<string>\",\n \"customFieldMap\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/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 \"outboundWarehouseId\": 123,\n \"destinationType\": \"CUSTOM_ADDRESS\",\n \"destinationWarehouseId\": 123,\n \"deliveryInstructions\": \"<string>\",\n \"customFieldMap\": {}\n}"
response = http.request(request)
puts response.read_body{
"consolidateShippingOrderId": "<string>",
"consolidateShippingOrderNumber": "<string>",
"outboundWarehouseId": 123,
"shippingFee": 123,
"deliveryInstructions": "<string>",
"consolidateShippingOrderStatus": "<string>",
"shipTo": {
"shipToCountry": "<string>",
"shipToContactName": "<string>",
"shipToPhone": "<string>",
"shipToFax": "<string>",
"shipToEmail": "jsmith@example.com",
"shipToCompanyName": "<string>",
"shipToStreet1": "<string>",
"shipToStreet2": "<string>",
"shipToStreet3": "<string>",
"shipToCity": "<string>",
"shipToState": "<string>",
"shipToPostalCode": "<string>",
"shipToType": "<string>"
},
"customFieldMap": {}
}{
"correlationId": "<string>",
"meta": {
"status": 123,
"data": {},
"errorCode": "<string>",
"error": {}
}
}訂單
建立 Consolidate Shipping Order
POST
/
api
/
outbound
/
consolidateShipping
/
order
/
create
Create consolidate shipping order
curl --request POST \
--url https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/create \
--header 'Content-Type: application/json' \
--header 'x-rr-apikey: <api-key>' \
--header 'x-rr-apitoken: <api-key>' \
--data '
{
"outboundWarehouseId": 123,
"destinationType": "CUSTOM_ADDRESS",
"destinationWarehouseId": 123,
"deliveryInstructions": "<string>",
"customFieldMap": {}
}
'import requests
url = "https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/create"
payload = {
"outboundWarehouseId": 123,
"destinationType": "CUSTOM_ADDRESS",
"destinationWarehouseId": 123,
"deliveryInstructions": "<string>",
"customFieldMap": {}
}
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({
outboundWarehouseId: 123,
destinationType: 'CUSTOM_ADDRESS',
destinationWarehouseId: 123,
deliveryInstructions: '<string>',
customFieldMap: {}
})
};
fetch('https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/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/outbound/consolidateShipping/order/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([
'outboundWarehouseId' => 123,
'destinationType' => 'CUSTOM_ADDRESS',
'destinationWarehouseId' => 123,
'deliveryInstructions' => '<string>',
'customFieldMap' => [
]
]),
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/outbound/consolidateShipping/order/create"
payload := strings.NewReader("{\n \"outboundWarehouseId\": 123,\n \"destinationType\": \"CUSTOM_ADDRESS\",\n \"destinationWarehouseId\": 123,\n \"deliveryInstructions\": \"<string>\",\n \"customFieldMap\": {}\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/outbound/consolidateShipping/order/create")
.header("x-rr-apikey", "<api-key>")
.header("x-rr-apitoken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"outboundWarehouseId\": 123,\n \"destinationType\": \"CUSTOM_ADDRESS\",\n \"destinationWarehouseId\": 123,\n \"deliveryInstructions\": \"<string>\",\n \"customFieldMap\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/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 \"outboundWarehouseId\": 123,\n \"destinationType\": \"CUSTOM_ADDRESS\",\n \"destinationWarehouseId\": 123,\n \"deliveryInstructions\": \"<string>\",\n \"customFieldMap\": {}\n}"
response = http.request(request)
puts response.read_body{
"consolidateShippingOrderId": "<string>",
"consolidateShippingOrderNumber": "<string>",
"outboundWarehouseId": 123,
"shippingFee": 123,
"deliveryInstructions": "<string>",
"consolidateShippingOrderStatus": "<string>",
"shipTo": {
"shipToCountry": "<string>",
"shipToContactName": "<string>",
"shipToPhone": "<string>",
"shipToFax": "<string>",
"shipToEmail": "jsmith@example.com",
"shipToCompanyName": "<string>",
"shipToStreet1": "<string>",
"shipToStreet2": "<string>",
"shipToStreet3": "<string>",
"shipToCity": "<string>",
"shipToState": "<string>",
"shipToPostalCode": "<string>",
"shipToType": "<string>"
},
"customFieldMap": {}
}{
"correlationId": "<string>",
"meta": {
"status": 123,
"data": {},
"errorCode": "<string>",
"error": {}
}
}此頁面由 AI 自動翻譯。API 技術規格以英文呈現為標準。如有任何疑問,請參閱英文版本。
要尋找目的地倉庫,請呼叫 Get all warehouses,選擇
isConsolidateShippingDestination 為 true 的倉庫。目前香港倉庫是唯一的 RH_WAREHOUSE 目的地。
目的地規則
| 欄位 | CUSTOM_ADDRESS | RH_WAREHOUSE |
|---|---|---|
destinationWarehouseId | 忽略 | 必填 |
shipTo | 必填 | 忽略。訂單的 shipTo 會設為目的地倉庫的地址。 |
packagingType | 選填:BOX 或 PALLET | 忽略,儲存為 null |
destinationType 時,訂單為 CUSTOM_ADDRESS 訂單。
customFieldMap 的鍵只能包含大寫英文字母、數字、連字號和底線。
建立之後的每個步驟,請參閱 Consolidate Shipping 流程。
驗證失敗
meta.error 訊息 | 原因 |
|---|---|
Warehouse is not a consolidate shipping destination | destinationWarehouseId 不是目的地倉庫 |
Has no permission to create consolidate shipping order for warehouse id {id} | 您的帳戶無權使用 outboundWarehouseId |
Custom fields key can only be uppercase alphanumerics, hyphen or underscore | customFieldMap 的鍵不符合上述規則 |
授權
Your API key
Your API token — keep this private
主體
application/json
Where the order ships to. Defaults to CUSTOM_ADDRESS.
可用選項:
CUSTOM_ADDRESS, RH_WAREHOUSE Destination warehouse. Required when destinationType is RH_WAREHOUSE; must be a warehouse whose isConsolidateShippingDestination is true. Ignored for CUSTOM_ADDRESS.
CUSTOM_ADDRESS orders only. Ignored for RH_WAREHOUSE.
可用選項:
BOX, PALLET Ship-to address. Required when destinationType is CUSTOM_ADDRESS; ignored for RH_WAREHOUSE.
Show child attributes
Show child attributes
Your own key-value pairs. Keys may contain only uppercase letters, digits, hyphen and underscore.
Show child attributes
Show child attributes
回應
Success
Consolidate shipping order ID (ULID)
Show child attributes
Show child attributes
Show child attributes
Show child attributes