Skip to main content

Update Provider Cutover Plan

PUT 

/api/integration-instances/:integration_instance/cutover

Saves the cutover plan and sets the status to planned. Re-planning after a completed cutover starts a new one (the old one stays in history).

Required scope: integrations:write

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

Body:

  • sales_channel_id (integer, required) — the sales channel being cut over
  • planned_at (date-time UTC, required)
  • owner_user_id (integer, optional)
  • boundary_at (date-time UTC, optional; send null to clear, omit to keep) — orders placed before it stay with the provider's own integration
  • boundary_order_number (string, optional) — informational: the latest provider-imported order at the boundary

Errors: 422 for validation errors, an unknown sales channel, or a cutover already in progress (cancel it to change the plan or boundary).

Returns the full cutover state (see Get Provider Cutover).

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

Request​

Responses​

OK

Response Headers
    Content-Type