To connect your BigCommerce store to Commvault, you must configure a credential with the required permissions and provide the authentication details Commvault needs to connect.
Create a BigCommerce API token
- Log in to your BigCommerce Admin Panel.
- Go to Settings > API > API Accounts > Create V2/V3 API Token.
- Use Store-level API accounts (not Account-level or Storefront API).
- Provide a name for the token (for example, "Commvault Backup").
- Assign the required scopes as shown in the table below.
- Click Save.
- BigCommerce displays a one-time Access Token and your Store Hash (a short alphanumeric string such as
ptwj8fgzwt). - Copy both the Access Token and Store Hash — you will provide these values when configuring Commvault.
Assign the required permissions
The following table shows the required BigCommerce API scopes for backup and restore operations.
| Scope | Backup permission | Restore permission | What it grants |
|---|---|---|---|
| Information & settings | Read-only | Modify | Access to store information, currencies, shipping zones |
| Products | Read-only | Modify | Access to products, categories, brands, variants, price lists |
| Customers | Read-only | Modify | Access to customer accounts and addresses |
| Orders | Read-only | Modify | Access to orders and line items |
| Themes | Read-only | Modify | Access to the active storefront theme |
| Marketing | Read-only | Modify | Access to coupons, promotions, gift certificates |
| Content | Read-only | Modify | Access to content pages, blog posts, URL redirects |
| Store Locations | Read-only | Modify | Access to store locations for inventory management |
| Store Inventory | Read-only | Modify | Access to inventory stock levels |
Note
Shipping Zones do not have a separate scope selector in the BigCommerce UI. They are covered by the Information & settings scope. Price Lists are covered by the Products scope.
Provide connection details
When configuring Commvault, you will provide the following fields:
- Store Hash: The short alphanumeric string shown in the BigCommerce API Accounts page (for example,
ptwj8fgzwt). This identifies your store. - API Access Token: The one-time token displayed when you created the API credential.
Notes and considerations
- The API access token does not expire automatically, but BigCommerce allows you to revoke it manually. Use a dedicated service account token for Commvault rather than a personal administrator token to avoid disruption if the administrator leaves your organization.
- If you plan to perform cross-store restores (restoring data from one BigCommerce store to a different store), create a second API token on the target store with Modify permission on all required scopes.
Validate permissions
After configuring the credential, run a test backup to confirm that the permissions are correct. If the backup fails with an authentication error, check the following:
- The store hash is correct and matches the BigCommerce store you intend to protect.
- The API access token is valid and has not been revoked.
- All required scopes are assigned to the token with the appropriate permission level (Read-only for backup, Modify for restore).
- The token type is Store-level V2/V3 API (not Account-level or Storefront API).