ShopMy

API keyCRM & MarketingOrg connection

Org-level connection

ShopMy 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 ShopMy, go to Account Settings → Tokens and generate your Brand Partner Token.

Paste the Brand Partner Token below.

(Optional) To use creator endpoints (collections, links, profile, catalog search), paste your token as "partnerToken|accessToken" — your Brand Partner Token, a pipe, then your creator access token.

Enter your brand domain (used for order reports), e.g. yourbrand.com — no https:// or trailing slash.

Ready to connect?

Permissions (scopes)

These are the data scopes On Belay can be granted for ShopMy. Your org admin controls which scopes are enabled per group.

Scope	Description	Access
`order_report`	Affiliate order report	Read only
`read_collections`	Read collections	Read only
`write_collections`	Create / edit collections	Read / Write
`read_links`	Read links	Read only
`read_profile`	Read creator profile	Read only
`search_catalog`	Search product catalog	Read only

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 ShopMy and update it in On Belay → Integrations → ShopMy → 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 →