Skip to content

WarehouseLocationState ​

Type: Object

A warehouse location (warehouse, zone, aisle, rack, shelf, bin, etc.)

Fields ​

NameTypeArgsDescriptionDeprecated
codeStringShort operator-facing code for the location (e.g. a barcode/label such as "A-01-03"). Unique per tenant when set; null when the location has no code.
createdAtString!ISO-8601 timestamp of when the location record was created.
descriptionStringFree-text notes about the location; null when none were supplied.
idWarehouseLocationID!TypeID of this warehouse location (prefix "wlc", e.g. "wlc_01K…").
isActiveBoolean!Whether the location is currently in use. Inactive locations are retained for history but should not be offered for new putaway or transfers.
locationTypeWarehouseLocationType!Kind of location, which fixes its role in the storage hierarchy.
maxVolumeFloatVolume capacity of the location, in the tenant's configured volume unit. Null means no volume limit is recorded. Advisory: it is not enforced when stock is placed here.
maxWeightFloatWeight capacity of the location, in the tenant's configured weight unit. Null means no weight limit is recorded. Advisory: it is not enforced when stock is placed here.
nameString!Human-readable name of the location. Never empty.
parentIdWarehouseLocationIDTypeID ("wlc") of the enclosing location, forming the storage hierarchy (e.g. a bin's parent shelf). Null for a top-level location such as a whole warehouse. A location can never be its own parent.
sortOrderInt!Manual ordering hint for displaying sibling locations; lower values come first. Defaults to 0.
updatedAtString!ISO-8601 timestamp of the last change to the location record; equal to createdAt until it is first updated.

Connect machines, automate workflows, and build custom apps for print production.