Skip to main content

CatalogOptions

CatalogOptions​

@vendure/corevendure-config.ts

Options related to products and collections.

Signature
interface CatalogOptions {
    collectionFilters?: Array<CollectionFilter<any>>;
    productVariantPriceSelectionStrategy?: ProductVariantPriceSelectionStrategy;
    productVariantPriceCalculationStrategy?: ProductVariantPriceCalculationStrategy;
    productVariantPriceUpdateStrategy?: ProductVariantPriceUpdateStrategy;
    stockDisplayStrategy?: StockDisplayStrategy;
    stockLocationStrategy?: StockLocationStrategy;
}

collectionFilters​

property
Array<CollectionFilter<any>>
default:
defaultCollectionFilters

Allows custom CollectionFilters to be defined.

productVariantPriceSelectionStrategy​

property
v2.0.0
ProductVariantPriceSelectionStrategy
default:
<a href='/reference/typescript-api/configuration/product-variant-price-selection-strategy#defaultproductvariantpriceselectionstrategy'>DefaultProductVariantPriceSelectionStrategy</a>

Defines the strategy used to select the price of a ProductVariant, based on factors such as the active Channel and active CurrencyCode.

productVariantPriceCalculationStrategy​

property
ProductVariantPriceCalculationStrategy
default:
DefaultTaxCalculationStrategy

Defines the strategy used for calculating the price of ProductVariants based on the Channel settings and active tax Zone.

productVariantPriceUpdateStrategy​

property
v2.2.0
ProductVariantPriceUpdateStrategy
default:
<a href='/reference/typescript-api/configuration/product-variant-price-update-strategy#defaultproductvariantpriceupdatestrategy'>DefaultProductVariantPriceUpdateStrategy</a>

Defines the strategy which determines what happens to a ProductVariant's prices when one of the prices gets updated. For instance, this can be used to synchronize prices across multiple Channels.

stockDisplayStrategy​

property
StockDisplayStrategy
default:
<a href='/reference/typescript-api/products-stock/default-stock-display-strategy#defaultstockdisplaystrategy'>DefaultStockDisplayStrategy</a>

Defines how the ProductVariant.stockLevel value is obtained. It is usually not desirable to directly expose stock levels over a public API, as this could be considered a leak of sensitive information. However, the storefront will usually want to display some indication of whether a given ProductVariant is in stock. The default StockDisplayStrategy will display "IN_STOCK", "OUT_OF_STOCK" or "LOW_STOCK" rather than exposing the actual saleable stock level.

stockLocationStrategy​

property
v2.0.0
StockLocationStrategy
default:
<a href='/reference/typescript-api/products-stock/default-stock-location-strategy#defaultstocklocationstrategy'>DefaultStockLocationStrategy</a>

Defines the strategy used to determine which StockLocation should be used when performing stock operations such as allocating and releasing stock as well as determining the amount of stock available for sale.