Catalog Sync

Magento compiles catalog data into tables using indexers. This process is automatically triggered by several events, such as changes to a product’s price or inventory levels. To allow some Magento services to use that catalog data, a catalog sync process runs hourly. The catalog sync process exports product data from the Magento server to SaaS services on an ongoing basis. For example, the Product Recommendations feature needs up-to-date catalog information so that it can accurately return recommendations with correct names, pricing, and availability. Use the command-line interface to trigger the catalog sync and reindex product data for consumption by SaaS services.

To use the catalog sync commands, you must have an API key and a SaaS environment configured. If you do not have an API key and have not configured a SaaS environment, you can still reindex product data but that data will not be exported to SaaS services.

The commands used to sync catalog data are part of the magento/saas-export package. See Install and configure Product Recommendations for more information.

See the user guide to learn how to use the Catalog Sync dashboard in the Admin UI to observe and manage the Magento to SaaS syncing process.

When you trigger a data resync from the command line, it can take up to an hour for the data to update.

The following command reindexes the product data from the Magento catalog and resyncs it to Magento SaaS services:

bin/magento saascatalog:resync --feed products

If you do not want to run a full reindex of the products, you can instead sync the product data that has already been generated:

bin/magento saascatalog:resync --feed products --no-reindex
Parameter Description
feed (Required) Specifies which entity to resync, such as products
no-reindex (Optional) Resubmits the existing catalog data to the SaaS service without reindexing. When this parameter is not specified, the command runs a full reindex before syncing data.