BigCommerce

BigCommerce is an open Software-as-a-Service (SaaS) based eCommerce platform that allows you to create an online store to sell physical, digital, and service-based products. It offers a variety of customizable templates for you to design your online store according to your specific requirements. It also provides standard analytics on customers, sales, and marketing to gather insights and grow your business faster.

Hevo uses the BigCommerce’s REST API to replicate the data present in your BigCommerce account to the desired Destination database or data warehouse for scalable analysis.


Prerequisites

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

  • The store hash of the BigCommerce store from which data is to be ingested.

  • An access token with the necessary scopes to allow Hevo to connect to your BigCommerce account.

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


Obtaining the Store Hash and Access Token

Hevo uses the API credentials; store hash and access token, to authenticate Hevo on your BigCommerce account. The API credentials that you generate in BigCommerce do not expire. Therefore, you can use either the existing credentials or create new ones to authenticate Hevo on your BigCommerce account. BigCommerce recommends creating a separate set of API 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, to be used across all your Pipelines. However, you can also use a different set of API credentials for each Pipeline.

Note: You must be logged in as Store Owner to generate the store API credentials.

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 API accounts.

    API accounts

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

    Create API account

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

    Create API credentials

    • Token Type: Select 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.

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

      • Carts read-only

      • Channel listings read-only

      • Channel settings read-only

      • Sites & routes read-only

      • Marketing read-only

      • Orders read-only

      • Products read-only

      • Order transactions read-only

  6. Click Save. The BigCommerce API credentials pop-up dialog is displayed, and a .txt file containing the API credentials of your API account is downloaded to your computer.

  7. Store the downloaded .txt file, containing your API credentials, in a secure location.

    Downloaded .txt file

  8. Click Done.

    Click Done

    You have successfully created your store API account. Use the store hash and access token for creating Hevo Pipelines.


Configuring BigCommerce as a Source

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

  1. Click PIPELINES in the Asset Palette.

  2. Click + CREATE 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:

    Configure BigCommerce as a Source

    • 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 the existing data in the Source must be ingested. Default duration: 3 Months.

  5. Click TEST & CONTINUE.

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


Data Replication

Default Pipeline Frequency Minimum Pipeline Frequency Maximum Pipeline Frequency Custom Frequency Range (Hrs)
1 Hr 1 Hr 48 Hrs 1-48

Note: You must set the custom frequency in hours as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.

  • Historical Data: In the first run of the Pipeline, Hevo ingests historical data for the Products, Customers, and Orders objects on the basis of the historical sync duration selected at the time of creating the Pipeline and loads it to the Destination. Default duration: 3 Months.

  • Incremental Data: Once the historical load is complete, all new and updated records for the Products, Customers, and Orders objects are synchronized with your Destination according to the Pipeline frequency.


Source Considerations

  • Rate Limit: BigCommerce does not impose a hard API rate limit for the Enterprise plan. For other subscription plans, it imposes a limit of a maximum of 150 to 450 API calls per 30 seconds, depending on your plan, to optimize performance. Read Respect API rate limits.

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination database:


Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

Note: All objects other than Products, Customers, and Orders are Full Load objects.

Object Description
Products Contains the details of the products listed in the store.
Customers Contains the details of the customers of the store.
Orders Contains the details of all orders made by all customers in the store. Orders contain details like products ordered, shipping addresses, and the coupons applied to the order.
Brands Contains the details of the brands of the products listed in the store.
Categories Contains the details of all the categories used to classify the products listed in the store. For example, products such as phones and laptops can be grouped in the Electronics category.
Banners Contains the details of the online banners used for advertising products, special discounts, promotions, or relay some important information in the store.
Coupons Contains the details of the coupons available for products in the store.
Pages Contains the details of all the content pages of the store where all the products available in the store are displayed to the customers.

Limitations

  • Hevo currently does not support deletes. Therefore, any data deleted in the Source may continue to exist in the Destination.

Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Jul-12-2022 1.92 New document.
Last updated on 12 Jul 2022