The connector allows you to map and synchronise your product catalog from your store to your Dotdigital account.
With your product catalog synchronised, you can insert products into campaigns with ease by utilising the Products building block in EasyEditor or setting up Product Recommendations.
Before you start
Things you need to know:
You need to make sure you have saved and valid API credentials.
Learn more in Getting started with the API.
Enable catalog sync
Go to Stores > Configuration > DOTDIGITAL > Sync Settings, and find the heading Sync.
Expand the Catalog Enabled drop-down menu, and select Yes.
Select Save Config.
List of synced catalog data
The catalog data that gets synced includes:
Field name | Description |
id | The database ID of the product. |
image_path | The image path of the default image for the product. |
stock | The current stock levels of the product. |
websites | The websites the product is currently available on. |
name | The name of the product. |
sku | The SKU of the product. |
status | The current status of the product in your store. |
visibility | The current visibility status of the product. |
price | The current price of the product. |
special_price | The current special price set on the product. |
categories | The current categories associated with the product. |
url | The current URL the product can be viewed on. |
tierPrices | Outputs an array of tier price objects, containing prices for specific customer groups. |
indexPrices | Outputs an array of index price objects, containing prices for specific customer groups. |
Tier prices
When you add tier prices using Advanced Pricing on the Magento product edit page, they’re included in the synced data.
Magento includes tier prices for all customer groups in general catalogs. For shared catalogs (B2B only), only the prices for the shared catalog’s customer group are synced.
Sync indexed product prices
You can choose to sync indexed product prices from Magento to Dotdigital. This setting controls how product prices are exported and how quickly updates appear in Dotdigital.
How indexed product prices work
Indexed prices are taken from the catalog_product_index_price database table.
For general catalogs, Magento includes prices for all customer groups.
For shared catalogs (B2B only), only the prices for the shared catalog’s customer group are included.
If you switch on indexed prices:
Magento re-syncs products whenever you create, update, or delete catalogue price rules, so storefront price updates are reflected in Dotdigital.
Catalogue sync waits until Magento finishes updating indexes with new prices for affected products. This can cause skipped syncs and longer delays before data appears in Dotdigital.
We recommend reducing your catalogue sync cadence to 5 minutes. Go to Stores > Configuration > DOTDIGITAL > Developer > Manage Cron Timings.
Additional details
Merchants with large catalogues or rules affecting many products may notice a delay between storefront price updates and those updates appearing in Dotdigital. See the Troubleshooting section below.
You should validate that the expected prices are in place before using them in email campaigns, automations, or segments.
Magento exports indexed prices to the insight data collection. If you later switch off indexed prices, the old values can remain in the insight data until you delete the collection and re-sync the catalogue.
Enable indexed product price sync
Go to Stores > Configuration > DOTDIGITAL > Configuration.
Under Catalog Sync Settings, set Sync Indexed Product Prices to Yes.
Catalog sync settings
How catalog sync works
Catalog sync runs continuously until all products in the email_catalog table are marked as ‘processed’.
Learn more in Understand continuous sync.
Magento skips invalid products, logs a message, and marks them as processed. You can retry syncing Processed products by selecting a row, or multiple rows, in the catalog report.
Sync selected products
You can choose to sync only products of a certain visibility or product type rather than all products. You can keep your catalog organised by excluding products that are no longer relevant on your site.
To sync products based on visibility or product type:
Go to Stores > Configuration > DOTDIGITAL > Configuration.
Under the heading Catalog Sync Settings, choose the Catalog Value, Catalog Visibility, and Catalog Types that you want to sync.
When finished, select Save Config.
Broken Product Images?
Try setting the Store Value to Store. This uses the store URL for the image path instead of the admin URL.
Custom attributes
In addition to our standard default product data fields, you have the option to synchronise custom product attributes. This list comprises all of the product attributes that are available within your store's system, allowing you to segment and send content based upon these too.
To choose your product custom attributes status:
Go to Stores > Configuration > DOTDIGITAL > Configuration and find the heading Transactional Data.
For Product Custom Attributes, select the attributes you want to import.
To choose multiple, press and hold the Ctrl key on your keyboard and select attributes.
Reset the sync after updating configuration
After updating the configuration for catalog sync settings, it is recommended to reset the sync. This step isn’t required, but it ensures that all data is re-synced using the updated configuration or attributes. Otherwise, only new changes reflect their updates.
Learn how to Reset the sync.
Troubleshooting
Insight data can take several minutes to be imported and show in Dotdigital even after a sync is complete. Also ensure you don’t already have catalog data imported with matching ID's, such as from a staging site, as this key must be unique.
How can I check if catalog sync is working in Magento?
To observe catalog sync activity:
Check the catalog report:
Go to Stores > Configuration > DOTDIGITAL > Sync Settings > Sync > Catalog Enabled.
Select Click here for status.
Check the connector logs: Go to Reports > Customer Engagement > Log Viewer.
Why is catalog sync enabled but nothing is displaying in Dotdigital?
This issue may occur for the following reasons:
You haven’t saved valid API credentials.
Cron isn’t running on your site.
Learn more in Magento Open Source and Adobe Commerce databases and cron services.The sync isn’t batching correctly.
Monitor the Importer Status report and check the logs for errors.
Why is catalog sync running slow?
To improve sync performance:
Reduce the number of product attributes being synced.
Experiment with a larger Transactional data batch size in Stores > Configuration > DOTDIGITAL > Developer > Import Settings.