Sync Provider Orders
POST/api/integration-instances/:integration_instance/cutover/sync-orders
"Sync now" on the Cutover tab: queues the provider's own order sync (the same tracked job its Orders page runs) so orders the provider imported from its own store integration reach the provider order index without waiting for the scheduled sync. Once the disconnect is confirmed, the sync asks the provider for orders since the disconnect minus a 24-hour overlap (where the provider's sync takes a window) and the request time is recorded as disconnect.sync_requested_at, so the tab can show the sync running and, once it completes, the advisory order_sync_after_quiet_period checklist line. Advisory only: no sync is required to start. No body. Re-read the cutover state and preview after the sync has run (usually under a minute); the cutover state's can_sync_orders says whether the provider supports this.
integrations:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Returns 202 {data: {queued: true}}.
Errors: 422 when the provider cannot sync orders (can_sync_orders: false) or the integration is not a shipping provider.
Required permission: integrations.update. A token also needs its integrations scope.
Request
Responses
- 202
- 401
- 403
- 404
- 422
- 429
Accepted
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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.