Sync Square Orders
POST/api/square/orders/sync
Queue a background refresh of orders from the Square API. The job fetches orders modified since the last sync watermark (default), then promotes newly fetched orders into SKU sales orders. Progress can be tracked via the returned tracked_job_log_id.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body fields:
- integration_instance_id (integer, required) — the Square integration instance to sync.
- mode (string, optional) — one of
since_latest(default behavior; resume from the last sync watermark) orall(full re-sync from the instance's order-import start date). - date_from (date, optional) — explicit start date for the fetch window (overrides mode).
Route name: square.orders.sync
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
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.
Unprocessable Content
Response Headers
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.