CatalogOptions
CatalogOptions
Options related to products and collections.
Signature
interface CatalogOptions {
collectionFilters?: Array<CollectionFilter<any>>;
productVariantPriceSelectionStrategy?: ProductVariantPriceSelectionStrategy;
productVariantPriceCalculationStrategy?: ProductVariantPriceCalculationStrategy;
stockDisplayStrategy?: StockDisplayStrategy;
stockLocationStrategy?: StockLocationStrategy;
}
Members
collectionFilters
Allows custom CollectionFilters to be defined.
productVariantPriceSelectionStrategy
property
v2.0.0
Defines the strategy used to select the price of a ProductVariant, based on factors
such as the active Channel and active CurrencyCode.
productVariantPriceCalculationStrategy
Defines the strategy used for calculating the price of ProductVariants based
on the Channel settings and active tax Zone.
stockDisplayStrategy
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
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.