Integrations
/
Salesforce Commerce Cloud B2C
Nov 25, 2024
Custom preferences
You can configure these preferences in the Algolia BM module (Business Manager > Merchant Tools > Algolia > Algolia).
| Preference | SFCC Site Preference Name | Description | Required? |
|---|---|---|---|
| Application ID | Algolia_ApplicationID | This is your unique Algolia app identifier. Find it in the API Keys tab of the Algolia dashboard. | Yes |
| Search API key | Algolia_SearchApiKey | This is your Algolia public API key to use in your frontend code. Find it in the API Keys tab of the Algolia dashboard. | Yes (optional for headless) |
| Admin API key | Algolia_AdminApiKey | This is your Algolia admin 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. | Required |
| InStock Threshold | Algolia_InStockThreshold | If the stock of a product is lower than this value, it’s considered to be out of stock. | No (default: 0) |
| Additional Product Attributes | Algolia_AdditionalAttributes | Any additional product attributes to send to Algolia (comma-separated list). | No |
| Index Prefix | Algolia_IndexPrefix | If set, it replaces the first two segments of the index name. The default index names are: <hostname>__<siteID>__producs__<locale> and <hostname>__<siteID>__categories__<locale>. |
No |
| Record model | Algolia_RecordModel | Define the shape of the records generated by the cartridge. For more information, see Default records. | No (default: Variation Product) |
| Locales for indexing | Algolia_LocalesForIndexing | Specify which locales to index in a comma-separated list, for all job types. Locales are case-sensitive. | No (default: all locales assigned to your site) |
| Enable Algolia frontend cartridge | Algolia_Enable | Enable the SFRA or SiteGenesis cartridge on the Salesforce B2C Commerce storefront. | No |
| Enable Insights Events | Algolia_EnableInsights | If true, the Storefront sends Insights events to Algolia: views, clicks, addToCart, and purchase |
No (default: false) |
| Enable server-side rendering | Algolia_EnableSSR | Enables server-side rendering of the category landing pages and search results for public search engines. Improves SEO. Only applies to SFRA cartridges | No (default: false) |
| Enable Content Search | Algolia_EnableContentSearch | Enable Algolia Content Search on the SFRA storefront cartridge. | No (default: false) |
| Enable Recommendations | Algolia_EnableRecommendations | Enable Algolia Recommend on the SFRA storefront cartridge. See the documentation for additional setup steps. | No (default: false) |
| Enable Pricing Lazy Loading | Algolia_EnablePricingLazyLoading | Enable lazy loading of pricing and promotions data from SFCC. | No (default: false) |
Consider using restricted API keys for security reasons. For more information, see API key restrictions.
Did you find this page helpful?
