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,
"shippingMethod": "<string>",
"shipTo": {
"shipToCountry": "<string>",
"shipToContactName": "<string>",
"shipToPhone": "<string>",
"shipToEmail": "jsmith@example.com",
"shipToCompanyName": "<string>",
"shipToStreet1": "<string>",
"shipToCity": "<string>",
"shipToState": "<string>",
"shipToPostalCode": "<string>",
"shipToType": "<string>",
"shipToFax": "<string>",
"shipToStreet2": "<string>",
"shipToStreet3": "<string>"
},
"deliveryInstructions": "<string>",
"customFieldMap": {}
}
'import requests
url = "https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/create"
payload = {
"outboundWarehouseId": 123,
"shippingMethod": "<string>",
"shipTo": {
"shipToCountry": "<string>",
"shipToContactName": "<string>",
"shipToPhone": "<string>",
"shipToEmail": "jsmith@example.com",
"shipToCompanyName": "<string>",
"shipToStreet1": "<string>",
"shipToCity": "<string>",
"shipToState": "<string>",
"shipToPostalCode": "<string>",
"shipToType": "<string>",
"shipToFax": "<string>",
"shipToStreet2": "<string>",
"shipToStreet3": "<string>"
},
"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,
shippingMethod: '<string>',
shipTo: {
shipToCountry: '<string>',
shipToContactName: '<string>',
shipToPhone: '<string>',
shipToEmail: 'jsmith@example.com',
shipToCompanyName: '<string>',
shipToStreet1: '<string>',
shipToCity: '<string>',
shipToState: '<string>',
shipToPostalCode: '<string>',
shipToType: '<string>',
shipToFax: '<string>',
shipToStreet2: '<string>',
shipToStreet3: '<string>'
},
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,
'shippingMethod' => '<string>',
'shipTo' => [
'shipToCountry' => '<string>',
'shipToContactName' => '<string>',
'shipToPhone' => '<string>',
'shipToEmail' => 'jsmith@example.com',
'shipToCompanyName' => '<string>',
'shipToStreet1' => '<string>',
'shipToCity' => '<string>',
'shipToState' => '<string>',
'shipToPostalCode' => '<string>',
'shipToType' => '<string>',
'shipToFax' => '<string>',
'shipToStreet2' => '<string>',
'shipToStreet3' => '<string>'
],
'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 \"shippingMethod\": \"<string>\",\n \"shipTo\": {\n \"shipToCountry\": \"<string>\",\n \"shipToContactName\": \"<string>\",\n \"shipToPhone\": \"<string>\",\n \"shipToEmail\": \"jsmith@example.com\",\n \"shipToCompanyName\": \"<string>\",\n \"shipToStreet1\": \"<string>\",\n \"shipToCity\": \"<string>\",\n \"shipToState\": \"<string>\",\n \"shipToPostalCode\": \"<string>\",\n \"shipToType\": \"<string>\",\n \"shipToFax\": \"<string>\",\n \"shipToStreet2\": \"<string>\",\n \"shipToStreet3\": \"<string>\"\n },\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 \"shippingMethod\": \"<string>\",\n \"shipTo\": {\n \"shipToCountry\": \"<string>\",\n \"shipToContactName\": \"<string>\",\n \"shipToPhone\": \"<string>\",\n \"shipToEmail\": \"jsmith@example.com\",\n \"shipToCompanyName\": \"<string>\",\n \"shipToStreet1\": \"<string>\",\n \"shipToCity\": \"<string>\",\n \"shipToState\": \"<string>\",\n \"shipToPostalCode\": \"<string>\",\n \"shipToType\": \"<string>\",\n \"shipToFax\": \"<string>\",\n \"shipToStreet2\": \"<string>\",\n \"shipToStreet3\": \"<string>\"\n },\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 \"shippingMethod\": \"<string>\",\n \"shipTo\": {\n \"shipToCountry\": \"<string>\",\n \"shipToContactName\": \"<string>\",\n \"shipToPhone\": \"<string>\",\n \"shipToEmail\": \"jsmith@example.com\",\n \"shipToCompanyName\": \"<string>\",\n \"shipToStreet1\": \"<string>\",\n \"shipToCity\": \"<string>\",\n \"shipToState\": \"<string>\",\n \"shipToPostalCode\": \"<string>\",\n \"shipToType\": \"<string>\",\n \"shipToFax\": \"<string>\",\n \"shipToStreet2\": \"<string>\",\n \"shipToStreet3\": \"<string>\"\n },\n \"deliveryInstructions\": \"<string>\",\n \"customFieldMap\": {}\n}"
response = http.request(request)
puts response.read_body{
"consolidateShippingOrderId": "<string>",
"consolidateShippingOrderNumber": "<string>",
"outboundWarehouseId": 123,
"shippingMethod": "<string>",
"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": {},
"createOn": "2023-11-07T05:31:56Z",
"modifyOn": "2023-11-07T05:31:56Z"
}{
"correlationId": "<string>",
"meta": {
"status": 123,
"data": {},
"errorCode": "<string>",
"error": {}
}
}Order
Create 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,
"shippingMethod": "<string>",
"shipTo": {
"shipToCountry": "<string>",
"shipToContactName": "<string>",
"shipToPhone": "<string>",
"shipToEmail": "jsmith@example.com",
"shipToCompanyName": "<string>",
"shipToStreet1": "<string>",
"shipToCity": "<string>",
"shipToState": "<string>",
"shipToPostalCode": "<string>",
"shipToType": "<string>",
"shipToFax": "<string>",
"shipToStreet2": "<string>",
"shipToStreet3": "<string>"
},
"deliveryInstructions": "<string>",
"customFieldMap": {}
}
'import requests
url = "https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/create"
payload = {
"outboundWarehouseId": 123,
"shippingMethod": "<string>",
"shipTo": {
"shipToCountry": "<string>",
"shipToContactName": "<string>",
"shipToPhone": "<string>",
"shipToEmail": "jsmith@example.com",
"shipToCompanyName": "<string>",
"shipToStreet1": "<string>",
"shipToCity": "<string>",
"shipToState": "<string>",
"shipToPostalCode": "<string>",
"shipToType": "<string>",
"shipToFax": "<string>",
"shipToStreet2": "<string>",
"shipToStreet3": "<string>"
},
"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,
shippingMethod: '<string>',
shipTo: {
shipToCountry: '<string>',
shipToContactName: '<string>',
shipToPhone: '<string>',
shipToEmail: 'jsmith@example.com',
shipToCompanyName: '<string>',
shipToStreet1: '<string>',
shipToCity: '<string>',
shipToState: '<string>',
shipToPostalCode: '<string>',
shipToType: '<string>',
shipToFax: '<string>',
shipToStreet2: '<string>',
shipToStreet3: '<string>'
},
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,
'shippingMethod' => '<string>',
'shipTo' => [
'shipToCountry' => '<string>',
'shipToContactName' => '<string>',
'shipToPhone' => '<string>',
'shipToEmail' => 'jsmith@example.com',
'shipToCompanyName' => '<string>',
'shipToStreet1' => '<string>',
'shipToCity' => '<string>',
'shipToState' => '<string>',
'shipToPostalCode' => '<string>',
'shipToType' => '<string>',
'shipToFax' => '<string>',
'shipToStreet2' => '<string>',
'shipToStreet3' => '<string>'
],
'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 \"shippingMethod\": \"<string>\",\n \"shipTo\": {\n \"shipToCountry\": \"<string>\",\n \"shipToContactName\": \"<string>\",\n \"shipToPhone\": \"<string>\",\n \"shipToEmail\": \"jsmith@example.com\",\n \"shipToCompanyName\": \"<string>\",\n \"shipToStreet1\": \"<string>\",\n \"shipToCity\": \"<string>\",\n \"shipToState\": \"<string>\",\n \"shipToPostalCode\": \"<string>\",\n \"shipToType\": \"<string>\",\n \"shipToFax\": \"<string>\",\n \"shipToStreet2\": \"<string>\",\n \"shipToStreet3\": \"<string>\"\n },\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 \"shippingMethod\": \"<string>\",\n \"shipTo\": {\n \"shipToCountry\": \"<string>\",\n \"shipToContactName\": \"<string>\",\n \"shipToPhone\": \"<string>\",\n \"shipToEmail\": \"jsmith@example.com\",\n \"shipToCompanyName\": \"<string>\",\n \"shipToStreet1\": \"<string>\",\n \"shipToCity\": \"<string>\",\n \"shipToState\": \"<string>\",\n \"shipToPostalCode\": \"<string>\",\n \"shipToType\": \"<string>\",\n \"shipToFax\": \"<string>\",\n \"shipToStreet2\": \"<string>\",\n \"shipToStreet3\": \"<string>\"\n },\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 \"shippingMethod\": \"<string>\",\n \"shipTo\": {\n \"shipToCountry\": \"<string>\",\n \"shipToContactName\": \"<string>\",\n \"shipToPhone\": \"<string>\",\n \"shipToEmail\": \"jsmith@example.com\",\n \"shipToCompanyName\": \"<string>\",\n \"shipToStreet1\": \"<string>\",\n \"shipToCity\": \"<string>\",\n \"shipToState\": \"<string>\",\n \"shipToPostalCode\": \"<string>\",\n \"shipToType\": \"<string>\",\n \"shipToFax\": \"<string>\",\n \"shipToStreet2\": \"<string>\",\n \"shipToStreet3\": \"<string>\"\n },\n \"deliveryInstructions\": \"<string>\",\n \"customFieldMap\": {}\n}"
response = http.request(request)
puts response.read_body{
"consolidateShippingOrderId": "<string>",
"consolidateShippingOrderNumber": "<string>",
"outboundWarehouseId": 123,
"shippingMethod": "<string>",
"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": {},
"createOn": "2023-11-07T05:31:56Z",
"modifyOn": "2023-11-07T05:31:56Z"
}{
"correlationId": "<string>",
"meta": {
"status": 123,
"data": {},
"errorCode": "<string>",
"error": {}
}
}Creates a draft consolidate shipping order — the entry point for shipping multiple return-inventory items together to a single destination. After creation, add inventory via Add inventory to consolidate shipping order, then Confirm consolidate shipping order to dispatch.
Authorizations
Your API key
Your API token — keep this private
Body
application/json
Response
Success
Consolidate shipping order ID (ULID)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I