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