object OrderWarehouseAllocation
Fields
| Field | Type | Description |
|---|---|---|
order_id | String | Public API order ID that identifies the related record. |
warehouse_id | String | Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects. |
allocated_at | ISODateTime | Allocated at as an ISO-8601 datetime, returned in UTC unless otherwise noted. |
allocation_reference | String | Allocation reference for this order warehouse allocation. |
ready_to_ship | Boolean | Whether this warehouse allocation is ready to ship. |
line_items | [OrderLineItemAllocation] | List of line items associated with this order warehouse allocation. |
is_locked | Boolean | Whether this order warehouse allocation is locked. |
Referenced By
- MergeableOrder Type
- Order Type
Example
{
"order_id": "T3JkZXI6MTIzNA==",
"warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
"allocated_at": "2026-07-09T15:30:00Z",
"allocation_reference": "ALLOC-100045",
"ready_to_ship": true,
"line_items": [[{sku: "BLUE-TEE-M", quantity: 2}]],
"is_locked": true
}