Get Started

Get Clerk up and running on your WooCommerce store in just a few steps. This guide walks you through creating your Store, installing the plugin, and syncing your data.

Create store #

Each Clerk setup is configured on a Store in my.clerk.io.

This will contain all the data you upload, and allow you to interact with it through its Public API key.

If it is the first time you login in my.clerk.io, you will be prompted to create a New Store.

Follow these guidelines:

1. Insert a Name, usually the name of the Store.

2. In Domain, insert the website URL.

3. Choose a language.

4. Choose a currency.

5. Choose a platform, in this case WooCommerce.

6. (Optional) Specify the type of Store.

If you need to set up multiple languages, webshops or domains, each should have their own Store.

You can copy your configuration to new Stores after doing the first setup.

Install plugin #

After creating a Store in my.clerk.io, install the plugin in your WooCommerce backend:

1. Download the latest version of the plugin: Latest release.

2. In WordPress, go to Plugins > Add New → Upload Plugin → Choose File.

3. Select the downloaded file and click Install Now.

4. When the plugin has installed, click Activate Plugin.

You need WordPress Administrator access to see Plugins in the left menu. If you don’t see it, ask a site administrator to grant you temporary Administrator permissions or install the Clerk plugin for you.

Configure plugin #

1. Open Clerk Options in your WooCommerce backend.

2. Enter your Public Key and Private Key, then click Save Settings.

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

You can find more details about the different Clerk plugin options here.

Sync data #

1. In the plugin, copy your Import URL from the General section.

2. Go to my.clerk.io > Data > Configuration and paste the Import URL into the Import URL field.

3. If you plan to use Email & Audience, set Collect Emails to Yes in the plugin and Save.

4. Select the language for your domain if applicable.

5. Click Start Sync and wait for the sync to complete.

Add content #

Follow these guidelines to add content to your frontend:

1. Create a Design for Search, and one for Recommendation. For example, for Recommendations, go to Recommendations > Designs and click New Design.

2. Create an Element for each element. For example, for Search, go to Search > Elements and click New Element.

3. Insert Elements into your frontend.

Refer to the guides for each element you need to add, including guidelines for the design and how to create new Elements for Search and Recommendations.