Skip to main content

StockLocation

StockLocation​

@vendure/corestock-location.entity.ts

A StockLocation represents a physical location where stock is held. For example, a warehouse or a shop.

When the stock of a ProductVariant is adjusted, the adjustment is applied to a specific StockLocation, and the stockOnHand of that ProductVariant is updated accordingly. When there are multiple StockLocations configured, the StockLocationStrategy is used to determine which StockLocation should be used for a given operation.

Signature
class StockLocation extends VendureEntity implements HasCustomFields, ChannelAware {
    constructor(input: DeepPartial<StockLocation>)
    @Column()
    name: string;
    @Column()
    description: string;
    @Column(type => CustomStockLocationFields)
    customFields: CustomStockLocationFields;
    @ManyToMany(type => Channel, channel => channel.stockLocations)
    @JoinTable()
    channels: Channel[];
    @OneToMany(type => StockMovement, movement => movement.stockLocation)
    stockMovements: StockMovement[];
}

constructor​

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

name​

property
string

description​

property
string

customFields​

property
CustomStockLocationFields

channels​

property
Channel[]

stockMovements​

property
StockMovement[]