Entities

Stock Level

Per-variant inventory at a stock location

A StockLevel is the inventory record for one product variant at one stock location. It is the normalized per-location breakdown; the location-independent availability shown on product pages remains on ProductVariantAvailability.

Available since v0.26.0 in @laioutr-core/canonical-types

Components

Base

StockLevelBase

base

On-hand, allocated, available, and incoming quantities, restock date, availability status, and custom fields.

Schema

status

"inStock" | "outOfStock" | "backorder" | "preorder"

onHand

numberrequired

Physical quantity on hand at the location (Vendure stockOnHand).

allocated

number

Quantity reserved/committed to orders (Vendure stockAllocated).

available

number

Sellable quantity (onHand − allocated), when the source resolves it.

incoming

number

Inbound/on-order quantity expected to arrive.

restockDate

string

formatdate

customFields

Record<string, unknown>

Custom fields are a way for implementations to pass arbitrary data to actions, queries, etc.

Edit this pageorReport an issue

Stock Location

Warehouse, distribution center, or fulfillment location