Skip to main content

​
Supported data types

Orders

Customer transactions

Inventory

Stock levels & product data

Returns

Order return details

​
Prerequisites

  • An API key with permissions to view orders and products in your commercetools project

​
Step-by-step integration guide

1

Initial setup

To set up the integration, you’ll need to provide us with specific credentials that allow our platform to access your commercetools data securely.
  1. Gather required information: Ensure you have the following details from your commercetools account:
    • Scope
    • API endpoint
    • Auth endpoint
    • Project key
    • Client ID
    • Client secret
    • Store key
  2. Provide credentials: Share the collected credentials with your Customer Success Manager.
For security reasons, send this information via a secure password sharing method.
Example
{
  "scope": "view_orders:exampleProject view_products:exampleProject",
  "apiEndpoint": "https://api.us-east1.gcp.commercetools.com",
  "authEndpoint": "https://auth.us-east1.gcp.commercetools.com/oauth/token",
  "projectKey": "exampleProject",
  "clientId": "ZZ-z-exampleclientid",
  "clientSecret": "exampleClientSecret",
  "storeKey": "exampleStore"
}
2

Configuring the integration

Once your credentials are received, our team will configure the integration, ensuring secure and efficient data synchronization between commercetools and our platform.
  • Access configuration: We will use the provided credentials to configure access to your commercetools data, focusing on orders and inventory.
  • Data synchronization: Our platform will begin to fetch and sync data based on your specified scope, enabling up-to-date visibility into your e-commerce operations.
3

Finalizing integration

After the integration is configured, you’ll be able to access and analyze your orders and inventory data directly from our platform. This integration facilitates better decision-making, helping you optimize your e-commerce strategy for increased efficiency and growth.

​
Troubleshooting and support

Should you encounter any issues during the integration process or have questions regarding the setup, our support team is readily available to assist you.

​
Additional resources

For more information on managing your commercetools account and understanding the API, visit the commercetools Documentation.