Skip to main content
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": {}
}
'
{
  "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"
}
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

x-rr-apikey
string
header
required

Your API key

x-rr-apitoken
string
header
required

Your API token — keep this private

Body

application/json
outboundWarehouseId
integer
required
shippingMethod
string
required
shipTo
object
required
deliveryInstructions
string
customFieldMap
object

Response

Success

consolidateShippingOrderId
string

Consolidate shipping order ID (ULID)

consolidateShippingOrderNumber
string
outboundWarehouseId
integer<int32>
shippingMethod
string
shippingFee
number<decimal>
deliveryInstructions
string | null
consolidateShippingOrderStatus
string
shipTo
object
customFieldMap
object
createOn
string<date-time>
modifyOn
string<date-time>