Skip to main content
POST
Create consolidate shipping order
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 | null
createOn
string<date-time>
modifyOn
string<date-time>