Commerce Tools Integration
Overview
commercetools is a leading cloud-native, headless commerce platform that provides flexible APIs for building modern e-commerce experiences. It offers a comprehensive suite of commerce capabilities including product management, order processing, customer management, and more through its powerful API-first architecture.
commercetools is built on modern microservices architecture and provides multiple SDKs to integrate seamlessly with various systems. The platform is designed for enterprise-scale operations with high performance, scalability, and reliability.
Key Features
🛍️ Product Catalog
Comprehensive product management with variants, pricing, attributes, and advanced catalog features
📦 Order Management
Complete order lifecycle from cart to fulfillment with payment and shipping integration
👥 Customer Management
Customer profiles, groups, authentication, and personalization capabilities
🏷️ Categories
Hierarchical category structures for organizing products and navigation
🛒 Cart Management
Advanced shopping cart functionality with custom line items and promotions
🔌 API-First
RESTful APIs with comprehensive SDKs for multiple programming languages
When to Use This Integration
- Sync products between commercetools and PIM systems, ERP, or other e-commerce platforms
- Process orders from commercetools to fulfillment, WMS, or ERP systems
- Synchronize customers with CRM, marketing automation, or analytics platforms
- Manage categories and product hierarchies across multiple systems
- Update carts programmatically for custom checkout flows
- Export data for analytics, reporting, or data warehousing
Configuration
Required Fields
To configure the commercetools integration in Retrieve, you need the following credentials from your commercetools project:
{
"projectKey": "my-project",
"clientID": "your-client-id",
"clientSecret": "your-client-secret",
"scope": "manage_project:my-project",
"auth_url": "https://auth.us-central1.gcp.commercetools.com",
"api_url": "https://api.us-central1.gcp.commercetools.com"
}projectKey
Type: String (required)
Description: Your commercetools project key
Example: my-project
clientID
Type: String (required)
Description: OAuth 2.0 client ID from your API client
How to get: Create an API client in the commercetools Merchant Center
clientSecret
Type: String (required)
Description: OAuth 2.0 client secret from your API client
How to get: Generated when creating the API client (shown only once)
scope
Type: String (required)
Description: OAuth 2.0 scopes defining API permissions
Example: manage_project:my-project
auth_url
Type: String (required)
Description: commercetools OAuth 2.0 authorization server URL
Example: https://auth.us-central1.gcp.commercetools.com
api_url
Type: String (required)
Description: commercetools API endpoint URL
Example: https://api.us-central1.gcp.commercetools.com
How to Get commercetools API Credentials
- Log into Merchant Center
Access your commercetools Merchant Center at https://mc.commercetools.com/
- Navigate to Settings
Go to Settings → Developer settings in your project
- Create API Client
Click "Create new API client" and configure:
- Name: e.g., "Retrieve Integration"
- Scopes: Select appropriate scopes (e.g.,
manage_projectfor full access)
- Copy Credentials
After creation, copy all credentials (shown only once):
- Project key
- Client ID
- Client secret
- Scopes
- API URL
- Auth URL
- Store Securely
Save these credentials in a secure location. The client secret cannot be retrieved again.
Available SDKs
This integration uses the official commercetools JavaScript SDKs:
- @commercetools/sdk-client-v2 - Core HTTP client with authentication
- @commercetools/platform-sdk - Main API SDK for products, orders, customers, etc.
- @commercetools/importapi-sdk - Import API for bulk data operations
- @commercetools/ml-sdk - Machine Learning API SDK
- @commercetools/history-sdk - Change history tracking SDK
Use Cases
🔄 Product Synchronization
Sync product catalogs bidirectionally between commercetools and external systems like PIM, ERP, or other e-commerce platforms.
📊 Order Processing
Export orders from commercetools to fulfillment systems, ERPs, or warehouses for processing and shipping.
👤 Customer Data Integration
Integrate customer data with CRM systems, marketing platforms, or customer service tools.
📁 Category Management
Maintain consistent category hierarchies across multiple systems and channels.
API Documentation
For detailed API documentation, visit:
Support & Resources
For help with commercetools integration:
- Check the commercetools documentation
- Visit the commercetools Support Portal
- Contact Retrieve support for integration-specific questions