BigCommerce Quick Setup Wizard
Once you have set up a trial subscription and obtained the necessary credentials from BigCommerce, you are ready to set up your BigCommerce sales channel in Business Central. To expedite this process, CSM includes a setup wizard.
- From the CSM Role Center or by using the looking glass, find the CSM Setup page
- From the Actions ribbon, choose the BigCommerce Quick Setup action to launch the BigCommerce setup wizard.
- On the first page of the wizard, it is recommended you enable all presented setup options for loading CSM triggers and BigCommerce API Data, as well as creating a new sales channel in Business Central. Choose Next
- On the second page of the wizard, you can specify information about the API set you are using to facilitate communications between Business Central and your external channel platform. For more information on how to retrieve this information, choose the How to obtain credentials button.
| Field | Description | 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 | Enter the unique store ID that identifies your storefront on the BigCommerce platform. It can be obtained by reviewing your store’s URL and locating the value that follows the host name. For example, if your store’s URL is api/bigcommerce/stores/123456, the store hash would be 123456. | Obtained from the BigCommerce store's URL |
| BigCommerce Access Token | This is the BigCommerce access token that CSM uses to authenticate API calls. | The BigCommerce API account's access token |
If you selected the Load BigCommerce API Data for B2B option on the first page of the setup wizard, you will now be prompted to specify information about the API sets CSM will use to facilitate communications between Business Central and your external channel platform for B2B activities.
In order to properly integrate B2B functionality with Business Central, it is necessary to utilize elements of BigCommerce’s version 2 and version 3 APIs. Accordingly, you must create two separate B2B API sets, one for each version. The table below describes how to enter information in the version 2 setup fields but should also be used for the version 3 setup, as well.
| Field | Description | Example Value |
| BigCommerce B2B V2 API Set Code | This is a unique code that identifies the API set. | BIGCOMMERCEB2B_V2 |
| BigCommerce B2B V2 API Set Description | This is a text description for the API set | BigCommerce B2B Edition - Storefront APIs V2 |
| BigCommerce B2B V2 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 |
| BigCommerce B2B V2 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. |
authToken |
| BigCommerce B2B V2 Access Token | This is the BigCommerce API token that CSM uses to authenticate API calls. |
The BigCommerce API account’s API token |
| BigCommerce B2B V3 API Set Code | This is a unique code that identifies the API set. | BIGCOMMERCEB2B_V3 |
| BigCommerce B2B V3 API Description | This is a text description for the API set | BigCommerce B2B Edition - Storefront APIs V3 |
| BigCommerce B2B V3 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 |
| BigCommerce B2B V3 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. |
authToken |
| BigCommerce B2B V3 Access Token | This is the BigCommerce API token that CSM uses to authenticate API calls. |
The BigCommerce API account’s API token |
- If you selected to Create Sales Channel on the first page of the setup wizard, you will now be prompted to specify identifying information for the new BigCommerce sales channel.
- Enter a unique code and description for this sales channel and choose Next
- The last page of the wizard is a confirmation page. Choose the Next button to instruct CSM to load and configure BigCommerce channel. You can choose the Back button if you need to make changes to any entered settings.
- Choose the Finish button when the process is completed to close the wizard.
The setup wizard automatically loads most of the data needed for your CSM integration, but you must manually register what are called “API value processing function methods.” Certain API functions use these methods to properly process values.
- Search Business Central for API Value Processing Function Methods and choose the related option
- From the Processing Type dropdown, select CSM Core Utility
- Choose the Register action
- A number of methods will be automatically loaded into the lines on the page.
- Repeat the process for CSM’s BigCommerce extension by selecting the CSM BigCommerce Utility option in the Processing Type field, then choosing the Register action in the ribbon.
If you are using price lists and/or B2B with BigCommerce, Suite Engine utilizes the 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:
- Use the looking glass to search for API Sets, and then choose the related option
Note: there is a separate CSM API Sets page that you do not need to open in order to complete this task. Be certain to choose API Sets, not CSM API Sets.
- On the API Sets page, select the line for your BigCommerce APIs, choose the Related ribbon, then choose API Credentials.
- On the API Credentials page, from the Manage ribbon, choose Edit
- On the API Credential card, enter the code that you defined for your newly created sales channel in the Usage Code field.
- Return to the CSM API Sets page and repeat steps 2-4 for any other new API sets that were created by the setup