object OrderWarehouseAllocation

Fields

FieldTypeDescription
order_idString

Public API order ID that identifies the related record.

warehouse_idString

Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.

allocated_atISODateTime

Allocated at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

allocation_referenceString

Allocation reference for this order warehouse allocation.

ready_to_shipBoolean

Whether this warehouse allocation is ready to ship.

line_items[OrderLineItemAllocation]

List of line items associated with this order warehouse allocation.

is_lockedBoolean

Whether this order warehouse allocation is locked.

Referenced By

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
}