Skip to main content

StockDisplayStrategy

Defines how the ProductVariant.stockLevel value is obtained. It is usually not desirable to directly expose stock levels over a public API, as this could be considered a leak of sensitive information. However, the storefront will usually want to display some indication of whether a given ProductVariant is in stock.

Info

This is configured via the catalogOptions.stockDisplayStrategy property of your VendureConfig.

Signature

getStockLevel

method(ctx: RequestContext, productVariant: ProductVariant, saleableStockLevel: number) => string | Promise<string>

Returns a string representing the stock level, which will be used directly in the GraphQL ProductVariant.stockLevel field.

Was this chapter helpful?
Report Issue
Edited Feb 10, 2026ยทEdit this page