[PaaS only]{class="badge informative" title="Applies to Adobe Commerce on Cloud projects (Adobe-managed PaaS infrastructure) and on-premises projects only."}

Get started

Install and configure the Adobe 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.

IMPORTANT
Always connect sandbox Optimizer instances to non-production environments and production instances to production environments. Mismatched environments cause inconsistent catalog data, search results, and recommendations.

Requirements to use the integration

The Adobe Commerce user configuring the integration must have:

Prerequisites

If you have any of the following extensions installed, uninstall them before installing the Adobe 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.

IMPORTANT
If these extensions are not removed before enabling the Connector, you may see broken configuration screens, duplicate data in Adobe Commerce Optimizer because the same data is exported from both the Connector and the existing extensions, and 401 or 403 errors in the logs due to conflicts in the way the extensions and the Connector authenticate with the connected services.

Configuration steps

Follow these steps to enable the connector and begin synchronizing data from Commerce to your Adobe Commerce Optimizer instance.

Install the Adobe Commerce Optimizer Connector package install-the-adobe-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

  1. Add the adobe-commerce/commerce-data-export-aco-adapter module using Composer:

    code language-shell
    composer require adobe-commerce/commerce-data-export-aco-adapter
    
  2. 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.

NOTE
For detailed extension installation instructions, see the following guides:
Install extension on Adobe Commerce on Cloud Infrastructure
Install extension on Adobe Commerce on-premises

Customize the Commerce scopes export configuration

By default, catalog data sync is enabled for all Commerce scopes (websites, customer groups 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 that share the same language you can choose to export data for only one of the store views and use it as the catalog source for multiple catalog views in Adobe Commerce Optimizer.

IMPORTANT
Changing export settings triggers a full re-indexation, which can take significant time depending on your catalog size. Adobe recommends configuring the Commerce scopes to sync to Commerce Optimizer before enabling the integration and starting the initial data sync.

The following table describes what data is exported at each scope level:

Scope
Data exported
Notes
Website and customer group
Prices and price books
Each set of prices is exported as a price book using the naming convention <website>::<SHA1 of customer group ID>. All customer groups for the website are included.
Store view
Products and product attributes
Each store view creates a separate catalog source in Adobe Commerce Optimizer.

Store Grid with Commerce Optimizer sync settings {width="600" modal="regular"}

To change the settings for a website or store view:

  1. In the Commerce Admin, navigate to Stores > Settings > All Stores.

  2. Select the website or store view you want to configure.

  3. In the Adobe Commerce Optimizer exporter settings, use the checkbox to enable or disable the data sync as needed.

    Update data sync configuration {width="500" modal="regular"}

  4. Save your changes.

Enable and disable behavior

Action
Result
Disable a store view
The catalog source remains in Adobe Commerce Optimizer, but all data is removed.
Disable then re-enable a store view
The same catalog source is repopulated with a full data resynchronization.

Enable the Adobe Commerce Optimizer integration

IMPORTANT
Data sync processing will start in background as soon as you complete configuration. Depending on the size of your catalog, the data sync process can take from a few minutes to several hours.

Get required connection details

From the Adobe Developer Console, create a new 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)

Obtain credential details {width="500" modal="regular"}

Get Adobe Commerce Optimizer instance details

Get the tenant ID from the Instance Id field on the Adobe Commerce Optimizer instance Instance details page, or from the URL used to access the instance. For example, in https://experience.adobe.com/#/@<your organization>/in:<tenant ID>/commerce-optimizer-studio/home.

  1. From the Commerce Admin, select Adobe Commerce Optimizer to display the configuration page with instructions.

    Adobe Commerce Optimizer configuration page {width="500" modal="regular"}

  2. From the command line, use SSH to connect to the Commerce staging environment.

  3. 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
  1. 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

You can monitor and verify that the sync is working from the Data Feed Sync Status page available in the Admin.

  1. Check sync status in the Commerce Admin:

    Go to System > Data Transfer > Data Feed Sync Status.

    Data Feed Sync Status page with feed item status reporting {width="500" modal="regular"}

    When the sync is running, the feed data shows successfully sent records. Select a feed to view details or troubleshoot sync issues.

  2. Confirm data arrived in Commerce Optimizer:

    From the Adobe Commerce Optimizer menu, select Data Sync.

    Data Sync {width="500" modal="regular"}

    Verify that the expected products, prices, and attributes appear.

TIP
If you have any issues with the data sync, see the Troubleshooting section in the SaaS Data Export documentation.

Next Steps

  1. Configure Adobe Commerce Optimizer catalog views and policies

    Create catalog views and policies in the Adobe Commerce Optimizer UI. Note that price books are created automatically from Adobe Commerce customer groups. For instructions, see the Catalog views and Policies documentation in the Commerce Optimizer User Guide.

  2. 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.

recommendation-more-help
commerce-help-aco-connector