Skip to main content

Add a sync task

A sync task links a name to an ERP endpoint within a sync group.

N
Written by Niyaz

A sync task links a name to an ERP endpoint within a sync group. Add it from the Sync tasks tab of the group. The task runs on the schedule of its parent group, not on a schedule of its own.

Before you begin

  • The sync group that will own the task must already exist. If it does not, create a sync group first.

  • Each row in the Sync tasks list has an Execute button. Execute runs that task immediately, with no confirmation prompt. Select it only when you intend to trigger a live sync right away.

Steps

  1. In the navigation, select Sync. Open the sync group you want to add the task to.

  2. In the group, select the Sync tasks tab.

  3. Select ADD SYNC TASK. A form opens. On the empty form, Save is unavailable.

  4. In Name, enter a name for the task. The field is required.

  5. In Erp endpoint, select an endpoint. The field is required. The endpoint you choose is the one the task calls.

  6. Optional: Select Open. Use it to inspect the selected endpoint.

  7. Set Enabled on or off. Match it to whether the task should be active.

  8. Optional: Turn on Invalidate storefront cache after sync for tasks that sync catalog data shown on product pages, such as products, categories, brands and collections. Leave it off for customers, orders, prices and stock.

  9. Optional: In Page size, enter a number. Leave the field empty to use the default of 200. Lower the value if the task hits an ERP idle timeout.

  10. Select Save. Save becomes available after you change field values.

Add sync task form with Name, Erp endpoint, Enabled, cache invalidation and Page size fields, and Save unavailable

Result

The new task appears in the sync group's Sync tasks list. It runs automatically on the parent group's schedule.

Related

Did this answer your question?