Documentation

Master / Follower Model

StoreSync Hub uses a hub-and-spoke architecture. One store acts as the Master (source of truth), and all other stores are Followers that receive data from the master.

• Data flows one direction only: Master → Followers.
• Changes on follower stores are not synced back to the master.
• Each connection group has exactly one master and unlimited followers.
• Stores are connected via a shared Connection ID.

How Sync Works

1. A change occurs on the master store (product created, inventory updated, etc.).
2. Shopify fires a webhook to StoreSync Hub.
3. The app loads sync settings, rules, and exclusions.
4. If the product passes all filters, data is transformed per rules.
5. The change is pushed to each connected follower store via the Shopify Admin API.
6. The result (success/failure) is logged to the sync history.

Supported Webhooks

• products/create — New product created on master → created on all followers.
• products/update — Product modified on master → updated on all followers.
• products/delete — Product deleted on master → deleted on all followers.

Sync Entity

Products are matched between stores using either:

• SKU (default) — Matches variants by SKU across stores.
• Barcode — Matches variants by barcode across stores.

If a product exists on the follower (matched by sync entity), it is updated. Otherwise, a new product is created.

Field-Level Control

Each product field can be configured independently:

• Every Update — Field is synced on every product change.
• Upon Creation Only — Field is set when the product is first created, then never updated.
• Never — Field is never synced; the follower store value is preserved.

Available Fields

Title, Description, Handle, Product type, Vendor, Images, Tags, Page title (SEO), Meta description (SEO), Variant price, Compare-at price, Cost per item, Variant weight, Fulfillment service, Shipping required, Taxable, Track inventory, Continue selling when out of stock, Publish status, Metafields.

Real-time Updates

Inventory changes on the master store trigger the inventory_levels/update webhook. StoreSync Hub matches the variant by SKU or barcode and updates the corresponding inventory level on each follower store.

Location Mapping Strategies

• Default: Uses the first location of each store. Simplest setup.
• Name: Matches locations by name. Requires consistent naming across stores (e.g., "Warehouse A").
• Custom: Manually map specific locations between master and follower stores.

Quantity Types

The following inventory quantity types are synced:

• available — Available for sale
• quality_control — Under quality inspection
• damaged — Damaged goods
• safety_stock — Reserved safety stock

Safety Net

An optional daily job that compares inventory across all connected stores and fixes discrepancies. Two resolution modes are available:

• Main Store: All followers match the master store quantities.
• Minimal Level: All stores are set to the lowest quantity found across the connection.

Supported Operations

• collections/update — Collection metadata and membership synced to followers.
• collections/delete — Collection deleted from all followers.

Syncable Fields

Title, Description, Image, Sort order, SEO page title, SEO meta description, Metafields, Collection rules/conditions, Product membership (collects).

Rule Types

• Filter: Evaluate conditions and skip the product if all conditions match.
• Transform: Evaluate conditions and modify data if all conditions match.

Conditions

Available condition fields:

• Product-level: Title, Type, Vendor, Tags, Status, Handle
• Variant-level: Price, Compare-at price, SKU, Barcode, Weight, Inventory quantity

Operators: equals, not_equals, contains, not_contains, greater_than, less_than, starts_with, ends_with, is_empty, is_not_empty, in, not_in.

Actions

• Skip sync — Block the product from syncing (filter rules).
• Set value — Override a field with a specific value.
• Multiply field — Multiply a numeric field (e.g., price × 1.10).
• Add to field — Add a value to a numeric field (e.g., price + 5).
• Prefix / Suffix — Add text before or after a field value.
• Replace text — Find and replace text within a field.
• Append tag — Add a tag to the product.
• Remove tag — Remove a specific tag.
• Set status — Set the product status (active/draft/archived).

Execution

Rules are executed in priority order (lowest number first). Rules can be scoped to: All operations, Create only, or Update only. Each rule can be individually enabled or disabled.

Tag-based exclusion system for fine-grained control:

• Product Sync Exclusions: Products with any of the configured tags will be completely excluded from product sync (create, update, delete).
• Inventory Sync Exclusions: Products with any of the configured tags will be excluded from inventory sync, even if product sync is active.

Exclusion tags are checked on the master store product before sync begins.

Analytics

• Total syncs, success count, failure count, and success rate for last 24 hours and 7 days.
• Breakdown by sync type: product create/update/delete, inventory update, collection update/delete.

Sync History

Every sync operation is logged with:

• Timestamp, sync type, status (success/failed/skipped)
• Product name, source store, destination store
• Duration in milliseconds
• Error message (if failed)

Filter the history by type and status. Sync logs are retained for 30 days.

StoreSync Hub requires the following Shopify API scopes:

• read_locations — Read inventory location data for mapping.
• write_inventory — Update inventory levels on follower stores.
• write_products — Create, update, and delete products on follower stores.
• write_product_listings — Manage product publishing status.
• read_product_listings — Read product publishing information.
• write_publications — Manage sales channel publications.
• read_metaobjects / write_metaobjects — Sync metafields and metaobject references.
• read_metaobject_definitions / write_metaobject_definitions — Manage metaobject schema for syncing.