Skip to main content

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.

Required scope: integrations:write

Grant 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​

Accepted

Response Headers
    Content-Type