Redo

API keyE-commerceOrg connection

Org-level connection

Redo 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

Click "Add API Client", then select the access scopes this client should carry. Grant only what you want On Belay to have — read scopes (returns_read, customers_read, orders_read, inventory_read, inbound_shipments_read, invoices_read, webhooks_read) are enough for reporting. The write scopes let On Belay process refunds and change marketing consent.

Copy the generated API secret and paste it in the API Key field below. Redo shows it once.

Copy your Store ID from the General section of the same Settings → Developer page and paste it in the Store ID field. Every Redo API path is scoped to it.

Scopes are enforced by Redo on the token itself, so a client without returns_write cannot process a return no matter what On Belay permits. You can change a client's scopes later without re-issuing the secret.

Ready to connect?

Permissions (scopes)

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

Scope	Description	Access
`returns_read`	Read returns and return tags	Read only
`returns_write`	Create, update, and PROCESS returns	Read / Write
`customers_read`	Read customer profiles	Read only
`customers_write`	Write customer profiles and consent	Read / Write
`orders_read`	Read orders and fulfillments	Read only
`orders_write`	Create/delete orders, manage fulfillments	Read / Write
`products_write`	Bulk upload products	Read / Write
`inventory_read`	Read inventory items and levels	Read only
`inbound_shipments_read`	Read inbound shipments	Read only
`invoices_read`	Read Redo invoices	Read only
`customer_events_write`	Send custom events (triggers flows)	Read / Write
`storefront_events_write`	Send storefront pixel events	Read / Write
`webhooks_read`	Read webhook subscriptions	Read only
`webhooks_write`	Manage and replay webhooks	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 Redo and update it in On Belay → Integrations → Redo → 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 →