Adobe Commerce and Magento Open Source use indexers to compile catalog data into tables. The process is automatically triggered by events such as a change to a product price or inventory level.
The catalog sync process runs hourly to allow Commerce services to use catalog data. Catalog sync exports product data from the Commerce server to Commerce services on an ongoing basis to keep the services up to date. For example, Product Recommendations needs current catalog information to accurately return recommendations with correct names, pricing, and availability. You can use the Catalog Sync dashboard to observe and manage the synchronization process or the command-line interface to trigger catalog sync and reindex product data for consumption by Commerce services.
To use the Catalog Sync dashboard or the command-line interface, you must have an API key and a SaaS data space configured.
The Catalog Sync dashboard is only available when the Product Recommendations modules are installed and reflects data projections related to that feature only. Support for other Commerce Services such as Live Search and Catalog Service are planned for the future.
To access the Catalog Sync dashboard, select System > Data Transfer > Catalog Sync.
With the Catalog Sync dashboard you can:
Reports a sync status of:
The catalog sync process automatically runs every hour. However, if you are not seeing products on your storefront, or if the products do not reflect recent changes you made, you can resolve catalog sync issues.
Displays the total number of products synced from your Commerce catalog. After the initial sync, you should expect only changed products to be synced.
If you must initiate a resync of your catalog before the hourly scheduled sync occurs, you can force a resync.
Forcing a resync triggers a resync of your entire product catalog, which can increase load on hardware resources.
From the Catalog Sync dashboard, select Settings.
The Catalog Sync Settings page appears.
In the Resync Data section, click Resync.
Commerce syncs your catalog during the next scheduled sync window. Depending on the size of your catalog, this operation can take a long time.
The Synced catalog products table displays the following information.
|ID||Unique identifier of the product|
|Name||Storefront name of the product|
|Type||Identifies the product type, such as simple, configurable, downloadable, and so on|
|Last Exported||Date the product was last successfully exported from your catalog|
|Last Modified||Date the product was last modified in your catalog|
|SKU||Displays the stock-keeping unit for the product|
|Price||Price of the product|
|Visibility||A product’s visibility setting as defined in the Commerce catalog|
When you trigger a data resync, it can take up to an hour for the data to update and be reflected in UI components, such as recommendation units. However, if after waiting for an hour you still notice discrepancies between your catalog and what appears on your storefront, or if the catalog sync failed, refer to the following:
If the sync is not running on a schedule or nothing is synced, see the KnowledgeBase.
If the catalog sync has a status of Failed, submit a support ticket.
When running a data sync for the first time, it is important to run the
productattributes feed first, followed by
productoverrides, before running the
bin/magento saas:resync --feed <feed name> [no-reindex]
The following table describes the
saas:resync parameters and descriptions.
||Specifies which entity to resync, such as
||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:
categories– Categories in your catalog
categoryPermissions- Permissions for each of the categories
products– Products in your catalog
productattributes– Product attributes such as
bottoms, and so on
productoverrides– Customer-specific pricing and catalog visibility rules, such as those based on category permissions
variants– Product variations of a configurable product, such as color and size
When you trigger a data resync from the command line, it may take up to an hour for the data to update.
If you are using SaaS price indexing and need to resync, run the following command:
bin/magento saas:resync --feed scopesCustomerGroup bin/magento saas:resync --feed scopesWebsite bin/magento saas:resync --feed prices
To do a resync for Catalog Service, it is important to run the commands in this order:
bin/magento saas:resync --feed productattributes bin/magento saas:resync --feed products bin/magento saas:resync --feed productoverrides bin/magento saas:resync --feed variants bin/magento saas:resync --feed categories bin/magento saas:resync --feed categoryPermissions
The following example reindexes the product data from the Commerce catalog and resyncs it to Commerce services:
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:
bin/magento saas:resync --feed products --no-reindex