Documentation Commerce Content and Design

Configure the integration

Last update: March 5, 2025

Topics:
CMS
Media

CREATED FOR:

Beginner
Intermediate
Admin
User

Configure the integration by connecting Commerce to the AEM Assets instance and selecting the matching strategy for asset synchronization.

After identifying the AEM Assets project, select the matching rule for synchronizing assets between Adobe Commerce and AEM Assets.

Match by product SKU—Default rule that matches the SKU in the asset metadata with the Commerce product SKU to ensure that assets are associated with the correct products.
Custom match—Matching rule for more complex scenarios or specific business requirements that require custom matching logic. Implementing custom matching requires developing custom code in Adobe Developer App Builder to define how assets are matched with products. More details coming soon…

For the initial setup, use the default Match by product sku rule.

Prerequisites

Install AEM Assets package
Install Adobe Commerce packages to add the extension and generate the required credentials and connections to use the extension.
Create a support ticket to request enablement for the AEM Assets for Commerce Integration. In the ticket, include the Program ID, Environment ID and IMS Org ID for the AEM Assets Authoring environment that you want to connect to Commerce.

TIP
(Optional) Provide the Asset Selector IMS Client ID if available. See ImsAuthProps in the AEM Assets Selector documentation.

Configure the connection

Get the AEM Assets Authoring Environment project and environment ID.
1. Open the AEM Sites console and select Assets.
2. Copy and save the project and environment IDs from the URL:
  https://author-p[Program ID]-e[EnvironmentID].adobeaemcloud.com/
From the Commerce Admin, open the AEM Assets Integration configuration.
1. Go to Store > Configuration > ADOBE SERVICES > AEM Assets Integration.
Enter the AEM Assets environment Program ID and Environment ID.

Edit the configuration values by removing the selection from Use system value.
Enter the Asset Selector IMS Client ID, if available.

The Asset Selector IMS Client ID is required by the Assets Selector, an AEM Assets feature that allows users to embed visual assets directly into Commerce product pages.
Select the Commerce integration for authenticating requests between Commerce and the asset matching service.
Set Integration enabled to Yes to allow Commerce to accept incoming updates from AEM Assets.

After enabling the integration, additional configuration options are available to specify asset matching criteria.
Define the matching rule for asset synchronization.
1. Select Match by product SKU, or Custom match (Requires App Builder).
2. Add the AEM Assets metadata field name defined for Commerce product SKUs in the Match by product SKU attribute name field, commerce:skus for example.
Select Save Config to apply updates and initiate asset synchronization.

The configuration update triggers the initial synchronization process, allowing Commerce to accept incoming updates from AEM Assets. The time required for synchronization depends on the volume of assets and specific configurations. The integration leverages automated processes to minimize the time required for synchronization.