Skip to main content

StockLevel

StockLevel​

@vendure/corestock-level.entity.ts

A StockLevel represents the number of a particular ProductVariant which are available at a particular StockLocation.

Signature
class StockLevel extends VendureEntity implements HasCustomFields {
    constructor(input: DeepPartial<StockLevel>)
    @Index()
    @ManyToOne(type => ProductVariant, productVariant => productVariant.stockLevels, { onDelete: 'CASCADE' })
    productVariant: ProductVariant;
    @EntityId()
    productVariantId: ID;
    @Index()
    @ManyToOne(type => StockLocation, { onDelete: 'CASCADE' })
    stockLocation: StockLocation;
    @EntityId()
    stockLocationId: ID;
    @Column()
    stockOnHand: number;
    @Column()
    stockAllocated: number;
    @Column(type => CustomStockLevelFields)
    customFields: CustomStockLevelFields;
}

constructor​

method
(input: DeepPartial<StockLevel>) => StockLevel

productVariant​

property
ProductVariant

productVariantId​

property
ID

stockLocation​

property
StockLocation

stockLocationId​

property
ID

stockOnHand​

property
number

stockAllocated​

property
number

customFields​

property
CustomStockLevelFields