Once you have set up a trial subscription and obtained your credentials, you are ready to set up your CSM for BigCommerce solution. To assist you in the creation of your primary sale channel, CSM for BigCommerce includes a setup wizard that streamlines the setup process.
Caution: if your online business has multiple stores, and you want to create a separate CSM Sales Channel for each one, it is recommended that you manually set them up, one at a time. This will ensure that the credentials you established during the setup of your primary sales channel are not inadvertently overridden or deleted.
1. Obtain Business Central Tenant ID
Your Tenant ID is used to link your Business Central account to the BigCommerce API. In Business Central, click the ?/Question Mark button at top-right and then select the Help & Support link
- Scroll to the bottom of the page and you will see your Microsoft Entra tenant ID
- Consequently, you will also see your tenant ID in your URL, directly after "https://businesscentral.dynamics.com/"
- Copy this Tenant ID
2. Install the CSM for Big Commerce app on BigCommerce
Next, you need to next install the CSM for Business Central app from the BigCommerce Apps & Integrations site.
-
Point your browser to https://www.bigcommerce.com/apps/csm-for-business-central/
-
- The next screen will prompt you to confirm whether or not this is for an Existing BigCommerce store or if you are New to BigCommerce. Ideally, you already have a BigCommerce account and can Log in.
- Once you have the app installed on your BigCommerce account, click the app and then click Launch. If you get lost, you can always find your installed applications under the Apps section of the left menu.
- The next page will then request for your Business Central Tenant ID to be pasted into the corresponding field. This is the same Tenant ID that you would have just copied from Step 1. Paste it here and you should see the integration confirmed.
3. Setup Big Commerce in Business Central
- Search for CSM Setup and select the related link
- From the New ribbon, choose BigCommerce Quick Setup
- "Welcome to the BigCommerce Quick Setup Wizard." step
- This allows you to Load BigCommerce API Data and load default CSM Triggers. We recommend toggling all of the configuration toggles on and clicking Next
- "API Set Information" step
- If you toggled the "Load API Data" on the previous step, you will be prompted to specify information about the API Sets that CSM will use to communicate with Business Central.
| Field | Example Value |
|
BigCommerce API Set Code This is a unique code that identifies the API set. By default, it will be assigned a value of BIGCOMMERCE, but you can change this to a different code that is more meaningful to you, if desired. |
BIGCOMMERCE |
|
BigCommerce API Set Description This is a text description for the API set. By default, it will be assigned a value of BigCommerce API Data, but you can change this to a different description that is more meaningful to you, if desired. |
BigCommerce API Data |
|
BigCommerce Host Name This is the host URL endpoint on the BigCommerce platform. Normally it is api.bigcommerce/stores, and this default is assigned in the field. |
api.bigcommerce/stores |
|
BigCommerce Store Hash If you have just one store configured with your Business Central Tenant ID then the Store Hash will auto-populate. Important: If you have created several BigCommerce stores with the same Business Central Tenant ID, then the Store Hash field will appear empty and you will need to paste in the corresponding Store you are trying to set up. The Store Hash is the unique store ID that identifies your storefront on the BigCommerce platform. It can be obtained by logging into your BigCommerce account and clicking the Home button. In the following example, the Store Hash is the word test.
|
Obtained from the BigCommerce store's URL |
|
BigCommerce Access Token If you have correctly completed the first two steps in this setup guide, the Access Token will auto-populate. If you have multiple BigCommerce stores, you'll need to paste in the unique Store Hash above and then the Access Token will auto-populate. |
The BigCommerce API account's access token |
-
If you selected the "Load API Data for B2B" option on the first step of the setup wizard, you will now be prompted to specify information about the API Sets that CSM will use to facilitate communications between Business Central and your external channel platform for all B2B functions.
Caution: The BigCommerce B2B function is currently undergoing an update and you may need to contact support to ensure it is connected and functioning as intended.
This step will eventually be combined into just one master setup and not B2C + B2B.
| Field | Example Value |
|
B2B API Set Code This is a unique code that identifies the API set. |
BIGCOMMERCEB2B |
|
B2B API Set Description This is a text description for the API set |
BigCommerce B2B API Data |
|
B2B Host Name This is the host URL endpoint on the BigCommerce platform. Normally it is https://api- b2b.bigcommerce.com, and this default is assigned in the field. |
https://api- b2b.bigcommerce.com |
|
B2B API Key This is the identifier for an authorization token that is sent to BigCommerce as part of an API message. BigCommerce requires that this value be authToken, and this default is assigned in the field. |
X-Auth-Token |
|
B2B Access Token This is the BigCommerce API token that CSM uses to authenticate API calls. |
The BigCommerce API account’s API token |
-
-
"Sales Channel Information" step
-
| Field | Example Value |
|
Sales Channel Code This is a unique code that identifies the sales channel. |
BIGCOMMERCEB2C |
|
Sales Channel Description This is a text description of the sales channel. |
BigCommerce Retail Consumer Site |
-
-
"Press Next to Load the BigCommerce Data." step
- Choose Next to load and configure your BigCommerce channel
- Once the channel setup is complete, click Finish
-
4. Register API Function Methods / Update API Sets
The setup wizard automatically loads most of the data needed for your integration, but you must also register what are called API value processing function methods. Certain BigCommerce API functions use these methods to properly process values.
Note: This last step will eventually be automated in future BigCommerce integrations.
- Search for API Value Processing Function Methods and select the related link
- From the Processing Type dropdown at the right, select CSM Core Utility
- Click the Register action in the ribbon
- Repeat this same process by selecting the CSM BigCommerce Utility option in the Processing Type field and again choosing the Register action in the ribbon.
If you are using price lists and/or B2B with BigCommerce, Suite Engine utilizes our new API Engine for synchronizing information between Business Central and your BigCommerce environment. You must link the associated API Sets to your newly created sales channel.
- Search for API Sets and then choose the related link
- On the API Sets page, select the line for your BigCommerce APIs, choose the Related ribbon and then choose API Credentials
- On the API Credentials page, click on the listed BigCommerce API Set Code
- On the API Credential card, enter the Sales Channel Code that you just defined for your newly created sales channel (default: BIGCOMMERCEB2C and B2B default: BIGCOMMERCEB2B) in the Usage Code field
- Repeat these steps for any other new API Sets that were created by the setup
- On the API Sets page, select the line for your BigCommerce APIs, choose the Related ribbon and then choose API Credentials
Test your Connection
- Search for CSM Sales Channels and select the related link
- Click on the associated Sales Channel you just created
- From the APIs ribbon, choose the Test Channel Communication
- Click on the associated Sales Channel you just created
Note: If the test was successful, you can continue your sales channel configuration. If it failed, please search the knowledge base or contact support.
Let's begin our configuration:
➡️ Next Step: Configure your Sales Channel