Get consolidate shipping order
curl --request GET \
--url https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/get \
--header 'x-rr-apikey: <api-key>' \
--header 'x-rr-apitoken: <api-key>'import requests
url = "https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/get"
headers = {
"x-rr-apikey": "<api-key>",
"x-rr-apitoken": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-rr-apikey': '<api-key>', 'x-rr-apitoken': '<api-key>'}
};
fetch('https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/get', 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/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/get"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-rr-apikey", "<api-key>")
req.Header.Add("x-rr-apitoken", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/get")
.header("x-rr-apikey", "<api-key>")
.header("x-rr-apitoken", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-rr-apikey"] = '<api-key>'
request["x-rr-apitoken"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"consolidateShippingOrderId": "<string>",
"consolidateShippingOrderNumber": "<string>",
"outboundWarehouseId": 123,
"destinationType": "CUSTOM_ADDRESS",
"destinationWarehouseId": 123,
"packagingType": "BOX",
"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": {},
"pendingInventoryList": [
{
"consolidateShippingInventoryId": "<string>",
"itemType": "RMA",
"returnInventoryId": 123,
"rma": "<string>",
"fnsku": "<string>",
"quantity": 123,
"consolidateShippingInventoryStatus": "<string>"
}
],
"inProgressInventoryList": [
{
"consolidateShippingInventoryId": "<string>",
"itemType": "RMA",
"returnInventoryId": 123,
"rma": "<string>",
"fnsku": "<string>",
"quantity": 123,
"consolidateShippingInventoryStatus": "<string>"
}
],
"shipmentList": [
{
"consolidateShippingShipmentId": "<string>",
"consolidateShippingShipmentNumber": "<string>",
"consolidateShippingOrderId": "<string>",
"consolidateShippingShipmentStatus": "<string>",
"currencyCode": "<string>",
"shippingFee": 123,
"chargeableWeight": 123,
"awb": "<string>",
"serviceProvider": "<string>",
"shipDate": "2023-11-07T05:31:56Z",
"boxList": [
{
"consolidateShippingShipmentBoxId": "<string>",
"consolidateShippingShipmentId": "<string>",
"consolidateShippingShipmentBoxStatus": "<string>",
"boxNumber": "<string>",
"boxType": "<string>",
"invoiceFileKey": "<string>",
"weight": 123,
"dimension1": 123,
"dimension2": 123,
"dimension3": 123,
"consolidateShippingInventoryList": [
{
"consolidateShippingInventoryId": "<string>",
"itemType": "RMA",
"returnInventoryId": 123,
"rma": "<string>",
"fnsku": "<string>",
"quantity": 123,
"consolidateShippingInventoryStatus": "<string>"
}
]
}
]
}
]
}{
"correlationId": "<string>",
"meta": {
"status": 123,
"data": {},
"errorCode": "<string>",
"error": {}
}
}注文
Consolidate Shipping Order を取得
GET
/
api
/
outbound
/
consolidateShipping
/
order
/
get
Get consolidate shipping order
curl --request GET \
--url https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/get \
--header 'x-rr-apikey: <api-key>' \
--header 'x-rr-apitoken: <api-key>'import requests
url = "https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/get"
headers = {
"x-rr-apikey": "<api-key>",
"x-rr-apitoken": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-rr-apikey': '<api-key>', 'x-rr-apitoken': '<api-key>'}
};
fetch('https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/get', 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/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/get"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-rr-apikey", "<api-key>")
req.Header.Add("x-rr-apitoken", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/get")
.header("x-rr-apikey", "<api-key>")
.header("x-rr-apitoken", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-rr-apikey"] = '<api-key>'
request["x-rr-apitoken"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"consolidateShippingOrderId": "<string>",
"consolidateShippingOrderNumber": "<string>",
"outboundWarehouseId": 123,
"destinationType": "CUSTOM_ADDRESS",
"destinationWarehouseId": 123,
"packagingType": "BOX",
"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": {},
"pendingInventoryList": [
{
"consolidateShippingInventoryId": "<string>",
"itemType": "RMA",
"returnInventoryId": 123,
"rma": "<string>",
"fnsku": "<string>",
"quantity": 123,
"consolidateShippingInventoryStatus": "<string>"
}
],
"inProgressInventoryList": [
{
"consolidateShippingInventoryId": "<string>",
"itemType": "RMA",
"returnInventoryId": 123,
"rma": "<string>",
"fnsku": "<string>",
"quantity": 123,
"consolidateShippingInventoryStatus": "<string>"
}
],
"shipmentList": [
{
"consolidateShippingShipmentId": "<string>",
"consolidateShippingShipmentNumber": "<string>",
"consolidateShippingOrderId": "<string>",
"consolidateShippingShipmentStatus": "<string>",
"currencyCode": "<string>",
"shippingFee": 123,
"chargeableWeight": 123,
"awb": "<string>",
"serviceProvider": "<string>",
"shipDate": "2023-11-07T05:31:56Z",
"boxList": [
{
"consolidateShippingShipmentBoxId": "<string>",
"consolidateShippingShipmentId": "<string>",
"consolidateShippingShipmentBoxStatus": "<string>",
"boxNumber": "<string>",
"boxType": "<string>",
"invoiceFileKey": "<string>",
"weight": 123,
"dimension1": 123,
"dimension2": 123,
"dimension3": 123,
"consolidateShippingInventoryList": [
{
"consolidateShippingInventoryId": "<string>",
"itemType": "RMA",
"returnInventoryId": 123,
"rma": "<string>",
"fnsku": "<string>",
"quantity": 123,
"consolidateShippingInventoryStatus": "<string>"
}
]
}
]
}
]
}{
"correlationId": "<string>",
"meta": {
"status": 123,
"data": {},
"errorCode": "<string>",
"error": {}
}
}このページはAIによって自動翻訳されています。API技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。
| リスト | 内容 |
|---|---|
pendingInventoryList | まだ梱包されていない明細。quantity は明細の合計数。 |
inProgressInventoryList | 一部だけ梱包された明細。quantity はまだ梱包していない個数。 |
shipmentList[].boxList[].consolidateShippingInventoryList | その箱に梱包された明細。quantity はその箱の中の個数。 |
RH_WAREHOUSE の注文では、shipTo は宛先倉庫の住所、packagingType は null です。shippingFee は各 Shipment の送料の合計です。
注文が存在しない、またはお客様のアカウントに属さない場合は meta.status: 404 を返します。
変更を追跡するには、このエンドポイントを繰り返し呼び出すのではなく、Consolidate Shipping の webhook を使用してください。承認
Your API key
Your API token — keep this private
クエリパラメータ
Consolidate shipping order ID (ULID)
レスポンス
Success
ULID
利用可能なオプション:
CUSTOM_ADDRESS, RH_WAREHOUSE RH_WAREHOUSE orders only
null on RH_WAREHOUSE orders and on CUSTOM_ADDRESS orders created without one.
利用可能なオプション:
BOX, PALLET, null Sum of the shipments' shipping fees
On RH_WAREHOUSE orders, the destination warehouse's address
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Lines not yet packed
Show child attributes
Show child attributes
Lines partly packed. quantity is the pieces still to pack
Show child attributes
Show child attributes
Show child attributes
Show child attributes