Configuration set up

#Connector's functionalities

Now that you are aware of the V1 Akeneo BigCommerce connector features let us help you set up and effectively use your Connector.

Please be aware that in order to access your Akeneo BigCommerce connector you need to log-in to your PIM ahead of time. We use the PIM's authentification cookie to verify your access eligibility.

#Set up your PIM credentials

Configuration page

To set up correctly your Configuration page in the BigCommerce connector, you will need to create a new connection in your PIM to allow a data flow from the PIM to Connector.

To do so, please follow the steps below:

  1. Open your PIM
  2. Go to Connect >> Connection settings >> Create
  3. Create a new data destination entry. Please make sure to change a flow type into Data destination. PIM connections
  4. Save your changes
  5. Then you will be able to retrieve the credentials to set your Connector.
  • Please make sure to update your permissions accordingly (e.g. Role: Administrator; Group: It Support)
  • Please make sure to back up your connection password as it will not remain visible after quitting settings page.

PIM connection settings

Once you have your Credentials, you can fill them in on the Configuration page:

Connector REST API

When saving your credentials by clicking on the "SAVE" button, your API connection will be tested to confirm that the linking could have been established. You will see the indication displayed in green or red depending on the state of the connection.

Where can I look for potentials mistakes if my PIM API Credentials connection has failed?

  • Please verify if you did not leave an additional "space" character in one of the fields and/or if you did copy the entire field information correctly.
  • Please verify if you filed the correct information in corresponding fields (are your Secret PIM credentials copied in a related field?)
  • Please verify if the password is still correct (did you or someone from your team did request a new password in the PIM interface? if yes, you will need to update it accordingly)
  • Please verify if in the PIM your BigCommerce connection setting has:
    • A "data distribution" flow type
    • An admin permissions

#Set up your Bigcommerce credentials

To set up correctly your Configuration page in the Big Commerce Connector, you will need to create a new API connection in your BigCommerce store interface to allow a data flow from the Connector to your BigCommerce store.

To do so, please follow the steps below:

  1. Open your BigCommerce Store (Please note that you need to be an owner of the store to be able to set up a new API Connection)
  2. Go to Advanced Settings >> API Accounts >> Click on Create API Account >> Create V2/V3 API Token API Settings
  3. Give a name to your new Connection and set up:
    • Storefront API Tokens, Storefront API Customer Impersonation Tokens, Content, Information & Settings in a Read-Only mode,
    • Products in modification mode Save the changes.
  4. The credentials will be displayed in the pop-in. Please make sure to keep them as you will not be able to access them afterwards.
  5. Then, you can open the Configuration page of your BigCommerce connector and set up your BC credentials. You will need:
    • Client ID and Acces Token that you can find here: API Credentials
    • Store hash (BigCommerce identifier of your store - see example below) Storehash
  6. When saving your credentials by clicking on the "SAVE" button, your API connection will be tested to confirm that the linking could have been established. You will see the indication displayed in green or red depending on the state of the connection.

Where can I look for potentials mistakes if my BigCommerce API Credentials connection has failed?

  • Please verify if you did not leave an additional "space" character in one of the fields and/or if you did copy the entire field information correctly.
  • Please verify if you filed the correct information in corresponding fields (maybe you have used the Client Secret credentials in one of the fields?)
  • Please verify if the API credentials in question still exist in your BigCommerce store (did you or someone from your team did request the new API connection? if yes, you will need to update it accordingly)

#Set up your Main configuration

Once your PIM and BigCommerce credentials are set up and saved, you will be able to establish your Main App configuration.

You need to save and test your PIM credentials before setting up your main configuration, otherwise the Main configuration section will remain disabled.

You can select the fields from the dropdown list. The list of choices is automatically pre-populated from your PIM.

  1. Locale What is a locale?
  2. Channel What is a channel?
  3. Main category What is a category?

Please remember that only categories and products created within a given locale, channel and category will be imported to your BigCommerce instance.

Please remember to double-check your Connector's configuration before the first import.

Further changes (after 1st import) in the following fields can cause severe problems to your Connector usage:

  • Locale
  • Channel
  • Main category
  • PIM URL
  • BC store hash

If a change in one of those fields is necessery then please make sure to perform the manual clean/changes in the BigCommerce store before reimporting your categories and products.

If both of your API connections are established with a success, and your main configuration is all set up, then it means that you are good to go and map your BigCommerce/PIM attributes.


Be curious! Take a look at these related articles