Monitoring a Sync

Learn how to monitor a sync's progress and review detailed logs

Use the Sync Health page in the Codat Portal to monitor the status of your syncs and review detailed logs and error messages. This helps your support team to resolve common issues with the merchant settings or actions.

Navigate to Products > Sync for Commerce in the Codat Portal to view the Health page:

  • Check the dashboard (1) for a visual summary of sync totals.
  • Use the search bar (2) to narrow down the records by sync Id or company Id.
  • Display the sync history for a specific period by indicating a date range (3).
  • Review the possible statuses of the syncs and filter the records by their status code (4).
  • Use the menu (6) to sort and amend the sync history (5) table as needed.
Key elements of the Sync Health page

Key elements of the Sync Health page

For further detail, click a record in your sync history. The view provides sync start and end times, and sync source and target platforms. It also displays client-friendly notes and error messages in case of sync failures. Refer to our troubleshooting guide for recommendations on how to resolve these.

You can also navigate to the Config tab to view and download the merchant's sync configuration.

Detailed view of a sync log entry with Summary and Config tabs

Detailed view of a sync log entry

Sync history for merchants

Your merchants can check their own sync history and sync status in the Sync Flow. For each sync, the merchant can check the sync date range and its status.

Pitfalls

  • Syncs are shown as failed if any of the included items fail to push. Therefore, if a sync contains a mix of failed and successfully pushed records, it will still be marked as failed.
  • If a sync log record shows a "Please reconcile manually" note for an order, this is likely because an updated order does not have a matching original order in the platform. Therefore, Sync is unable to reconcile it, and this needs to be performed manually.
  • Sync history does not currently display the date range for data pulled from the commerce platform that is used in the sync.