Integrations
/
Salesforce Commerce Cloud B2C
Dec. 19, 2023
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? |
|---|---|---|---|
| EnableĀ Algolia | Algolia_Enable | Enable all Algolia features on your Salesforce B2C Commerce storefront. | Yes |
| ApplicationĀ ID | Algolia_ApplicationID | This is your unique Algolia application 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 which can be safely used 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 |
| **Enable Insights Events | Algolia_EnableInsights | When enabled, 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 page results (first page only). Improves SEO, but slightly increases page load times. Only applicable for the SFRA cartridges. | No (default: false) |
Consider using restricted API keys for security reasons. For more information, see API key restrictions.
Did you find this page helpful?
