Skip to main content

ProductVariant

A ProductVariant represents a single stock keeping unit (SKU) in the store's inventory. Whereas a Product is a "container" of variants, the variant itself holds the data on price, tax category etc. When one adds items to their cart, they are adding ProductVariants, not Products.

Signature

constructor

method(input?: DeepPartial<ProductVariant>) => ProductVariant

deletedAt

propertyDate | null

name

propertyLocaleString

enabled

propertyboolean

sku

propertystring

listPrice

propertynumber

listPriceIncludesTax

propertyboolean

currencyCode

propertyCurrencyCode

price

propertynumber

priceWithTax

propertynumber

taxRateApplied

propertyTaxRate

featuredAsset

propertyAsset

featuredAssetId

propertyID

assets

propertyProductVariantAsset[]

taxCategory

propertyTaxCategory

taxCategoryId

propertyID

productVariantPrices

translations

propertyArray<Translation<ProductVariant>>

product

propertyProduct

productId

propertyID

outOfStockThreshold

propertynumber

Specifies the value of stockOnHand at which the ProductVariant is considered out of stock.

useGlobalOutOfStockThreshold

propertyboolean

When true, the outOfStockThreshold value will be taken from the GlobalSettings and the value set on this ProductVariant will be ignored.

trackInventory

propertyGlobalFlag

stockLevels

propertyStockLevel[]

stockMovements

propertyStockMovement[]

options

propertyProductOption[]

facetValues

propertyFacetValue[]

customFields

propertyCustomProductVariantFields

collections

propertyCollection[]

channels

propertyChannel[]

lines

propertyOrderLine[]
Was this chapter helpful?
Report Issue
Edited Feb 25, 2026ยทEdit this page