*** title: "StockLocationStrategy" generated: true --------------- ## StockLocationStrategy The StockLocationStrategy is responsible for determining which [StockLocation](/current/core/reference/typescript-api/entities/stock-location#stocklocation)s should be used to fulfill an [OrderLine](/current/core/reference/typescript-api/entities/order-line#orderline) and how much stock should be allocated from each location. It is also used to determine the available stock for a given [ProductVariant](/current/core/reference/typescript-api/entities/product-variant#productvariant). :::info This is configured via the `catalogOptions.stockLocationStrategy` property of your VendureConfig. ::: ```ts title="Signature" interface StockLocationStrategy extends InjectableStrategy { getAvailableStock( ctx: RequestContext, productVariantId: ID, stockLevels: StockLevel[], ): AvailableStock | Promise; forAllocation( ctx: RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number, ): LocationWithQuantity[] | Promise; forRelease( ctx: RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number, ): LocationWithQuantity[] | Promise; forSale( ctx: RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number, ): LocationWithQuantity[] | Promise; forCancellation( ctx: RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number, ): LocationWithQuantity[] | Promise; } ``` * Extends: [`InjectableStrategy`](/current/core/reference/typescript-api/common/injectable-strategy#injectablestrategy)

### getAvailableStock \RequestContext, productVariantId: ID, stockLevels: StockLevel[]) => AvailableStock | Promise<AvailableStock>`} /> Returns the available stock for the given ProductVariant, taking into account the stock levels at each StockLocation. ### forAllocation \RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number) => LocationWithQuantity[] | Promise<LocationWithQuantity[]>`} /> Determines which StockLocations should be used to when allocating stock when and Order is placed. ### forRelease \RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number) => LocationWithQuantity[] | Promise<LocationWithQuantity[]>`} /> Determines which StockLocations should be used to when releasing allocated stock when an OrderLine is cancelled before being fulfilled. ### forSale \RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number) => LocationWithQuantity[] | Promise<LocationWithQuantity[]>`} /> Determines which StockLocations should be used to when creating a Sale and reducing the stockOnHand upon fulfillment. ### forCancellation \RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number) => LocationWithQuantity[] | Promise<LocationWithQuantity[]>`} /> Determines which StockLocations should be used to when creating a Cancellation of an OrderLine which has already been fulfilled.

## AvailableStock The overall available stock for a ProductVariant as determined by the logic of the [StockLocationStrategy](/current/core/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy)'s `getAvailableStock` method. ```ts title="Signature" interface AvailableStock { stockOnHand: number; stockAllocated: number; } ```

### stockOnHand \ ### stockAllocated \

## LocationWithQuantity Returned by the `StockLocationStrategy` methods to indicate how much stock from each location should be used in the allocation/sale/release/cancellation of an OrderLine. ```ts title="Signature" interface LocationWithQuantity { location: StockLocation; quantity: number; } ```

### location \StockLocation`} /> ### quantity \