Plugin
The Clerk.io plugin for Shopware 6 is configured entirely from within the Shopware Admin. Each section controls a different feature on your storefront.
To open the plugin settings, go to Extensions > My extensions, find the Clerk.io plugin, and click ... > Config..
All settings on this page reference Content fields. These fields accept the name of a Clerk.io
Element (e.g. product-page-alternatives). The name must match exactly what is configured in my.clerk.io under the relevant section.General #
| Setting | Description |
|---|---|
| Status | Enable or disable the Clerk.io plugin on this Sales Channel. |
| Public Key | Your Clerk.io Public API key, found in my.clerk.io > Developers > API Keys. |
| Private Key | Your Clerk.io Private API key, found in the same location. |
| Collect Emails | When enabled, Clerk.js automatically captures email addresses entered on the storefront and logs them for personalisation and email triggers. Defaults to true. |
Multi-Language Keys #
Use this section when you have multiple languages on the same Sales Channel and each language needs its own Clerk.io Store and Public Key.
| Setting | Description |
|---|---|
| Languages | Select the languages you want to override the default Public Key for. |
| Public Keys | Provide one Public Key per line, in the same order as the selected languages above. |
For a full multi-language setup, see Multiple languages.
Instant Search #
Controls the live search dropdown that appears as visitors type in the search field.
| Setting | Description |
|---|---|
| Status | Enable or disable Instant Search. |
| Position | Where to inject the Instant Search dropdown. Options: HeaderSearchBlock, MetaBlock, Footer, FooterMinimal, Navbar. Defaults to HeaderSearchBlock. |
| Number of Suggestions | Number of product suggestions to show. 0–10, defaults to 5. |
| Number of Categories | Number of category results to show. 0–10, defaults to 5. |
| Number of Pages | Number of content page results to show. 0–10, defaults to 5. |
| Page Types | Filter which page types are included in results. Defaults to all. |
| Dropdown Positioning | Where the dropdown appears relative to the search input: left, center, right, below, or off. Defaults to left. |
| Content | The Clerk.io Element name to use for rendering. Defaults to live-search. |
| Input Selector | Custom CSS selector for the search input field. Leave empty to use the default Shopware search input. |
| Form Selector | Custom CSS selector for the search form. Leave empty to use the default. |
Search Page #
Controls the full-page search results experience.
| Setting | Description |
|---|---|
| Status | Enable or disable the Search Page. |
| Include Categories | Show matching categories alongside product results. |
| Number of Categories | Number of category results to include. 0–10, defaults to 5. |
| Number of Pages | Number of content page results to include. 0–10, defaults to 5. |
| Page Types | Filter which page types are included. Defaults to all. |
| Content | The Clerk.io Element name to use. Defaults to search-page. |
Faceted Search #
Controls filter panels on the search page, allowing visitors to narrow results by product attributes.
| Setting | Description |
|---|---|
| Status | Enable or disable faceted filtering on the search page. |
| Attributes | Comma-separated list of product attributes to use as facets. Example: price,categories,brand. |
| Facet Titles | Display labels for each facet attribute, in the format attribute:Label. Example: price:Price,categories:Categories,brand:Brand. |
| Multi Select Attributes | Comma-separated list of attributes that allow multiple values to be selected simultaneously. Example: categories,brand. |
| Design | The Clerk.io Design ID to use for rendering the facet panel. |
Product Page #
Controls recommendations shown on individual product pages.
| Setting | Description |
|---|---|
| Status | Enable or disable product page recommendations. |
| Hook Location | Where to inject the recommendations: Cross Selling Block (inside the Shopware cross-sell tab) or After Description. Defaults to Cross Selling Block. |
| Content | Comma-separated list of Clerk.io Element names to display. Defaults to product-page-alternatives, product-page-others-also-bought. |
| Filter Duplicates | When enabled, the same product will not appear in more than one recommendation slider on the page. |
Category Page #
Controls recommendations shown on category listing pages.
| Setting | Description |
|---|---|
| Status | Enable or disable category page recommendations. |
| Content | Comma-separated list of Clerk.io Element names to display. Defaults to category-page-popular. |
| Filter Duplicates | Prevent the same product from appearing in multiple sliders on the page. |
Cart Page #
Controls recommendations shown on the cart page.
| Setting | Description |
|---|---|
| Status | Enable or disable cart page recommendations. |
| Content | Comma-separated list of Clerk.io Element names to display. Defaults to cart-others-also-bought. |
| Filter Duplicates | Prevent the same product from appearing in multiple sliders on the page. |
Exit Intent #
Controls a recommendations overlay that appears when a visitor moves their cursor toward closing or leaving the page.
| Setting | Description |
|---|---|
| Status | Enable or disable Exit Intent recommendations. |
| Content | The Clerk.io Element name to display. Defaults to exit-intent. |
Powerstep #
Controls the step shown immediately after a visitor adds a product to their cart, designed to encourage additional purchases.
| Setting | Description |
|---|---|
| Status | Enable or disable the Powerstep. |
| Type | How the Powerstep is displayed: Page (full interstitial page), Popup, or Side Cart. Defaults to Popup. |
| Content | Comma-separated list of Clerk.io Element names to display. Defaults to power-step-others-also-bought, power-step-visitor-complementary, power-step-popular, power-step-popular-on-sale. |
| Filter Duplicates | Prevent the same product from appearing in multiple sliders in the Powerstep. |
Uninstalling #
To disable the plugin, open the plugin config, set Status to Disabled, and save.
To remove the plugin entirely, go to Extensions > My extensions, find the Clerk.io plugin, and click ... > Uninstall.