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