Magento / Adobe Commerce

API keyE-commerceOrg connection

Org-level connection

Magento / Adobe Commerce 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

Enter your Magento Store URL in the field above — use the exact domain you log in to Magento admin with (e.g. https://store.com).

Enable the standalone Bearer-token flag: in Magento admin go to Stores → Configuration → Services → OAuth, set "Allow OAuth Access Tokens to be used as standalone Bearer tokens" to Yes, and click Save Config. (Magento 2.4.4+ rejects every API call with a 401 until this is on — it is the #1 install failure.)

Flush the Magento cache: go to System → Cache Management and click "Flush Magento Cache". The Bearer-token flag does not take effect until you do this.

In Magento admin go to System → Extensions → Integrations → Add New Integration, and name it "On Belay".

On the Integration's API tab, set "Resource Access" to Custom — this reveals the resource tree (it stays hidden while Resource Access is set to All).

In the revealed resource tree, check the top-level Sales, Catalog, and Customers boxes (each one grants its whole subtree), then expand Stores and check Settings.

Click Save to save the Integration.

On the Integrations list, click Activate on the "On Belay" row — a popup opens listing the permissions you granted.

In that popup, click Allow — the next screen shows your four integration values.

Magento shows four values — Consumer Key, Consumer Secret, Access Token, and Access Token Verifier. Copy only the Access Token. Do not copy the Access Token Verifier below it.

Paste the Access Token into the field below and click Connect.

You may see an "Integration not secure" badge in Magento — that is cosmetic and expected; On Belay does not need the callback or identity URLs.

Ready to connect?

Sign in to On Belay and open the Integrations page to add Magento / Adobe Commerce.

Sign in →

Permissions (scopes)

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

ScopeDescriptionAccess
orders:readRead ordersRead only
orders:writeCreate, hold, cancel, invoice, ship, and refund ordersRead / Write
products:readRead products and attributesRead only
products:writeCreate, update, and delete products and mediaRead / Write
categories:readRead categoriesRead only
categories:writeCreate, update, delete, and assign categoriesRead / Write
inventory:readRead inventory sources, stocks, and source items (MSI)Read only
inventory:writeManage inventory sources, stocks, and source items (MSI)Read / Write
customers:readRead customersRead only
customers:writeCreate, update, and delete customersRead / Write
invoices:readRead invoicesRead only
invoices:writeCapture, void, and email invoicesRead / Write
shipments:readRead shipmentsRead only
shipments:writeAdd and remove shipment trackingRead / Write
creditmemos:readRead credit memosRead only
creditmemos:writeCreate credit memos and commentsRead / Write
carts:readRead admin carts / quotesRead only
carts:writeManage admin carts and convert to ordersRead / Write
store:readRead store websites, views, config, currencies, and tax ratesRead 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 Magento / Adobe Commerce and update it in On Belay → Integrations → Magento / Adobe Commerce → 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 →