Skip to main content
GET
Get consolidate shipping order
Returns one consolidate shipping order with its lines and shipments. On RH_WAREHOUSE orders, shipTo is the destination warehouse’s address and packagingType is null. shippingFee is the sum of the shipments’ fees. Returns meta.status: 404 when the order does not exist or does not belong to your account. To track changes, use the consolidate shipping webhooks rather than calling this endpoint repeatedly.

Authorizations

x-rr-apikey
string
header
required

Your API key

x-rr-apitoken
string
header
required

Your API token — keep this private

Query Parameters

consolidateShippingOrderId
string
required

Consolidate shipping order ID (ULID)

Response

Success

consolidateShippingOrderId
string

ULID

consolidateShippingOrderNumber
string
outboundWarehouseId
integer<int32>
destinationType
enum<string>
Available options:
CUSTOM_ADDRESS,
RH_WAREHOUSE
destinationWarehouseId
integer<int32> | null

RH_WAREHOUSE orders only

packagingType
enum<string> | null

null on RH_WAREHOUSE orders and on CUSTOM_ADDRESS orders created without one.

Available options:
BOX,
PALLET,
null
shippingFee
number<decimal>

Sum of the shipments' shipping fees

deliveryInstructions
string | null
consolidateShippingOrderStatus
string
shipTo
object

On RH_WAREHOUSE orders, the destination warehouse's address

customFieldMap
object | null
pendingInventoryList
object[]

Lines not yet packed

inProgressInventoryList
object[]

Lines partly packed. quantity is the pieces still to pack

shipmentList
object[]