Sync (locations + catalog + orders)

POST 
/api/square/instances/:squareIntegrationInstance/sync

Dispatches a background sync job for the instance. Returns immediately with a tracked_job_log_id.

Body:

• scope (optional) — all (default), locations, catalog, or orders
• start_at (optional, ISO 8601) — override the watermark for the orders phase

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.