Integrating CommerceTools

Capabilities

DataGrail's CommerceTools integration provides the following capabilities:

Product	Capability
Request Manager	Request Types Access, Deletion Identifier Categories Email, User ID

Before You Start

To successfully configure this integration, please ensure you have sufficient privileges:

• DataGrail User Role: Super Admin, Connections Manager
• CommerceTools User Role: Admin

Create an API Client

1. Log in to your CommerceTools account and open the administration area.
2. In the left menu, select Settings, then scroll down and select Developer Settings.
3. Select Create new API client.
4. Enter Name.
5. In the Scopes section, you need at least to manage for the following resources:

Required Scopes

• Customers
• Orders
• Payments
• Products
• Shopping Lists

Optionally, you may also add the following:

Optional Scopes

• Business Units
• Quotes
• Quote requests

6. Select Create API client.
7. Copy client_id, secret and project_key and store them in a safe, temporary location.
8. Using the API URL, identify the region where Composable Commerce API is deployed:

Composable Commerce API Regions

• https://api.us-central1.gcp.commercetools.com/: North America (Google Cloud, Iowa)
• https://api.us-east-2.aws.commercetools.com/: North America (AWS, Ohio)
• https://api.eastus.azure.commercetools.com/: North America (Azure, Virginia)
• https://api.europe-west1.gcp.commercetools.com/: Europe (Google Cloud, Belgium)
• https://api.eu-central-1.aws.commercetools.com/: Europe (AWS, Frankfurt)
• https://api.australia-southeast1.gcp.commercetools.com/: Australia (Google Cloud, Sydney)
• https://api.cn-northwest-1.aws.commercetools.cn/: China (AWS, Ningxia)

Connect to DataGrail

1. Navigate back to DataGrail.
2. Enter the Client ID, Client Secret, Project Key and Region defined when creating the API Client.
3. Select Configure Integration.

Next Steps

Now that you've successfully connected the integration, check out the following resources:

• Access Request Lifecycle
• Deletion Request Lifecycle
• Request Manager Overview
• Customizing Intake Forms

Troubleshooting

If you are unable to successfully connect the integration, review these common troubleshooting steps:

Ensure Required Permissions Are Granted on API Keys/Resources

DataGrail checks required permissions and scopes on API keys/resources used by each integration. If all necessary permissions are not granted, new connections will fail.

Review Required Account Types and User Roles

If users do not have the necessary permissions or the minimum required user role in the connecting system, the connection to DataGrail will fail. Additionally, connections will fail if your account type does not match the one required by the integration.

See Before You Start to review these requirements.

Technical Details

The CommerceTools integration uses the GDPR compliance:

Access Type	Synchronous
Deletion Type	Synchronous

API Documentation

Learn more about this API implementation and DataGrail functionality in our API Integration Documentation.