Catalog Sync
Adobe Commerce and Magento Open Source 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 Commerce services to use that catalog data, a catalog sync process runs hourly. The catalog sync process exports product data from the Commerce server to Commerce services, which are deployed as SaaS, 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 Commerce services.
Sync catalog data
To synchronize catalog data, you must have an API key and a SaaS Data Space configured. If you do not have an API key and have not configured a SaaS Data Space, you can still reindex product data but that data will not be exported to Commerce services.
The saas:resync command is 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 Commerce 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.
Command options:
1
bin/magento saas:resync --feed <feed name> [no-reindex]
The following table explains this command’s parameters and descriptions.
| Parameter | Description | Required? |
|---|---|---|
feed |
Specifies which entity to resync, such as products |
Yes |
no-reindex |
Resubmits the existing catalog data to Commerce services without reindexing. When this parameter is not specified, the command runs a full reindex before syncing data. | No |
The feed name can be one of the following:
products– Products in your catalogcategories– Categories in your catalogvariants– Product variations of a configurable product, such as color and sizeproductattributes– Product attributes such asactivity,gender,tops,bottoms, and so onproductoverrides– Customer-specific pricing and catalog visibility rules, such as those based on category permissions
Examples
The following example reindexes the product data from the Commerce catalog and resyncs it to Commerce services:
1
bin/magento saas: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:
1
bin/magento saas:resync --feed products --no-reindex