Skip to main content
Skip table of contents


This document explains what is needed to setup access to Shopify and install the Shopify connector which uses API key authentication.

To use OAuth authentication instead, please see here for our Shopify (OAuth) connector.

Shopify set up

To authenticate the Shopify connector in Cyclr you need:

Get the hostname

Your Shopify domain contains your hostname. For example, if the Shopify domain is then the hostname is Shopify's documentation on domains can be found here.

Get an admin API access token

To get an admin API access token, you need to create a custom app within the store. For information on how to create a custom app, see Shopify's documentation. When you create a custom app, ensure that you set the correct Admin API Permissions for the webhooks your connector will use. The table below contains a list of webhooks and the required scopes:

Cyclr webhook

Shopify scopes


read_checkouts, write_checkouts


read_customers, write_customers


read_orders, write_orders


read_products, write_products



Note: This is not an exhaustive list of scopes that you can use. To see all available scopes, see the Shopify documentation on authenticated access scopes.

You can find the admin API access token in the newly created custom app under API credentials > Admin API access token. You can only view the token once before it's permanently hidden. To get a new token, you need to uninstall and reinstall the app to your store. For more information, see Shopify's documentation on rotating API credentials.

Cyclr set up

Account setup

Cyclr asks for the following values when installing the Shopify connector within an account:

  • Hostname: The hostname of the Shopify store you want to manage.

  • API Key: The admin API access token of a custom app within the store you want to manage.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.