commercetools

The Relewise integration with commercetools synchronizes product data from a commercetools Store to Relewise every hour.

Integration details

Once set up, the integration performs a full import of products from your selected store once every hour. The integration maps all standard fields, but does not support custom fields created in commercetools. If you have special fields you need mapped, please reach out to us to discuss the possibilities.

For stores with more than 10,000 active products, the import may run afoul of the allowed scheduled timeouts by commercetools. Ensure that you test and verify that the product import completes correctly when you set up the integration.

Set up the commercetools integration

To get set up, follow the instructions below, or visit our GitHub guide for the full technical specs.

The integration is deployed through commercetools Connect. The API Client that creates or updates the deployment must have the permissions required to manage Connect deployments and manage_api_clients:{projectKey}. Connect uses this permission to create a dedicated, least-privilege API Client for the integration.

Do not add manage_api_clients to the generated integration client. The connector requests only these read scopes:

• view_products
• view_product_selections
• view_categories

Connect appends the Project key to each scope and supplies CTP_API_URL, CTP_AUTH_URL, CTP_CLIENT_ID, CTP_CLIENT_SECRET, CTP_PROJECT_KEY, and CTP_SCOPE to the running integration. You do not enter these values in the deployment configuration.

Relewise configuration

Enter these secured values when you create the deployment:

• RELEWISE_STORE_KEY: The key for the store from which the export will be performed. You can find this in the Merchandising Center for commercetools.
• RELEWISE_DATASET_ID: The Dataset ID in Relewise.
• RELEWISE_API_KEY: API Key with permission to perform product updates and administrative actions.
• RELEWISE_SERVER_URL: The Server URL where your dataset is hosted.

To access the data needed to fill out these configurations, you need access to your My Relewise account. If you do not have access, please reach out to us.

You can access the configuration data via My Relewise -> Administration -> API Keys

Relewise API Key permissions

Create an API Key for the integration by selecting Create new API Key in My Relewise. The API Key needs these permissions:

• Integration:
  • Explicit product updates
  • Product administrative actions
  • Batched action tracking

Ensure that your API Key is given the proper permissions

Migrate an existing deployment

Existing deployments may supply their commercetools region and API Client credentials manually. To migrate:

1. Add manage_api_clients:{projectKey} to the API Client used to update the Connector and deployment.
2. Update the Connector and deployment to a version that supports generated credentials. When updating through the Connect API, set updateConnector to true.
3. Supply only the Relewise secured configuration listed above. CTP_REGION, CTP_PROJECT_KEY, CTP_CLIENT_ID, CTP_CLIENT_SECRET, and CTP_SCOPE are no longer deployment inputs.
4. Verify a full synchronization in a preview or sandbox deployment before updating production.