← API reference
CANONICAL TYPE REFERENCE

WarehouseStockState

A warehouse stock record tracking inventory at a location

Batch provenance, when this stock belongs to a material lot

Batch identity shared across stock locations and transfers; quantities remain on warehouse stock

The stock record's id, as a TypeID (e.g. "wst_01K…").

Warehouse location holding this stock, as a TypeID (e.g. "wlc_01K…"). A stockable item held in two locations is two records, not one.

The catalog entity this row stocks, moves, reserves or consumes, resolved from the row's stockable type and id. Members of the Stockable union are contributed by the active vertical (PrintVertical contributes SubstrateState); with no vertical loaded the union holds only the platform fallback. Rows the vertical cannot resolve — an unmodelled kind such as ink or tooling, or a partner-supplied id with no local record — surface as a StockableMarker carrying the original type, id, external id and label. Never null.

quantityFloat!

Total quantity on hand at this location, in unit. Never negative. Includes stock that is reserved but not yet issued.

Unit quantity is measured in. Defaults to PC (pieces).

Quantity committed to jobs but not yet issued. Never negative, and never more than quantity — reserved stock is still physically on hand.

Quantity free to reserve or issue: quantity minus reservedQuantity. Derived, not stored.

Supplier or production batch this stock belongs to. Null when the stock is not batch-tracked.

ISO8601 date after which this stock should not be consumed. Null when the item does not expire. Advisory — nothing blocks issuing expired stock.

ISO8601 timestamp of the last physical stock count that set quantity. Null if the record has never been counted, only transacted.

notesString

Free-text operator notes on this stock record.

createdAtString!

ISO8601 timestamp the stock record was created.

updatedAtString!

ISO8601 timestamp the stock record was last modified.

View exact SDL
"""A warehouse stock record tracking inventory at a location"""
type WarehouseStockState {
  """Batch provenance, when this stock belongs to a material lot"""
  materialLot: MaterialLot
  """
  Batch identity shared across stock locations and transfers; quantities remain on warehouse stock
  """
  materialLotId: MaterialLotID
  """The stock record's id, as a TypeID (e.g. "wst_01K…")."""
  id: WarehouseStockID!
  """
  Warehouse location holding this stock, as a TypeID (e.g. "wlc_01K…"). A stockable item held in two locations is two records, not one.
  """
  locationId: WarehouseLocationID!
  """
  The catalog entity this row stocks, moves, reserves or consumes, resolved from the row's stockable type and id. Members of the `Stockable` union are contributed by the active vertical (PrintVertical contributes `SubstrateState`); with no vertical loaded the union holds only the platform fallback. Rows the vertical cannot resolve — an unmodelled kind such as ink or tooling, or a partner-supplied id with no local record — surface as a `StockableMarker` carrying the original type, id, external id and label. Never null.
  """
  stockable: Stockable!
  """
  Total quantity on hand at this location, in `unit`. Never negative. Includes stock that is reserved but not yet issued.
  """
  quantity: Float!
  """Unit `quantity` is measured in. Defaults to PC (pieces)."""
  unit: MeasurementUnit!
  """
  Quantity committed to jobs but not yet issued. Never negative, and never more than `quantity` — reserved stock is still physically on hand.
  """
  reservedQuantity: Float!
  """
  Quantity free to reserve or issue: `quantity` minus `reservedQuantity`. Derived, not stored.
  """
  availableQuantity: Float!
  """
  Supplier or production batch this stock belongs to. Null when the stock is not batch-tracked.
  """
  batchNumber: String
  """
  ISO8601 date after which this stock should not be consumed. Null when the item does not expire. Advisory — nothing blocks issuing expired stock.
  """
  expiryDate: ISO8601
  """
  ISO8601 timestamp of the last physical stock count that set `quantity`. Null if the record has never been counted, only transacted.
  """
  lastCountedAt: ISO8601
  """Free-text operator notes on this stock record."""
  notes: String
  """ISO8601 timestamp the stock record was created."""
  createdAt: String!
  """ISO8601 timestamp the stock record was last modified."""
  updatedAt: String!
}

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