Get started
Install and configure the Commerce Optimizer Connector to sync your Adobe Commerce catalog data with Adobe Commerce Optimizer, then monitor the data sync status to ensure your storefront is up to date.
Requirements to use the integration
-
Adobe Commerce 2.4.7+
- PHP 8.2, 8.3, or 8.4
- Composer 2.x
-
Adobe Commerce Optimizer license with a provisioned sandbox instance.
-
Access to repo.magento.com to download the Commerce Connector metapackage using Composer.
-
Admin access to an Adobe Commerce Optimizer sandbox instance.
The Adobe Commerce user configuring the integration must have:
-
Administrator access to the Adobe Commerce Admin.
-
Command line access to the Adobe Commerce application server.
-
Developer access to the IMS Organization where the Adobe Commerce Optimizer project is provisioned.
Prerequisites
If you have any of the following extensions installed, uninstall them before installing the Commerce Optimizer Connector:
- Adobe Commerce Live Search (
magento/live-search) - Adobe Commerce Product Recommendations (
magento/product-recommendations) - Adobe Commerce Catalog Service (
magento/catalog-service,magento/catalog-service-installer) - Data Management Dashboard (
magento-catalog-sync-admin)
Data associated with these extensions is still available in the Commerce database. However, it is not exported to Adobe Commerce Optimizer when the Connector is enabled. To implement the search and merchandising capabilities provided by these extensions after enabling the Connector, configure them from the Adobe Commerce Optimizer Admin UI.
Configuration steps
Follow these steps to enable the connector and begin synchronizing data from Commerce to your Adobe Commerce Optimizer instance.
-
Install the Commerce Optimizer Connector package using Composer to connect your Commerce instance to Adobe Commerce Optimizer.
-
Review and customize the data export configuration from the Admin.
-
Get API credentials required to establish the connection between Commerce and Commerce Optimizer.
Install the Commerce Optimizer Connector package
The Adobe Commerce Optimizer Connector is delivered as a Composer metapackage available to all Commerce merchants with an active license for Adobe Commerce Optimizer.
Installation steps
-
Add the
adobe-commerce/commerce-data-export-aco-adaptermodule using Composer:code language-shell composer require adobe-commerce/commerce-data-export-aco-adapter -
Deploy the changes to your Adobe Commerce staging environment.
After deployment completes, the Commerce Optimizer option is available from the Commerce Admin menu. Click Commerce Optimizer to open your Commerce Optimizer instance directly from the Commerce Admin.
Get required connection details
From the Adobe Developer Console, create a developer project enabled for the Adobe Commerce Optimizer Ingestion service and generate OAuth Server-to-Server credentials. For detailed instructions, see Obtain IMS Credentials in the Merchandising Developer Guide.
Save the following values from the credentials page:
- Organization ID (
org_id) - Client ID (
client_id) - Client secret (
client_secret)
Get Adobe Commerce Optimizer instance details
Save the instance ID (also called the tenant ID) from your Adobe Commerce Optimizer instance. You can find it in the URL used to access the instance. For example, in https://experience.adobe.com/#/@<project-id>/in:TToyu73daQRn66KAYaq8YZ/commerce-optimizer-studio/home, the instance ID is TToyu73daQRn66KAYaq8YZ.
Customize the Commerce data export configuration
By default, catalog data sync is enabled for all Commerce scopes (websites and store views). You can customize the export settings to sync data only for specific scopes based on your business needs. For example, if you have multiple store views but only want to export data for one of them, you can disable the exporter for the other store views.
Data export by scope
The following table describes what data is exported at each scope level:
website::customergroupcode. All customer groups for the website are included.Enable and disable behavior
Update the export configuration
After you install the Connector package, the Store grid in the Admin now shows the export configuration settings for Commerce Optimizer.
To change the settings for a website or store view:
-
In the Commerce Admin, navigate to Stores > Settings > All Stores.
-
Select the website or store view you want to configure.
-
In the Adobe Commerce Optimizer exporter settings, use the checkbox to enable or disable the data sync as needed.
-
Save your changes.
Enable the Adobe Commerce Optimizer integration
Using the API credentials and instance details you gathered in the previous steps, you can now configure the integration between your Commerce and Adobe Commerce Optimizer instances.
-
From the Commerce Admin, select Adobe Commerce Optimizer to display the configuration page with instructions.
-
From the command line, use SSH to connect to the Commerce staging environment.
-
Run the following Commerce CLI command to configure the integration, replacing the placeholder values with the values for your Commerce Optimizer project:
bin/magento aco:config:init --org_id=your-org --tenant_id=your-tenant --client_id=your-client-id --client_secret=your-secret
-
Verify the connection by returning to the Commerce Admin and selecting the Adobe Commerce Optimizer option.
When you click the option, it opens the Adobe Commerce Optimizer UI in a new tab.
Verify that the data sync is working
After you enable the integration, data sync begins automatically. Depending on catalog size, the initial sync can take from a few minutes to several hours.
-
Check sync status in the Commerce Admin:
Go to System > Data Transfer > Data Feed Sync Status.
When the sync is running, the feed data shows successfully sent records. Select a feed to view details or troubleshoot sync issues.
-
Confirm data arrived in Commerce Optimizer:
From the Adobe Commerce Optimizer menu, select Data Sync.
Verify that the expected products, prices, and attributes appear.
Next Steps
-
Configure Adobe Commerce Optimizer catalog views and policies
Create catalog views and policies in the Adobe Commerce Optimizer Guide. Note that price books are created automatically from Adobe Commerce customer groups.
-
Set up a Commerce Storefront on Edge Delivery Services
Follow the Storefront setup documentation to connect your storefront to the Adobe Commerce Optimizer instance and start delivering personalized commerce experiences.