Help & Resource Center

BigCommerce API Credentials


Overview

The Modern Retail Integration requires specific BigCommerce API credentials.  BigCommerce Account Owners are the only BigCommerce users who can generate these API credentials.  This article will tell you how to generate the API credentials.

Generating BigCommerce API Credentials

The steps outlined below will show you how to navigate BigCommerce and generate the needed API credentials.

  1.  Log into BigCommerce.
  2.  Go to the Advanced Settings Menu.
  3.  Select API Accounts from the menu.
    bigcommerce-advanced-settings-api-accounts.jpg
  4. On the next screen, select "Create API Account" at the top of the screen.
    bigcommerce-create-api-account.jpg
  5.  Select "Create V2/V3 API Token" from the drop-down menu.
    bigcommerce-createv2-token-dropdown.jpg
  6.  Please name the Account "Modern Retail Integration".
    bigcommerce-account-name.jpg
  7.  The below images capture the settings that need to be changed. In specific, the following must be changed from their default settings:
    1. Change Customers from none to modify
    2. Change Information & Settings from none to read-only 
    3. Change Marketing from none to modify
    4. Change Orders from none to modify
    5. Change Order Transactions from none to modify
    6. Change Get Payment Methods from non to read-only
    7. Change Products from none to Modify
    8.Change Carts from none to Modify
    9.Change Storefront API Tokens  from none to manage
    10.Change Storefront API Customer Impersonation Tokens from none to manage.
    BigCommerce_API_1.png
    Bigcommerce_API_2.png
  8.  Select "Save".
  9.  After selecting "save" you'll see a new window open that has the API Credentials.  When the window opens, BigCommerce will also generate a text file; look in the lower left corner of your browser for the file to download or save. 
    bigcommrece-api-text-file.jpg
  10.  Click on the file so that it opens and then save the file on your computer.
    bigcommerce-api-permissions-text-file-open.jpg
  11. Upload the file to the API Credentials task in the Onboarding center. 
    1. If you wish, you can also enter the information into the form manually instead of uploading the file. This has no meaningful effect on your project.

These credentials are needed in order for the integration to work; once we have them we can begin work to configure the integration.

If you have any further questions, please feel free to get in touch with your Project Manager using the messaging feature in the Onboarding Center.