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