Confirm consolidate shipping order
curl --request POST \
--url https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/confirm \
--header 'Content-Type: application/json' \
--header 'x-rr-apikey: <api-key>' \
--header 'x-rr-apitoken: <api-key>' \
--data '
{
"consolidateShippingOrderId": "<string>"
}
'import requests
url = "https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/confirm"
payload = { "consolidateShippingOrderId": "<string>" }
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({consolidateShippingOrderId: '<string>'})
};
fetch('https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/confirm', 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/confirm",
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([
'consolidateShippingOrderId' => '<string>'
]),
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/confirm"
payload := strings.NewReader("{\n \"consolidateShippingOrderId\": \"<string>\"\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/confirm")
.header("x-rr-apikey", "<api-key>")
.header("x-rr-apitoken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"consolidateShippingOrderId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/confirm")
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 \"consolidateShippingOrderId\": \"<string>\"\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": {}
}
}Order
Confirm consolidate shipping order
POST
/
api
/
outbound
/
consolidateShipping
/
order
/
confirm
Confirm consolidate shipping order
curl --request POST \
--url https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/confirm \
--header 'Content-Type: application/json' \
--header 'x-rr-apikey: <api-key>' \
--header 'x-rr-apitoken: <api-key>' \
--data '
{
"consolidateShippingOrderId": "<string>"
}
'import requests
url = "https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/confirm"
payload = { "consolidateShippingOrderId": "<string>" }
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({consolidateShippingOrderId: '<string>'})
};
fetch('https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/confirm', 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/confirm",
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([
'consolidateShippingOrderId' => '<string>'
]),
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/confirm"
payload := strings.NewReader("{\n \"consolidateShippingOrderId\": \"<string>\"\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/confirm")
.header("x-rr-apikey", "<api-key>")
.header("x-rr-apitoken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"consolidateShippingOrderId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.returnshelper.com/uat/user/api/outbound/consolidateShipping/order/confirm")
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 \"consolidateShippingOrderId\": \"<string>\"\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": {}
}
}Submits a draft order to the warehouse. The order moves from
CREATED to CONFIRMED and its lines can no longer be changed. Call this once you’ve added every line via Add inventory to consolidate shipping order.
CUSTOM_ADDRESS: the warehouse packs the order and quotes the shipping fee. See Confirm consolidate shipping quote.RH_WAREHOUSE: the warehouse packs and ships the order. No further call is needed.
Authorizations
Your API key
Your API token — keep this private
Body
application/json
Consolidate shipping order ID (ULID)
Response
Success