CatalogOptions

CatalogOptions

CatalogOptions

Options related to products and collections.

Signature

interface CatalogOptions {
  collectionFilters: Array<CollectionFilter<any>>;
  productVariantPriceCalculationStrategy: ProductVariantPriceCalculationStrategy;
  stockDisplayStrategy: StockDisplayStrategy;
}

Members

collectionFilters

property
type:
Array<CollectionFilter<any>>
default:
defaultCollectionFilters
Allows custom CollectionFilters to be defined.

productVariantPriceCalculationStrategy

property
default:
DefaultTaxCalculationStrategy
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.