DocumentationCommerceServices for Adobe Commerce

Catalog Sync

Last update: Fri Jul 19 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin
  • Leader
  • User
NOTE
The Catalog Sync Dashboard is now the Data Management Dashboard. This revamped dashboard now supports Product Recommendations v6.0.0+, Live Search v4.1.0+, and Catalog Service v1.17+. Customers can get the Data Management Dashboard by updating to the latest version of one of those services. Read more about it in the Data Management Dashboard documentation. This current topic remains for those users who have yet to upgrade and still have the Catalog Sync dashboard.

Adobe Commerce uses 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 service moves product data from an Adobe Commerce instance to the Commerce Services platform on an ongoing basis to keep the data up to date. For example, Product Recommendations requires current catalog information to accurately return recommendations with correct names, pricing, and availability. Use the Catalog Sync dashboard to observe and manage the synchronization process or the command-line interface to trigger a catalog sync and to reindex product data for consumption by Commerce Services. See Command-line Interface Reference in the SaaS Data Export Guide.

Accessing the Catalog Sync dashboard

To access the Catalog Sync dashboard, select System > Data Transfer > Catalog Sync.

With the Catalog Sync dashboard you can:

  • View the sync status (In Progress, Success, Failed)
  • View the total number of products synced
  • Search synced products to view their current state
  • Search store catalog by name, SKU, etc.
  • View synced product details in JSON to help diagnose a sync discrepancy
  • Reinitiate the sync process

Last sync

Reports a sync status of:

  • Success - Displays the date and time that the sync was successful and the number of products updated
  • Failed - Displays the date and time that the sync was attempted
  • In Progress - Displays the date and time of the last successful sync

The catalog sync process automatically runs every hour. If you do not see expected products on the storefront, or if the products do not reflect recent changes you made, you can resolve catalog sync issues.

Products synced

Displays the total number of products synced from your Commerce catalog. After the initial sync, only changed products should be synced.

Resync resync

If you must initiate a resync of your catalog before the hourly scheduled sync occurs, you can force a resync.

NOTE
Forcing a resync triggers a resync of your entire product catalog, which can increase load on hardware resources.

  1. From the Catalog Sync dashboard, select Settings.

    The Catalog Sync Settings page appears.

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

Synced catalog products

The Synced catalog products table displays the following information.

Field
Description
ID
Unique identifier of the product
Name
Storefront name of the product
Type
Identifies the product type, such as simple, configurable, or downloadable
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

Resolve catalog sync issues resolvesync

See Logs and troubleshooting in the SaaS Data Export Guide.

recommendation-more-help
3d5a1200-3287-4b90-a075-6c594f65d80e