Vtex

Recommendations

General #

Clerk.io’s Recommendations can be installed on any page of the webshop, to help customers find the right products.

With the Setup Guide, you can see which pages to install recommendations on, and which types to use, to get our Best Practice running.

From the main menu start by clicking on Getting Started:

1. Create a Standard Design #

The first thing you need to do, is create a Standard Design for your sliders.

You can use the Setup Guide under Recommendations - Create a design for your recommendations sliders - to quickly create a Design that has the same color scheme and style as your webshop.

Click Publish when you are happy with the styling.

You can easily change this later, under Recommendations - Designs, then click the edit button.

2. Selecting Which Recommendations To Use #

Next, each step of the Setup Guide focuses on a specific page of the webshop.

and contains information about

  • Why recommendations are important on the page.

  • Which recommendations types to use.

  • Where on the page they should be placed.

Click for each type of recommendations you want to use and follow the steps.

Please bare in mind: by only clicking on each block of Recommendations they will turn green  as if they were installed - they are not - you still need to click and follow the steps.

3. Inserting Recommendations #

After choosing which recommendations to use for a page, you can add them to your webshop.

4. Configuration VTEX Recommendations #

  1. On your store theme, Add clerkiopartnerdk.integration-vtex 1.x as a theme peerDependency in the manifest.json file:
"peerDependencies": {
"clerkiopartnerdk.integration-vtex": "1.x"
}
  1. Add the clerkio_recommendations block anywhere on your store. Example: in home.json
{
  "store.home": {
    "blocks": [
      "responsive-layout.desktop#homepage",
      "responsive-layout.mobile#homepage"
    ]
  },
  "responsive-layout.desktop#homepage": {
    "children": ["clerkio_recommendations"]
  }
}
  1. Go to VTEX Site Editor, and on the right side menu a ClerkIO block will be displayed. Click on it.
Vtex block clerk recommendations
  1. Fill in the information required on the block.
    Block Class Name: insert unique identifier for the block within the page it is used on. Eg. clerk-product-page-alternatives
    Template Name: insert the ID provided by Clerk on the previously created Content.
    Product Logic: match the recommendation logic to the one specified on the previously created Content on Clerk. The available product logics are:
Vtex block clerk recommendations