Custom preferences

You can configure these preferences in the Algolia BM module (Business Manager > Merchant Tools > Algolia > Algolia).

Application ID

Algolia_ApplicationID (required)This is your unique Algolia application identifier. Find it in the Algolia dashboard.

Search API key

Algolia_SearchApiKey (required, optional for headless)This is your Algolia public API key to use in your frontend code. Find it in the Algolia dashboard.

Write API key

Algolia_AdminApiKey (required)This is your Algolia write API key. Keep this key secret, and only use it in the backend. Algolia uses this key to create, update, and delete your records and indices.

Consider using restricted API keys for increased security. For more information, see API key restrictions.

In-Stock Threshold

Algolia_InStockThreshold (optional, default value: 1)A product is considered in stock when the available quantity is greater than or equal to this threshold.

Index out of stock products

Algolia_IndexOutOfStock (default value: false)Index out of stock products. When this setting is off, only in-stock products whose available-to-sell (ATS) quantity meets or exceeds Algolia_InStockThreshold are indexed.

Enable Real Time Inventory

Algolia_EnableRealTimeInventory (default value: false)If enabled, the cartridge sends inventory updates to Algolia after each order if a product is out of stock.

Additional Product Attributes

Algolia_AdditionalAttributes (optional)Any additional product attributes to send to Algolia (comma-separated list).

Index Prefix

Algolia_IndexPrefix (optional)If set, it replaces the first two segments of the index name. The default names are: <hostname>__<siteID>__producs__<locale> and <hostname>__<siteID>__categories__<locale>.

Record model

Algolia_RecordModel (default value: Variation product)Define the shape of the records generated by the cartridge. For more information, see Default records.

Grouping attribute for the Attribute-sliced record model

Algolia_AttributeSlicedRecordModel_GroupingAttribute (required only if Attribute-sliced is selected as the record model)Choose the variation attribute that base products with multiple variation attributes are grouped by when using the Attribute-sliced record model, for example color.

Locales for indexing

Algolia_LocalesForIndexing (optional - leaving this empty indexes all locales assigned to your site)Specify which locales to index in a comma-separated list, for all job types. Locales are case-sensitive.

Enable Algolia frontend cartridge

Algolia_Enable (default value: true)Enable the SFRA or SiteGenesis cartridge on the Salesforce B2C Commerce storefront.

Enable Insights Events

Algolia_EnableInsights (default value: false)If true, the Storefront sends Insights API events to Algolia:, including views, clicks, add-to-cart actions, and purchases.

Enable server-side rendering

Algolia_EnableSSR (default value: false)Enables server-side rendering for category landing pages and search results to improve SEO for public search engines. Applies only to SFRA cartridges.

Enable Content Search

Algolia_EnableContentSearch (default value: false)Enable Algolia Content Search on the SFRA storefront cartridge.

Enable Recommendations

Algolia_EnableRecommendations (default value: false)Enable Algolia Recommend on the SFRA storefront cartridge.

Enable Pricing Lazy Loading

Algolia_EnablePricingLazyLoading (default value: false)Enable lazy loading of pricing and promotions data from SFCC.