Early Access: The content on this website is provided for informational purposes only in connection with pre-General Availability Qlik Products.
All content is subject to change and is provided without warranty.
Skip to main content Skip to complementary content

BigCommerce 

BigCommerce is an eCommerce platform to help retailers and brands create and manage their online businesses.

BigCommerce integration replicates data using the BigCommerce REST API.

See the Schema section for a list of objects available for replication.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Information noteMake sure that the account you use has read access to the tables you want to fetch.

To retrieve your API credentials:

  1. Log into your BigCommerce account as the store owner.
  2. Click Advanced Settings > API Accounts. The Store API Accounts page is displayed.
  3. Click Create API Account.
  4. In the Name field, enter a name for your app.
  5. In the OAuth Scopes section, set the following permission fields to read-only:
    • Customers.
    • Marketing.
    • Orders.
    • Products.
  6. Click Save. The account is created.
  7. From the pop-up window, download the .txt file containing your API credentials.

    If you are not prompted to download the .txt file or encounter other issues, contact BigCommerce support.

  8. Open the file and copy the credentials.

Creating the connection

For more information, see Connecting to SaaS applications.

  1. Fill in the required connection properties.
  2. Provide a name for the connection in Connection name.

  3. Select Open connection metadata to define metadata for the connection when it has been created.

  4. Click Create.

Connection settings
SettingDescription
Data gateway

Select a Data Movement gateway if required by your use case.

Information note

This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None.

For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.

Start Date

Enter the date, in the format MM/DD/YYYY, from which the data must be replicated from your source to your target.

Client IDClient ID.
Access TokenAccess token.
Store HashStore hash.

The value between stores/ and /v3/ in the API path is your store hash. For example: If the API path were https://api.bigcommerce.com/stores/123456/v3/, the store hash would be 123456.

Schema

Information note

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 1.

Depending on your destination, table and column names may not appear as they are outlined below.

coupons

The coupons table contains info about the coupons in your BigCommerce store.

Information note Tip: This table uses Full Table Replication, which means all records will be replicated during every replication job. To avoid re-replicating unnecessary data, create a second BigCommerce integration in your Stitch account (you can even use the same BigCommerce API credentials) and set the integration to replicate every 12 or 24 hours.

Replication Method

Full Table

Primary Key

id

Useful links

BigCommerce API method

customers

The customers table contains info about the customers in your BigCommerce store.

Replication Method

CDC

Primary Key

id

Replication Key

date_modified

Useful links

BigCommerce API method

orders

The orders table contains info about the orders in your BigCommerce store.

Replication Method

CDC

Primary Key

id

Replication Key

date_modified

Useful links

BigCommerce API method

products

The products table contains info about the products in your BigCommerce store.

Note: During the initial replication job for a BigCommerce integration, all products will be replicated. On subsequent replication jobs, only new and updated product records will be replicated.

Replication Method

CDC

Primary Key

id

Replication Key

date_modified

Useful links

BigCommerce API method

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!