Shopware 6

Get Started

Connecting your Store #

The first step of installing Clerk.io, is connecting your store with your Clerk.io account.

The video belows shows you what to do, step-by-step. Use the rest of the guide as a reference :)

After following these simple steps you will be able to see your Live Demo Store, which gives you a personal overview of how Clerk.io will work on your webshop. Reach out to your Clerk.io contact person to see the Live Demo.

1. Add Store #

  1. Login to my.clerk.io. The first time you do this, you will see the Add New Store page.

  2. Write the Name and Domain of your webshop

  3. Choose Shopware 6 as the Platform and choose your Currency.

  4. Click Add Store.

2. Install and configure the plugin #

For Shopware v6.4 and later:

  1. In your Shopware Admin, go to Extensions > Store and search for “Clerk”.
  2. Click Add extension to install.

For Shopware v6.3 and earlier:

  1. Download the plugin: Releases for v6.3 and earlier.
  2. In your Shopware Admin, go to Settings > System > Plugins.
  3. Click Upload plugin, choose the downloaded file, then ... > Install and activate.

Configure the plugin:

  1. Click ... > Config. on the Clerk plugin.
  2. Select the correct Sales Channel.
  3. Under General, set Status to Enabled.
  4. Enter your Public Key and Private Key, then click Save.

Keys location: Your Public Key and Private Key are in my.clerk.io > Developers > API Keys.

3. Sync Your Data #

  1. In Shopware, go to Settings > System > Integrations.
  2. Click Add integration and name it “Clerk.io”.
  3. Copy the Access Key ID and Secret Access Key.
  4. Go to my.clerk.io > Data > Configuration and paste these keys along with your Store URL.
  5. If you have multiple languages, identify Language IDs per Shopware docs and sync each store.
  6. Click Start Sync and wait for the sync to complete.

Full Installation Example #

In this video you can get a complete overview of what it takes to set up Clerk.io on a Shopware 6 webshop.

Multiple languages #

Shopware uses Language IDs to identify each unique language in the webshop. These are not visible in the Shopware backend, so they have to be found through the frontend HTML.

Check this video to see how to identify the language IDs.

The best way to handle multi-language in Clerk is to create unique Stores for each language and sync it with the correct Language ID.

This way, you can separate products, sales, currencies etc. to keep track of each language.

  1. Start by creating your main Store and follow the Setup Guide to connect your Store to Clerk.io,and choose the Recommendations and/or Search Results you that you want to display on your webshop.

  2. When you are done with the initial setup, go back to the start page of my.clerk.io (by clicking the Clerk.io logo in the upper left side corner of the side-menu) and then click "+ Add new store" the last option of the scroll down list (generally under your existing store(s) and your company name):

3. On the Add New Store page, click Advanced to see all settings.

  1. Fill in the details of your webshop, and choose your main Store from the Copy Elements From Existing Store dropdown, then click Add Store. This will carry over the Elements and Designs from your main Store.

  2. Now you can follow the Setup Guide again, to activate Clerk.io  by clicking on Getting Started, to Sync Data for this language. Remember to use the correct Language ID as described in the video in the top of the guide. The Store URL, Access Key, and Secret Access Key will be the same for all Stores.

  3. When Data Sync has finished, your webshop is ready and is using the same setup as your main Store.

  4. Remember to translate Headlines, in Element-> Edit -> Select Design to the right language as well.

    You can follow this process for all the languages of the webshop you want to use Clerk.io with.