commercetools connector
The commercetools Connector allows you to connect commercetools Composable Commerce to Constructor. This connection enables you to quickly synchronize your catalog data with Constructor, including your products, variations, categories, and custom product attributes.
Why use it?
Constructor Connect accelerates the path to value for joint customers through a turnkey product catalog integration. In just a few clicks, connect your commercetools catalog for ingestion and regular updates to Constructor (categories, products, and variations included).
Supported versions
Both commercetools and Constructor are version-less SaaS solutions. You only need active accounts to use the commercetools Connector.
How it works
The connector uses the commercetools API to fetch the catalog data from your commercetools instance. It provides a base transformation layer to import data into Constructor to sync and update your catalog.
The connector uses data from a specific locale and currency by default. This means that only values from the chosen language and currency will be synced to a given index at Constructor. If you need to sync multiple indexes, please contact our support at [email protected].
The connector is read-only to ensure that commercetools remains the source of truth for your catalog data.
Installation
Step 1: Create a new API client
Login to your commercetools account. In your dashboard, navigate to Settings
> Developer Settings
.
There, click Create new API client
to create a new client.
Note: You can choose the name freely, but we recommend including the term
Constructor
to make it easier to find in the future
Step 2: Define scopes
Define your scopes to ensure that the connector can access your information correctly to sync the catalog data.
In the New API client screen, select Read only client
from the scope configuration:
Note: After you're done, click
Create API client
to create the client.
Step 3: Save credentials
After you've created the client, you'll be redirected to the client details screen. There, you'll need to copy and store your credentials somewhere safe. Note that you will not be able to access your credentials again, so make sure to have them stored safely (for example a password vault or encrypted drive).
Here's the items you will need to copy:
project_key
client_id
secret
api_url
auth_url
Step 4: Contact our team
With your credentials in hand, you'll need to contact our team at [email protected]
. We'll instruct you on how to proceed with the installation and will provide you with the necessary information to complete the setup.
There are some important security points that you need to take into consideration here:
- Be sure to include only the email preceding in the list of recipients. Do not share your credentials with anyone else.
- Do not share your credentials in public channels (for example Slack, Microsoft Teams, email with multiple people in copy, etc).
- If possible, please encrypt the credentials file before attaching it to the email.
This initial process may take up to 3 business days, but typically it starts working the same business day. You can track your product data updates on the Constructor dashboard.
We will reach out to you within 3 business days via email if we have any questions.
Note: Many email provides now support encryption for attachments. You can use this feature to encrypt your credentials file before sending it to us.
You're all set 🎉
That's it. You have successfully connected your commercetools account to your Constructor account.
After the setup is done, you will be notified and you will be able to enjoy automated product information updates from commercetools to Constructor:
Note: The image preceding is an example of the catalog representation in your Constructor account. Use our visual dashboard to validate your product data within the Constructor platform.
Data mapping
You can refer to the commercetools API Docs and Constructor API Docs for more information about the data types.
Categories
commercetools Categories map to Constructor groups
.
Constructor Entity | Constructor Field | commercetools Field |
---|---|---|
groups | id | category.key OR category.id |
groups | name | category.name |
groups | parent_id | category.ancestors[0].key |
Note: All category hierarchy is preserved.
Products
The connector uses the Product Types at commercetools to define your product attributes.
You can also refer to the docs below on how different attribute types are mapped to Constructor.
Product information
A Product on commercetools will always be transformed to an item
at Constructor, defining the base product:
Constructor Entity | Constructor Field | commercetools Field |
---|---|---|
items | id | product.key OR product.id |
items | active | true |
items | item_name | product.masterData.current.name |
items | image_url | product.masterData.current.masterVariant.images[0] |
items | url | mapped from slug |
items | description | product.masterData.current.description |
items | group_ids | product.masterData.current.categories |
items | metadata | see metadata |
items | keywords | product.masterData.current.searchKeyword |
Then, every single Product Variant will be transformed to a Constructor variation
:
Constructor Entity | Constructor Field | commercetools Field |
---|---|---|
variations | active | true |
variations | item_name | variant.sku |
variations | item_id | product.key OR product.id |
variations | variation_id | variant.key OR variant.sku OR variant.id |
variations | image_url | variant.images[0] |
variations | url | mapped from slug |
variations | metadata | see metadata |
Product metadata
The connector does not map any specific attributes by default. Specific attributes are those which will vary from integration to integration, like color
, price
, availability
or others.
Instead, we provide a powerful template ecosystem via the Connect CLI that allows you to interface with the connector and map the data to ingest those attributes as metadata in any way you need.
Updated about 1 month ago