commercetools integration

Integrate commercetools with Bloomreach to automatically sync your product catalog and customer data. This guide walks you through setup, configuration, and management.

Overview

The commercetools integration imports your products and customers into Bloomreach. Data syncs automatically once per day to keep your catalogs and customer records up to date.

With this integration, you can:

• Load all products and customers from commercetools when you install the connector.
• Sync all products and customers automatically through a scheduled task.
• Capture customer order events from commercetools.

Prerequisites

To deploy this integration, you need:

• commercetools account
• commercetools API keys (“Admin client”)
• Bloomreach project
• Bloomreach API keys (Private API access with full permissions)

Install the connector

Deploy the connector in your commercetools project. For details, refer to the commercetools connect deployment documentation.

Configure environment variables

Set up the required environment variables when you create the deployment:

• CTP_CLIENT_ID
• CTP_CLIENT_SECRET
• CTP_PROJECT_KEY
• CTP_SCOPE
• CTP_REGION
• BLOOMREACH_ENGAGEMENT_API_KEY
• BLOOMREACH_ENGAGEMENT_API_SECRET
• BLOOMREACH_ENGAGEMENT_PROJECT_TOKEN
• BLOOMREACH_ENGAGEMENT_CATALOG_LOCALE
• BASIC_AUTH_SECRET

Post-deployment setup

Once the connector is deployed, it triggers the postDeploy script automatically.

The postDeploy script sets up the import cron jobs:

• One for customers
• One for products
• One for variants

These cron jobs run every day at 00:00 UTC.

The connector also creates a subscription to listen to Order Created messages. Each time an order is created in commercetools, it's imported as a customer event in Bloomreach.

Uninstall the connector

To uninstall the connector, send the appropriate HTTP request and delete it.

This triggers the preUndeploy script, which deletes the import cron jobs and message subscriptions created during installation.

Limitations

• HTTP requests may take longer due to the connector's design, which delivers single CSV files.
• Maximum capacity is 10,000 customer and product records. If this limitation affects your project, contact Bloomreach Support.