Shopify (Admin API)
Org-level connection
Shopify (Admin API) is connected once at the org level by an admin. The credential is shared across all groups that have been granted access — individual team members don't need to connect their own accounts.
Getting your API key
In your Shopify admin, go to Settings → Apps and sales channels → Develop apps
Create a new app, configure Admin API access scopes
Install the app and copy the Admin API access token
Enter your shop domain and paste the token below
Ready to connect?
Go directly to the integrations page in your dashboard.
Permissions (scopes)
These are the data scopes On Belay can be granted for Shopify (Admin API). Your org admin controls which scopes are enabled per group.
| Scope | Description | Access |
|---|---|---|
read_analytics | Read analytics | Read only |
read_customers | Read customers | Read only |
write_customers | Write customers | Read / Write |
read_inventory | Read inventory | Read only |
write_inventory | Write inventory | Read / Write |
read_metaobjects | Read metaobjects | Read only |
write_metaobjects | Write metaobjects | Read / Write |
read_orders | Read orders | Read only |
write_orders | Write orders | Read / Write |
read_products | Read products | Read only |
write_products | Write products | Read / Write |
read_content | Read content | Read only |
write_content | Write content | Read / Write |
write_theme_code | Write theme code | Read / Write |
read_themes | Read themes | Read only |
write_themes | Write themes | Read / Write |
Troubleshooting
"Invalid API key" or "Unauthorized" error
Double-check that you copied the full key without any leading/trailing spaces. Some platforms show a truncated preview — make sure to copy the full token. If the key was generated with restricted scopes, verify it includes the permissions listed above.
Connected but Claude can't access data
Check that your group has been granted access to this integration in On Belay → Groups → [your group] → Integrations. Also verify the specific scopes your group is permitted to use match what your query requires.
The key expires or stops working
Some API keys have expiration policies. Generate a new key in Shopify (Admin API) and update it in On Belay → Integrations → Shopify (Admin API) → Update key. Consider creating a dedicated service account or machine user for On Belay so the key isn't tied to a personal account.
Still stuck? We're happy to help.
Contact support →