Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt

Use this file to discover all available pages before exploring further.

After the initial sync completes and webhooks start flowing, day-to-day operations come down to four actions: reading per-entity status, running health checks, retrying a failed entity, and running a full re-sync. Plus the four integration statuses you’ll see on the store card.

​
The four integration statuses

Every connected Shopify store carries one of four statuses, shown as a coloured badge on the store card:
StatusColourMeaningTypical action
ConnectedGreenOAuth valid, syncs running on scheduleNone. Healthy.
DisconnectedGreyManually paused. Data preserved, sync stopped.Reconnect when ready.
ErrorRedHealth check failed or sync erroredDrill into details, fix, re-test.
Reconnect requiredAmberOAuth needs re-authorisation (uninstall, scope change)Reconnect from the card menu.
Statuses update as syncs run and health checks complete. Resolving the underlying cause and seeing one successful sync flips status back to Connected automatically.

​
Per-entity sync status

Open Sync settings from the store card menu and look at the Sync status section. Each entity (Customers, Orders, Products, Collections) shows one of four states:
StateMeaning
PendingQueued for sync but not started yet
SyncingCurrently importing
SyncedLatest sync completed successfully
FailedSync ran into an error
Entities that have completed at least one sync show a Last synced timestamp. Once the initial sync is done, real-time webhooks keep data current. The Last synced timestamp reflects the most recent bulk sync, not the latest webhook.

​
Run a health check

Health checks are on-demand. Use them when you suspect an issue or want a fresh readiness reading.
1

Open the store card menu

Inside the project, open Integrations and find the store card. Use the card menu to pick Check health.
2

Wait for the result

The menu item changes to Checking… while the check runs. It typically completes within seconds.
3

Read the result

The check returns either Health check completed (all five readiness items pass) or Health check failed (one or more failed). Open View details for the specific item that failed.
The four checks the system runs:
  • OAuth connected: the OAuth grant is still valid.
  • Token not expired: access token hasn’t passed its expiry.
  • All scopes granted: every required scope is in place.
  • API credentials valid: a test call to Shopify succeeds.
See Store details and readiness for what each failure means and how to fix it.

​
Retry a failed entity

When one entity (say, Orders) shows Failed but the rest are Synced, the cleanest fix is a per-entity retry.
1

Open Sync settings

Use the store card menu to pick Sync settings.
2

Find the failed entity

The entity row in the Sync status section shows the Failed state and a Retry action.
3

Retry

Choose Retry. Spotzee re-attempts the sync for just that entity. Other entities keep their existing state.
Retry as many times as you need. Spotzee deduplicates by Shopify IDs, so repeated retries don’t create duplicate customers, orders, or products.

​
Run a full re-sync

A full re-sync re-runs the bulk import for every enabled entity. Use it when:
  • Multiple entities failed.
  • You suspect the data has drifted (after a connection issue, after toggling settings dramatically).
  • You changed sync settings and want them fully applied to historical records.
1

Open Sync settings

Use the store card menu to pick Sync settings.
2

Choose Re-sync

Pick Re-sync. You’ll see a “Sync rerun started” confirmation.
3

Wait for completion

The bulk import processes each enabled entity in turn. Time depends on store size. Watch the per-entity statuses to track progress.
Re-sync is safe to run repeatedly. Records match by Shopify ID, so existing customers, orders, and products are updated rather than duplicated.

​
Pause and resume

To pause syncing without losing configuration, disconnect the store from the card menu. Status flips to Disconnected. To resume, reconnect. If you need to remove the integration entirely (with data deletion), use Delete instead of Disconnect. See Disconnect, delete, reconnect for the differences.

​
Next steps

Store details

The five-item readiness checklist and what each failure means.

Disconnect, delete, reconnect

The three actions, their outcomes, and when to use each.

Troubleshoot

Diagnose stuck syncs, missing data, and failed entities.

Sync settings

Toggle data categories on or off.