Skip to main content
POST
Create consolidate shipping order
Creates a draft consolidate shipping order. An order ships return inventory and FBA inventory from one outbound warehouse to one destination. To find a destination warehouse, call Get all warehouses and pick one whose isConsolidateShippingDestination is true. The Hong Kong warehouse is currently the only RH_WAREHOUSE destination.

Destination rules

If you leave out destinationType, the order is a CUSTOM_ADDRESS order. customFieldMap keys may contain only uppercase letters, digits, hyphen and underscore. For every step after creation, see Consolidate Shipping flow.

Validation failures

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
destinationType
enum<string>
default:CUSTOM_ADDRESS

Where the order ships to. Defaults to CUSTOM_ADDRESS.

Available options:
CUSTOM_ADDRESS,
RH_WAREHOUSE
destinationWarehouseId
integer

Destination warehouse. Required when destinationType is RH_WAREHOUSE; must be a warehouse whose isConsolidateShippingDestination is true. Ignored for CUSTOM_ADDRESS.

packagingType
enum<string>

CUSTOM_ADDRESS orders only. Ignored for RH_WAREHOUSE.

Available options:
BOX,
PALLET
deliveryInstructions
string
shipTo
object

Ship-to address. Required when destinationType is CUSTOM_ADDRESS; ignored for RH_WAREHOUSE.

customFieldMap
object

Your own key-value pairs. Keys may contain only uppercase letters, digits, hyphen and underscore.

Response

Success

consolidateShippingOrderId
string

Consolidate shipping order ID (ULID)

consolidateShippingOrderNumber
string
outboundWarehouseId
integer<int32>
shippingFee
number<decimal>
deliveryInstructions
string | null
consolidateShippingOrderStatus
string
shipTo
object
customFieldMap
object | null