← API reference
CANONICAL TYPE REFERENCE

WarehouseLocationState

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

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

TypeID ("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.

nameString!

Human-readable name of the location. Never empty.

codeString

Short 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.

Kind of location, which fixes its role in the storage hierarchy.

Free-text notes about the location; null when none were supplied.

Weight 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.

Volume 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.

isActiveBoolean!

Whether the location is currently in use. Inactive locations are retained for history but should not be offered for new putaway or transfers.

Manual ordering hint for displaying sibling locations; lower values come first. Defaults to 0.

createdAtString!

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

updatedAtString!

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

View exact SDL
"""A warehouse location (warehouse, zone, aisle, rack, shelf, bin, etc.)"""
type WarehouseLocationState @iac_resource(name: "warehouse_location") @iac_ops(create: "createWarehouseLocation", read: "getWarehouseLocation", update: "updateWarehouseLocation", delete: "deleteWarehouseLocation") {
  """TypeID of this warehouse location (prefix "wlc", e.g. "wlc_01K…")."""
  id: WarehouseLocationID! @iac_identity(assignedBy: SERVER) @iac_computed
  """
  TypeID ("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.
  """
  parentId: WarehouseLocationID @iac_ref(resource: "warehouse_location")
  """Human-readable name of the location. Never empty."""
  name: String!
  """
  Short 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.
  """
  code: String
  """Kind of location, which fixes its role in the storage hierarchy."""
  locationType: WarehouseLocationType!
  """Free-text notes about the location; null when none were supplied."""
  description: String
  """
  Weight 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.
  """
  maxWeight: Float
  """
  Volume 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.
  """
  maxVolume: Float
  """
  Whether the location is currently in use. Inactive locations are retained for history but should not be offered for new putaway or transfers.
  """
  isActive: Boolean!
  """
  Manual ordering hint for displaying sibling locations; lower values come first. Defaults to 0.
  """
  sortOrder: Int!
  """ISO-8601 timestamp of when the location record was created."""
  createdAt: String! @iac_computed
  """
  ISO-8601 timestamp of the last change to the location record; equal to createdAt until it is first updated.
  """
  updatedAt: String! @iac_computed
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.