Docs

Sync

Every sync endpoint, with its scope, parameters, a request and a response.

GET /sync

Whether the latest changes are live at checkout

Any token Returns 200

Request

curl "https://app.shopbird.app/api/v1/sync" \
  -H "Authorization: Bearer sb_live_…"

Response 200

{
  "generation": 42,
  "synced_generation": 41,
  "status": "pending",
  "last_synced_at": "2026-11-01T09:00:00.000Z",
  "last_error": null,
  "retry_at": null
}
POST /sync

Push the shop's locks to Shopify now (Locksmith's install)

Scope sync:write Returns 202

ParameterInTypeDescription
wait query string true to wait up to 20 s for the sync to finish
dry_run query true true: validate and return the would-be result; nothing is saved
wait query true true: wait up to 20 s until the change is live at checkout
Idempotency-Key header string Retrying with the same key never applies the write twice (kept 24 h)

Request

curl -X POST "https://app.shopbird.app/api/v1/sync" \
  -H "Authorization: Bearer sb_live_…"

Response 202

{
  "sync": {
    "generation": 42,
    "status": "pending"
  }
}