Install and Configure

Deploying Product Recommendations to your storefront and Admin requires that you install the module and configure the Commerce Services Connector. As updates are released, you can easily update your installation with the latest version.

Install Product Recommendations

Because the Product Recommendations module is a stand-alone metapackage, updates are released more frequently than Adobe Commerce. To make sure you are up to date with the latest bug fixes and features, refer to the release notes.

Install the magento/product-recommendations module with Composer:

composer require magento/product-recommendations

Add Page Builder support

Product Recommendations for Page Builder is an optional module and is installed separately. To use Product Recommendations with Page Builder, install the module by running the following command:

composer require magento/module-page-builder-product-recommendations

By enabling Product Recommendations in Page Builder, you can add an existing, active recommendation unit to any content created in Page Builder, such as pages, blocks, and dynamic blocks.

See Using Product Recommendations with Page Builder Content for further instructions.

Add Visual similarity recommendation type

The Visual similarity recommendation type allows you to deploy a recommendation unit to your product detail page that displays products that are visually similar to the product being viewed. This recommendation type is most useful where images and visual aspects of the products are important parts of the shopping experience. Install the Visual similarity recommendation type by running the following command:

composer require magento/module-visual-product-recommendations

Configure Product Recommendations

After you install the magento/product-recommendations module, you must configure the Commerce Services Connector by specifying API Keys and selecting a SaaS Data Space.

To ensure that catalog export is running correctly, confirm that the cron jobs and the indexers are running and the Product Feed indexer is set to Update by Schedule.

When you successfully link to Commerce Services through API keys and specify the SaaS Data Space, the catalog sync begins. You can then verify that behavioral data is being sent to your storefront.

Update your Product Recommendations installation

Like all of Adobe Commerce, Product Recommendations uses Composer for installation and updates. To update the magento/product-recommendations module, run the following:

composer update magento/product-recommendations --with-dependencies

To update to a major version, such as from 3.0 to 4.0, you must edit the root composer.json file for your project. (See the release notes for information about the latest version.) For example, let’s open the main composer.json file and search for the magento/product-recommendations module:

"require": {
    "magento/product-recommendations": "^3.0",

Let’s bump the major version from 3.0 to 4.0:

"require": {
    "magento/product-recommendations": "^4.0",

Save the composer.json file and run:

composer update magento/product-recommendations --with-dependencies

Or if you have installed the magento/module-visual-product-recommendations and magento/module-page-builder-product-recommendations modules:

composer update --with-dependencies magento/product-recommendations magento/module-visual-product-recommendations magento/module-page-builder-product-recommendations

In versions 3.x.x of Product Recommendations, you only needed a single API key. In versions 4.x.x and higher, you must provide Production public and private API keys as well as Sandbox public and private API keys. If you do not provide both pairs of API keys, you cannot access the Product Recommendations feature in the Admin. Data collection, however, will continue on your storefront and existing recommendations will continue to be shown to your shoppers.

Uninstall Product Recommendations

If necessary, you can uninstall the product-recommendations module.

On this page