Skip to main content

StockAllocationStrategy

StockAllocationStrategy​

@vendure/corestock-allocation-strategy.ts

This strategy is responsible for deciding at which stage in the order process stock will be allocated.

info

This is configured via the orderOptions.stockAllocationStrategy property of your VendureConfig.

Signature
interface StockAllocationStrategy extends InjectableStrategy {
    shouldAllocateStock(
        ctx: RequestContext,
        fromState: OrderState,
        toState: OrderState,
        order: Order,
    ): boolean | Promise<boolean>;
}

shouldAllocateStock​

method
(ctx: RequestContext, fromState: OrderState, toState: OrderState, order: Order) => boolean | Promise<boolean>

This method is called whenever an Order transitions from one state to another. If it resolves to true, then stock will be allocated for this order.