Reset Connection
POST/api/shopify/:integrationInstance/reset-connection
Drops the stored Shopify authorization for an integration instance so it can be authorized again — against the same store or a different one.
Authentication: Requires Bearer token and the integrations.update permission.
Path params:
- integrationInstance (int, required): the integration instance id.
Effects:
- The stored access token is discarded and sync_status is set to Inactive, so nothing keeps calling Shopify with a token the merchant is replacing.
- Everything else is preserved: connection settings, product and warehouse mappings, field mappings and imported orders all survive. This is a re-handshake, not a teardown.
- The shop address becomes editable again (see the shop URL lock on the update endpoint).
Typical use: an integration was connected to the wrong store, or the merchant needs to re-grant scopes.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.