BigCommerce

Prerequisites

• An active BigCommerce account from which data is to be ingested exists.

• The store hash and access token are available to authenticate Hevo on your BigCommerce account.

• You are logged in as a Store Owner to generate the store API credentials. Else, you can obtain the API credentials from the Store Owner.

• You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.

Obtaining the Store Hash and Access Token

Hevo uses store hash and access token to authenticate Hevo on your BigCommerce account. These credentials that you generate in BigCommerce do not expire. Therefore, you can use either the existing credentials or create new ones to authenticate Hevo. BigCommerce recommends creating a separate set of credentials for each application that will be making calls on your behalf. For example, you can create one store hash and access token for Hevo, and use them across all your Pipelines. Alternatively, you can use a different set of credentials for each Pipeline.

Note: You must log in as a Store Owner to perform these steps.

Perform the following steps to obtain the store hash and access token:

1. Log in to your BigCommerce account.

2. In the left navigation pane, click Settings.

   

3. In the Settings page, scroll down to the API section, and click Store-level API accounts.

   

4. In the Store-level API accounts page, click + Create API account.

   

5. In the Create account page, specify the following:

   

   • Token Type: The V2/V3 API token that allows you to manage your store’s data.

   • Name: A unique name for your API token, not less than four characters.

   • API path: A unique URL that allows you to access the store API account. The API path contains the store hash. For example, if the API path is https://api.bigcommerce.com/stores/abcd1234/{version}/, store hash is abcd1234. Copy the store hash present in the API path and save it in a secure location like any other password. Use this store hash while configuring your Hevo Pipeline.

   • OAuth scopes: The API permissions needed by Hevo to access your data. Select the read-only scopes for the following API resources:

     • Carts

     • Channel listings

     • Channel settings

     • Marketing

     • Orders

     • Order transactions

     • Products

     • Sites & routes

6. Click Save.

7. In the BigCommerce API credentials pop-up window, copy the access token and save it securely like any other password. Use this access token while configuring your Hevo Pipeline.

   

Configuring BigCommerce as a Source

Perform the following steps to configure BigCommerce as the Source in your Pipeline:

1. Click PIPELINES in the Navigation Bar.

2. Click + CREATE PIPELINE in the Pipelines List View.

3. In the Select Source Type page, select BigCommerce.

4. In the Configure your BigCommerce Source page, specify the following:

   

   • Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.

   • Store Hash: The unique identifier for your store that you obtained from the API path of your store, to allow Hevo access to store API.

   • Access Token: The token that you created in your BigCommerce account, to enable Hevo to read data.

   • Historical Sync Duration: The duration for which you want to ingest the existing data from the Source. Default duration: 3 Months.

     Note: If you select All Available Data, Hevo ingests all the data available in your BigCommerce account since January 01, 1970.

5. Click TEST & CONTINUE.

6. Proceed to configuring the data ingestion and setting up the Destination.