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.
-
Extends:
VendureEntity -
Implements:
Translatable, HasCustomFields,SoftDeletable,ChannelAware
constructor
method
(input?: DeepPartial<ProductVariant>) => ProductVariantdeletedAt
property
Date | nullname
property
LocaleStringenabled
property
booleansku
property
stringlistPrice
property
numberlistPriceIncludesTax
property
booleancurrencyCode
property
CurrencyCodeprice
property
numberpriceWithTax
property
numbertaxRateApplied
property
TaxRatefeaturedAsset
property
AssetfeaturedAssetId
property
IDassets
property
ProductVariantAsset[]taxCategory
property
TaxCategorytaxCategoryId
property
IDproductVariantPrices
property
ProductVariantPrice[]translations
property
Array<Translation<ProductVariant>>product
property
ProductproductId
property
IDoutOfStockThreshold
property
numberSpecifies the value of stockOnHand at which the ProductVariant is considered out of stock.
useGlobalOutOfStockThreshold
property
booleanWhen true, the outOfStockThreshold value will be taken from the GlobalSettings and the
value set on this ProductVariant will be ignored.
trackInventory
property
GlobalFlagstockLevels
property
StockLevel[]stockMovements
property
StockMovement[]options
property
ProductOption[]facetValues
property
FacetValue[]customFields
property
CustomProductVariantFieldscollections
property
Collection[]channels
property
Channel[]lines
property
OrderLine[]Was this chapter helpful?