Commercetools

The following is a guide on how to integrate Commercetools with Bloomreach Engagement.

With the Commercetools integration, your Commercetools products and customers will be imported into Bloomreach Engagement. Your Commercetools products and customers will be synchronized with Bloomreach Engagement once a day.

With the Commercetools integration, you can:

• Initially load all products and customers from Commercetools to Bloomreach Engagement when the connector is installed;
• Automatically synchronize all products and customers from Commercetools to Bloomreach Engagement through a scheduled task;
• Capture customer order events from Commercetools to Bloomreach Engagement.

Prerequisites

To deploy this integration, you need:

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

How to set it up

Install the connector

You'll need to deploy the connector in your Commercetools project. For details, refer to the Commercetools connect deployment documentation.

Setup 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

Once the connector is deployed, it should trigger the postDeploy script.

The postDeploy script will set up the Import cron jobs. One for customers, the other for products, and another for variants. Cron jobs will run every day at 00:00 UTC.

On the other hand, the connector will create a subscription to listen to Order Created messages. Each time an order is created in Commercetools, it will be imported as a customer event in Bloomreach.

Uninstall the connector

If you want to uninstall the connector, you must send the appropriate HTTP request and delete it.

This will trigger the preUndeploy script, which will delete the Import cron jobs and messages subscriptions described in the Install the Connector section.

Limitations

• Potential longer HTTP request times due to the connector's design, which delivers single CSV files
• Maximum capacity of 10,000 customer and product records
  • If this limitation affects your project, contact us for assistance