← All resources

Resource

warehouse_location

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

GraphQL reference →

Configuration

parentIdWarehouseLocationIDOptional

TypeID ("wlc") of the enclosing location. Omit for a top-level location.

References warehouse_location

nameString!Required

Human-readable name of the location. Required and must not be blank.

codeStringOptional

Short operator-facing code (barcode/label). Must be unique per tenant when set.

locationTypeWarehouseLocationType!Optional

Kind of location. Defaults to WAREHOUSE when omitted.

Allowed values

WAREHOUSE — The top of the storage hierarchy: a whole site or building, normally parentless, with every other location hanging beneath it. Also the type a location takes when none is supplied.

ZONE — A named area inside a warehouse — the first subdivision below the site, and the usual parent of aisles.

AISLE — A gangway running between racking within a zone; groups the racks along it, and sits one level above RACK.

RACK — A single racking bay or shelving unit standing in an aisle; the parent of the individual shelves it is divided into.

SHELF — One horizontal level within a rack — the smallest location that still holds several bins.

BIN — The finest-grained location: a single pick face, box or tote on a shelf. The leaf of the storage hierarchy, with nothing nested below it.

STAGING — A holding area outside the rack hierarchy where stock waits between operations — marshalled for a job, or landed but not yet put away.

GOODS_IN — The receiving dock. Inbound deliveries are booked in here (a RECEIVED movement) before being transferred into the rack hierarchy.

GOODS_OUT — The dispatch area. Picked stock is moved here to wait for the carrier, and leaves the site from here (a SHIPPED movement).

QUARANTINE — A segregated area holding stock that must not be issued — awaiting inspection, or failed. Kept off the normal hierarchy so it is not picked by accident.

PRODUCTION — Point-of-use storage on the shop floor rather than in the warehouse; material issued to a job lands here (an ISSUED_TO_PRODUCTION movement).

descriptionStringOptional

Free-text notes about the location.

maxWeightFloatOptional

Advisory weight capacity, in the tenant's weight unit. Omit for no limit.

maxVolumeFloatOptional

Advisory volume capacity, in the tenant's volume unit. Omit for no limit.

isActiveBoolean!Optional

Whether the location is available for use. Defaults to true when omitted.

sortOrderInt!Optional

Display-ordering hint among sibling locations. Defaults to 0 when omitted.

Read-only values

Show values
idWarehouseLocationID!Read only

TypeID of this warehouse location (prefix "wlc", e.g. "wlc_01K…").

computed by the platform

createdAtString!Read only

ISO-8601 timestamp of when the location record was created.

computed by the platform

updatedAtString!Read only

ISO-8601 timestamp of the last change to the location record; equal to createdAt until it is first updated.

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.