Skip to main content

Get Provider Cutover

GET 

/api/integration-instances/:integration_instance/cutover

Gets the provider cutover for a shipping-provider integration: switching one sales channel from the provider's own store integration to SKU.io dispatch, without any order going to the provider twice or not at all.

Required scope: integrations:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Response (data): status (not_started|planned|in_progress|complete); sales_channel, planned_at, owner, boundary_at, boundary_order_number; suggested_boundary (the newest order the provider imported from its own integration); native_orders {count, latest}; disconnect {confirmed_at, foreign_orders_since_confirm, latest_since_confirm, quiet_minutes, quiet_until, state: pending|quiet|still_importing|awaiting_sync, instructions, sync_status_available, last_order_sync_at, sync_requested_at, sync_running, requires_acknowledgement} — still_importing as soon as the provider receives an order from its own integration after the confirmation (judged on when the provider received it, not when it was placed); otherwise the provider's sync interval/import delay plus a 15-minute margin must pass. When the provider reports its order syncs (sync_status_available) it is quiet only once a Sync Provider Orders requested at or after quiet_until (sync_requested_at) has completed (last_order_sync_at after it; awaiting_sync until then, with sync_running true while that sync runs); otherwise the check is time-based and requires_acknowledgement is true, so Start also needs acknowledge_native_import; checklist[] {key, passed, blocking, message, acknowledgeable} with keys native_import_stopped, boundary_set, no_blocked_orders, outbound_orders_sync_on, auto_dispatch_enabled (blocking) and inventory_sync_to_channel, tracking_push_to_channel (advisory); can_start; can_sync_orders (the provider can queue its own order sync, used by Sync Provider Orders); guard {available, on_strong_match: hold|link} — available: false means the provider has no order sync, so duplicate protection is off and the cutover is checklist-only; peak_window_warning and peak_window {starts_at, ends_at} (default: 7 days before Black Friday through Cyber Monday); monitor (in progress only) {pre_boundary_waiting, awaiting_native_order, linked, linked_shipped, duplicate_holds, sku_sent, sku_shipped}; complete_suggested (in progress 14+ days); history[] of completed/cancelled cutovers.

Returns 422 for an integration that is not a shipping provider.

Required permission: integrations.show. A token also needs its integrations scope.

Request​

Responses​

OK

Response Headers
    Content-Type