Skip to navigation

ProductInventory

OBJECT
Product Inventory Information

Fields

isInStockBooleanRequired
Indicates whether this product is in stock.
isStockTrackedBooleanRequired

Indicates whether the merchant has enabled inventory tracking for this product. When false, the product is untracked and is treated as always available — isInStock is true, aggregated is null, and consumers should not render out-of-stock or backorder UI based on stock-level fields. When true, stock-level fields on aggregated reflect real merchant inventory.

hasVariantInventoryBooleanRequired

Indicates whether this product’s inventory is being tracked on variant level. If true, you may wish to check the variants node to understand the true inventory of each individual variant, rather than relying on this product-level aggregate to understand how many items may be added to cart.

aggregatedAggregatedInventoryOptional
Aggregated product inventory information. This data may not be available if not set or if the store's Inventory Settings have disabled displaying stock levels on the storefront.
byLocationProductLocationConnectionOptional
Product inventory grouped by location.

Referenced by