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. The Catalog Sync dashboard allows you to observe and manage the Magento to SaaS syncing process.

To use the Catalog Sync dashboard, you must have an API key and a SaaS environment configured.

See the developer documentation to learn how to use the command-line interface to trigger the catalog sync and reindex product data for consumption by SaaS services.

With the Catalog Sync dashboard you can:

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

Accessing the Catalog Sync dashboard

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

Last sync

Reports a sync status of:

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

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.

Products synced

Displays the total number of products synced from your Magento catalog. After the initial sync, you should expect only changed products to be synced.

Resync

If you need to 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.

  1. From the Catalog Sync dashboard, select Settings.

    The Catalog Sync Settings page appears.

  2. In the Resync Data section, click Resync.

    Magento 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, 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 Magento catalog

Resolve catalog sync issues

If you notice discrepancies between your catalog and what appears on your storefront, or if the catalog sync failed, refer to the following:

Data discrepancy

  1. Display the detailed view of the product in question in the search results.
  2. Copy the JSON output and verify the content matches what you have in the Magento catalog.
  3. If the content does not match, make a minor change to the product in your catalog, such as adding a space or a period.
  4. Wait for a resync or trigger a manual resync.

Sync not running

If the sync is not running on a schedule or nothing is synced, see the KnowledgeBase.

Sync failed

If the catalog sync has a status of Failed, submit a support ticket.