Preview Provider Cutover
GET/api/integration-instances/:integration_instance/cutover/preview
Dry run: every open, not-yet-sent fulfillment order on the cutover's sales channel routed to this provider, with the outcome the cutover would produce. Nothing is written.
integrations:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Outcomes: stays_with_provider_link (before the boundary, the provider's own order exists — will link), stays_with_provider_waiting (before the boundary, waiting for the provider's order to appear), sku_will_send (after the boundary, no match), held_possible_duplicate (after the boundary, the provider already holds an order with the same number), blocked (outbound order sync off, warehouse not mapped, or unmapped order lines — see blocked_reason).
Standard pagination (default 10 per page, max 100), newest order first. meta.outcome_counts gives the count per outcome across all pages.
Errors: 422 when no sales channel is planned or filter[outcome] is invalid.
Required permission: integrations.show. A token also needs its integrations scope.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.