CData Python Connector for BigCommerce

Build 21.0.7930

Establishing a Connection

The objects available within our connector are accessible from the "cdata.bigcommerce" module. In order to use the module's objects directly, the module must first be imported as below:

import cdata.bigcommerce as mod

From there, the connect() method can be called from the connector object to establish a connection using an appropriate connection string, such as the below:

mod.connect("InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;StoreId='YoUrSToREId';CallbackURL='http://localhost:33333'")

Connecting to BigCommerce

BigCommerce authentication is based on the standard OAuth flow.

Obtain the Store ID

In order to connect to your BigCommerce Store, you will need your StoreId. To find your Store Id please follow these steps:

  1. Log in to your BigCommerce account.
  2. From the Home Page, select Advanced Settings > API Accounts.
  3. Click Create API Account --> Create V2/V3 API Token.
  4. A text box named API Path will appear on your screen.
  5. Inside you can see a URL of the following structure: https://api.bigcommerce.com/stores/{Store Id}/v3.
  6. As demonstrated above, your Store Id will be between the 'stores/' and '/v3' path paramters.
  7. Once you have retrieved your Store Id you can either click Cancel or proceed in creating an API Account in case you do not have one already.

Obtain a Personal Access Token

Additionally, you will need to obtain a personal token to test and to access your own data. To obtain the personal token, follow the steps below:

  1. Log in to your BigCommerce account.
  2. From the Home Page, select Advanced Settings > API Accounts.
  3. Click Create API Account --> Create V2/V3 API Token.
  4. Enter the name of your account.
  5. Choose the OAuth Scopes for the API Account you are creating. The provider will not be able to access data marked as "None" and will not be able to modify data marked as "read-only".
  6. Click Save.

Authenticating to BigCommerce

You can then set the following to connect to data:
  • StoreId: Set this to the store ID obtained from the API Path text box.
  • OAuthAccessToken: Set this to the token you generated.
  • InitiateOAuth: Set to OFF.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930