Skip to main content

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.

Required scope: integrations:write

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

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.

Reset also removes a pasted Admin API access token (the client key and secret are kept), so the integration is unauthorized and the shop URL becomes editable.

Request​

Responses​

OK

Response Headers
    Content-Type