Skip to main content

ProductVariantPriceCalculationStrategy

ProductVariantPriceCalculationStrategy​

@vendure/coreproduct-variant-price-calculation-strategy.ts

Defines how ProductVariant are calculated based on the input price, tax zone and current request context.

info

This is configured via the catalogOptions.productVariantPriceCalculationStrategy property of your VendureConfig.

Signature
interface ProductVariantPriceCalculationStrategy extends InjectableStrategy {
    calculate(args: ProductVariantPriceCalculationArgs): Promise<PriceCalculationResult>;
}

calculate​

method
(args: ProductVariantPriceCalculationArgs) => Promise<PriceCalculationResult>

ProductVariantPriceCalculationArgs​

@vendure/coreproduct-variant-price-calculation-strategy.ts

The arguments passed the calculate method of the configured ProductVariantPriceCalculationStrategy.

The productVariant argument was added in v2.1.0.

Signature
interface ProductVariantPriceCalculationArgs {
    inputPrice: number;
    productVariant: ProductVariant;
    taxCategory: TaxCategory;
    activeTaxZone: Zone;
    ctx: RequestContext;
}

inputPrice​

property
number

productVariant​

property
ProductVariant

taxCategory​

property
TaxCategory

activeTaxZone​

property
Zone

ctx​

property
RequestContext