🎉 Try the public beta of the new docs site at algolia.com/doc-beta! 🎉
Integrations / commercetools

Install Algolia for commercetools

Connect your commercetools store with Algolia in a few clicks. Index your products and keep your product data in sync with Algolia without writing code.

The Algolia commercetools integration handles the data connection between your commercetools store and Algolia. To integrate Algolia in your frontend, you can use these UI libraries:

Before you begin

To connect commercetools and Algolia, you need:

Create a commercetools API client

To let Algolia interact with your store, you must first set up a new commercetools API client:

  1. Sign in to the Merchant Center of your commercetools project, to which you want to add Algolia.
  2. On the sidebar, go to Settings > Developer settings.
  3. Click Create new API client.
  4. Enter a name for the API client.
  5. Select the API scopes for the new client. You need at least the following scopes:

    • All items under the View column
    • View API clients
    • Subscriptions

    commercetools API client scopes screen

  6. Click Create API client.
  7. Copy or save the curl command. You need it to configure your commercetools integration in Algolia.

    commercetools API client curl command

For more information, see Get your API client in the commercetools documentation.

Connect commercetools with Algolia

  1. Sign in to the Algolia dashboard.
  2. Go to the Algolia integrations page and click Sign in.
  3. In the Algolia Application menu, select the Algolia app for your product index.

    Select an Algolia application for the commercetools products

  4. Paste the curl command for installing the commercetools API client to add details about your commercetools project to the form.

    Integrations curl form

  5. Name the index and choose between product or variant-level indexing:
    • Product level indexing.. A record is assigned to each product.
    • Variant level indexing.. A record is assigned to each product variant.
  6. Select the commercetools Store for Algolia indexing.

    Select a commercetools store

  7. In the Languages option, select one or more product data languages for your store.

    Choose languages and finalize

  8. When you’re done, click Finalize integration.

When the setup is complete, you can choose when to index your products. Select:

  • Yes, index now if you want to index your commercetools products now.
  • No, index later if you want to index your products later.

You won’t see your products in an Algolia index until you trigger a full reindex.

Index now or later?

Did you find this page helpful?