This guide explains how to connect BigCommerce to HexaSync Automation Engine for a BigCommerce store with a store-level API account. HexaSync reads the inventory of each SKU in each of the store’s warehouses. The guide applies when you connect for the first time or need to re-authorize a Connector App that is in use.
Before you start
- A Beehexa account to sign in to HexaSync Automation Engine. If you do not have one yet, sign up on the same page.
- A BigCommerce account with store owner access or permission to create API accounts in BigCommerce.
- The API Path and Access token of the API account. BigCommerce shows the Access token only once, so store the token in a safe place, such as a password manager.
Note: In HexaSync, a Connector App is the app that connects to BigCommerce. HexaSync only reads store data. The only action other than reading inventory data is registering webhooks on BigCommerce to capture inventory changes in real time.
Part 1: Authorize the BigCommerce connection on HexaSync
Step 1: Create an API account in BigCommerce
- Sign in to the BigCommerce Control Panel.
- Go to Settings > Store-level API accounts and select Create API account.
- Keep Token type as V2/V3 API token. In the Name field, enter
HexaSync. - Copy the API Path shown right below the Name field and save it. The API Path looks like
https://api.bigcommerce.com/stores/abc123xyz/v3/. - In OAuth scopes, select read-only access for Information & settings, Products and Store Inventory. Leave the other items as None, then select Save.
- In the BigCommerce API credentials dialog, copy and save the Access token, then select Done.
Note: HexaSync does not need the Client ID and Client secret.
Note: The API Path is not in the BigCommerce API credentials dialog that appears after you select Save, so copy the API Path before you select Save. If you missed it, you can delete the old API account and create a new API account with the same permissions to get a new API Path and Access token.
Step 2: Sign in to HexaSync
- Sign in to HexaSync Automation Engine with your Beehexa account.
Step 3: Start the BigCommerce connection
- Open the BigCommerce connection setup page on HexaSync.
- On the Check connection details screen, select Connect in the BigCommerce row.
Step 4: Enter the store details
- Paste the API Path and Access token you saved in Step 1, then select Continue.
- HexaSync checks the token against the store and stores the token in encrypted form. If an error appears, see Part 4.
- When HexaSync shows Your BigCommerce Store Is Connected, select Continue. You do not need to create webhooks yourself; HexaSync registers the webhooks when the Connector App runs.
- When BigCommerce shows the status Connected, select Create BigCommerce Connector.
Step 5: Name the BigCommerce Connector App
- On the Enter Connector App Name screen, HexaSync suggests a name based on the store name, for example
[Acme Outdoor] BigCommerce Connector. Edit the name if needed. - Check the text in the Description field, then select Continue.
- Setting up the Connector App takes a few minutes. Stay on the page during this time.
Step 6: Finish the BigCommerce Connector App
After the setup, HexaSync opens the BigCommerce Connector App you just created. The Connector App has two tasks:
- Inventory Levels: retrieves the inventory of each SKU in each warehouse.
- Webhook Registration: registers webhooks on the store to receive inventory changes.
Next, check the connection status and the data by following Part 3.
Part 2: Re-authorize the BigCommerce connection
Re-authorize when the old API account has been deleted, the Access token has been exposed, or the Inventory Levels task reports an authentication error.
Note: Update the connection row that is in use. Do not create a new Connector App to fix an access error.
Step 1: Create a new API account if needed
- If the old API account has been deleted or the Access token has been exposed, delete the old API account in BigCommerce if it still exists, then create a new API account by following Step 1 in Part 1.
- If you only need to re-authorize a token that is still valid, use the existing API Path and Access token.
Step 2: Open the Connector App Settings
- Open Connector Apps and select the matching BigCommerce Connector App. Select Settings > Integration Apps & Credentials.
Step 3: Select Re-authorize
- In the BigCommerce row, select Re-authorize.
- Enter the API Path and Access token you want to use, then select Continue.
Step 4: Confirm the connection
- Check that the credential has the status Connected and that the data keeps updating, by following Part 3.
Part 3: Check the connection and data
Check the credential
- Open Connector Apps and select the BigCommerce Connector App you just created.
- Open Settings > Integration Apps & Credentials.
- Check that the BigCommerce credential has the status Connected and that the Connector App has been created.
Check the data
- Open the Inventory Levels task and check that the first run retrieved the inventory of all SKUs.
- Compare the quantity of a few SKUs in each warehouse with the data in BigCommerce.
- Inventory is read again every hour. The Webhook Registration task can take up to 15 minutes to register the webhooks on the store. After the registration succeeds, inventory changes are sent to HexaSync as soon as they happen.
If there are no real-time updates, inventory data is still read again every hour. See how to fix this in Part 4.
Part 4: Common errors and how to fix them
| Message | Possible cause | How to fix |
|---|---|---|
| HexaSync Could Not Verify Your BigCommerce Token | The API Path and Access token do not belong to the same API account, or the API account is no longer in the Store-level API accounts list. | Check that the API Path and Access token belong to the same valid API account. If needed, create a new API account, save the new API Path and Access token, then go back to HexaSync, select Fix my store details and try again, enter the details again and continue. |
| The Connector App name shows the store hash instead of the store name | The API account does not have the Information & settings permission. | Grant read-only access to Information & settings, then connect again. You can continue without this permission; the other functions still work. |
| Your Store Is Connected Without Real-Time Updates | Real-time updates are not turned on for the connection yet. | Select Continue. Inventory is still updated every hour. Send a screenshot of the message to support@beehexa.com to get help turning on real-time updates. |
| The name already exists | The Connector App name is already in use. | Choose a different name for the Connector App. |
| Connector App Quota Reached | The account has reached its Connector App limit. | Contact support@beehexa.com to get help raising the limit. |
For other cases, send a screenshot (with confidential information hidden) to support@beehexa.com.
Part 5: Protect your details and stop the connection
Paste the Access token directly on the HexaSync authorization screen. Do not put the token in chat groups, regular email or error screenshots. Anyone who has the token can read the store data.
To stop the connection:
- Ask Beehexa to turn off the schedules and disconnect in HexaSync.
- Delete the HexaSync API account in Store-level API accounts in BigCommerce.
Note: Turning off the schedules does not mean access has been revoked. Stopping the connection does not delete the data that has already been retrieved into HexaSync.
Part 6: Information to send Beehexa when you need support
- The store hash (the part between
/stores/and/v3/in the API Path), the store name, the Connector App name and the connection type: BigCommerce. - The step you were on, when the error happened, the error message and the Technical details if available.
- Recent changes to the API account or permissions in BigCommerce.
Screenshots must hide the Access token, Client secret and confidential data. Contact the Beehexa contact who supports your business, or support@beehexa.com.
See also: the Beehexa Privacy Policy and the Beehexa Support Policy.
Part 7: Frequently asked questions
Does HexaSync write or change data on BigCommerce?
No. The BigCommerce Connector App only reads inventory, products and store information, and does not write or change data on BigCommerce. The only thing HexaSync creates on BigCommerce is its own webhooks to receive inventory changes.
How do I connect BigCommerce on HexaSync?
Create a store-level API account in BigCommerce with read-only permissions by following Step 1 in Part 1, paste the API Path and Access token into HexaSync, name the Connector App, then open the Connector App to check it.
Where do I get the API Path?
On the Create API account (Store-level API accounts) screen in BigCommerce, right below the Name field. The API Path is not in the BigCommerce API credentials dialog that appears after you select Save, so copy the API Path before you select Save. If you missed it, you can delete the old API account and create a new API account with the same permissions to get a new API Path and Access token.
How often is the data updated?
Inventory is read again every hour. Once the webhooks are registered, each inventory change is updated right away.
What if I lose the Access token?
BigCommerce shows the Access token only once. Delete the old API account, create a new API account, then re-authorize by following Part 2.