Commercetools Installation Instructions
Before You Begin
Before you begin, you will need to obtain authentication information from Commercetools.
Steps to Obtain Client ID and Client Secret for Commerce Tool OAuth 2.0:
Log in to your Commercetools account.
Choose your project.
On the Developer settings page, choose the API clients tab.
Click Create new API client.
On the New API client page, enter a Name.
Select the Scopes for the API client.
When you are satisfied with your selections, click Create API client.
Commercetools displays the API Client Details page.You can copy each credential or choose a format at the bottom of the page for your development environment. You will need the following API credentials:
client_id
client_secret
project_key
scopes
api_url
auth_url
You will use these credentials when setting up your subscription.
Using Credentials in iPaaS Subscription Settings
When running any flow using manual sync, the client_id and client_secret are exchanged for an access token from the auth_url. That access token is then used to call Commercetools APIs via the api_url.
Installation Instructions for Integration Setup
Go to Subscriptions, click Search Certified Integration Marketplace.
Click the Commercetools integration tile.
Click the Subscribe button.
Enter the Name of the subscription and select a Version. It can be set to any relevant and unique subscription name within the company where this subscription is created.Format: [Product Name] - [Environment/Purpose]
Example: Commercetools – Production
Select Create Default Mappings (recommended). If you don’t want to create default mappings and want to create all mappings from scratch by yourself, then uncheck this box.
Enter the following credentials retrieved from Commercetools:
API URL
API KEY
CLIENT_ID
CLIENT_SECRET
SCOPE
Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests. It protects system performance by controlling the number of API requests that can run simultaneously, ensuring fair usage.
Recommended Values
Initial Setup: 5
Ongoing Operations: 500
High Volume: 500
Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured. If an integration makes too many requests within this time window, additional requests are rejected until the window resets.
Default Value: 60 seconds
Range: 60 seconds
Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that Avalara Exemption Certificate Management can process for a user or integration. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Enter the number of Concurrent Batch Executions. This specifies the maximum number of simultaneous batch executions that can be processed by an integration at any given time. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Click Apply to save your subscription settings.
Post-Installation Verification
After completing the installation, perform these tests to verify the installation.
Data Sync Test
Initiate a sample data pull. (To iPaaS.com)
Initiate a sample data push. (From iPaaS.com)
Functionality Test
Run an end-to-end business process.
Validate key features like field mappings, workflow triggers, and logging.
Review integration logs in iPaaS.com.
Common Issues and Solutions
Invalid API Domain
Issue: Using the wrong API region/domain (e.g., defaulting to api.commercetools.com).
Solution: Use the region-specific API URL provided in your Commercetools project settings.
Examples:
https://api.us-central1.gcp.commercetools.com (US)https://api.eu-central-1.aws.commercetools.com (EU)
Authentication Failures
Issue: Requests return 401 Unauthorized or invalid_client.
Solution: Ensure you’re using the correct Client ID and Client Secret from the Commercetools Merchant Center > API Clients.
Always fetch a valid OAuth 2.0 access token from the Auth URL before making API requests.
Refresh tokens before they expire, or request new tokens as needed.
Insufficient Permissions (Scopes)
Issue: API calls fail due to missing permissions (e.g., cannot create/update products or orders).
Solution: Verify that your API Client in Merchant Center is configured with the required scopes.
Example scopes:
manage_products: Create/update product data.
manage_orders: Manage order data.
view_customers: Read customer data.
Invalid or Missing IDs
Issue: Requests fail because product, category, or customer IDs don’t exist.
Solution: Always fetch valid IDs via GET endpoints before referencing them in POST, PUT, or DELETE.
Example: Use /products to retrieve a product ID before updating it.
Incorrect Data Format
Issue: Payload rejected due to invalid data formats (e.g., price, dates, attributes).
Solution: Use ISO 8601 format for dates.
Provide numbers (price, quantity) as valid integers or decimals.
Validate request body against the Commercetools API schema.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation.
Documentation: Search our documentation at the top of this article
Support Portal: Click the Help and Support button at the lower-right of this window.
Contact Information: Contact iPaaS.com.