Skip to main content
POST
Update ship-to information of consolidate shipping order
Updates the destination address, contact, and phone on a CUSTOM_ADDRESS order. Only works before the order is confirmed. RH_WAREHOUSE orders are rejected with a meta.error message that starts Updating the ship-to address applies to a custom address destination only.

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
consolidateShippingOrderId
string
required

Consolidate shipping order ID (ULID)

shipTo
object
required

Response

Success

consolidateShippingOrderId
string

ULID

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