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": {}
}
}Order
Get 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": {}
}
}Returns one consolidate shipping order with its lines and shipments.
On
| List | Contains |
|---|---|
pendingInventoryList | Lines not yet packed. quantity is the line’s total. |
inProgressInventoryList | Lines partly packed. quantity is the pieces still to pack. |
shipmentList[].boxList[].consolidateShippingInventoryList | Lines packed in that box. quantity is the pieces in the box. |
RH_WAREHOUSE orders, shipTo is the destination warehouse’s address and packagingType is null. shippingFee is the sum of the shipments’ fees.
Returns meta.status: 404 when the order does not exist or does not belong to your account.
To track changes, use the consolidate shipping webhooks rather than calling this endpoint repeatedly.Authorizations
Your API key
Your API token — keep this private
Query Parameters
Consolidate shipping order ID (ULID)
Response
Success
ULID
Available options:
CUSTOM_ADDRESS, RH_WAREHOUSE RH_WAREHOUSE orders only
null on RH_WAREHOUSE orders and on CUSTOM_ADDRESS orders created without one.
Available options:
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