Skip to main content

BigCommerce Reader

Note

This adapter is in preview and is available on Striim Developer only. See Striim Developer for more information.

BigCommerce is a cloud-based eCommerce platform that enables businesses to create, manage, and scale their online stores. It provides a wide range of built-in features and integrations, making it a popular choice for businesses of all sizes, from small startups to large enterprises.

Feature summary

Feature

Supported?

Notes

Objects

Standard objects

✓

Custom objects

✓

Authentication

Basic authentication

Username and password

OAuth authentication

✓

Manual configuration based

Custom authentication methods

Not all methods may be supported

Operations

Automated mode

✓

Initial load

✓

Pull-based incremental load

✓

Push-based incremental load

Automated pipeline

Governance

Connection profile

Sherlock AI

Sentinel AI

Schema handling

Initial schema creation

✓

Works with supported targets

Schema evolution

Setup

Wizard template

Flow Designer

✓

Striim TQL

✓

Runtime

Resilience/recovery

✓

Parallel execution

Metrics

✓

Standard metrics

Supported authentication method

The BigCommerce Reader supports OAuth authentication. Creating a connection requires retrieving the Store ID for your BigCommerce store, obtaining a personal access token to access your data, and setting connection properties in Striim.

To obtain the Store ID:

  1. Log in to your BigCommerce account.

  2. From the Home Page, select Advanced Settings > API Accounts.

  3. Choose Create API Account > Create V2/V3 API Token.

    A text box named API Path appears on your screen. Inside you can see a URL with the following structure: https://api.bigcommerce.com/stores/{Store ID}/v3.Your Store ID is located between the stores/ and /v3 path parameters.

  4. Once you have retrieved your Store ID you can either click Cancel or proceed to creating an API Account if you do not have one.

Additionally, you must obtain a personal token to test and to access your own data. To obtain the personal token:

  1. Log in to your BigCommerce account.

  2. From the Home Page, select Advanced Settings > API Accounts.

  3. Choose 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 driver cannot access data marked as "None" and cannot modify data marked as "read-only".

  6. Click Save.

Supported objects

The following are the supported objects for reading from BigCommerce:

  • BlogTags

  • Blogposts

  • Brands

  • Categories

  • ChannelListings

  • Channels

  • Coupons

  • Currencies

  • CustomerAddresses

  • CustomerGroups

  • Customers

  • DownloadConsignments

  • EmailConsignments

  • GiftCertificates

  • OrderCoupons

  • OrderItemOptionValues

  • OrderItems

  • OrderMessages

  • OrderRefunds

  • OrderRefundsItems

  • OrderRefundsPayments

  • OrderShipments

  • OrderShippingAddresses

  • OrderStatuses

  • OrderTaxes

  • Orders

  • Pages

  • PaymentMethods

  • PickupConsignments

  • PriceListAssignments

  • PriceListRecords

  • PriceLists

  • ProductBulkPricingRules

  • ProductCustomFields

  • ProductImages

  • ProductMetafields

  • ProductOptionValues

  • ProductOptions

  • ProductReviews

  • ProductRules

  • ProductSkus

  • ProductVariantValues

  • ProductVariants

  • ProductVideos

  • Products

  • Redirects

  • ShipmentItems

  • ShippingConsignmentQuotes

  • ShippingConsignments

  • ShippingMethods

  • ShippingZones

  • Stores

  • TaxClasses

  • Transactions

BigCommerce Reader properties

Property

Type

Default value

Notes

Store ID

String

The store hash for this BigCommerce account.

OAuth access token

Password

The access token for connecting using OAuth. The OAuth access token is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

Include custom fields

Boolean

A boolean indicating if you would like to include custom fields in the column listing.

Setting this to true will cause custom fields to be included in the column listing, but may cause poor performance when listing metadata.

Connection pool size

Integer

20

Specifies the maximum number of active connections.

Exclude tables

String

A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.

Incremental load marker

String

The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval.

Specify the name of the column that contains the start position value. This column must meet the following criteria:

  • It should have an integer or timestamp data type (for example, a creation timestamp or an employee ID).

  • The values must be unique and continuously increasing to ensure proper incremental reading.

Migrate schema

Boolean

False

Only available in Initial Load or Automated mode. Set to True to enable initial schema migration, which propagates the object schema from the source to the target.

Mode

Select list:

  • Automated mode

  • Initial load

  • Incremental load

Automated

Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load.

Polling interval

Integer

5m

Specifies an interval as an integer followed by a unit. Supported units are days (d), hours (h), minutes (m), or seconds (s). The reader polls the source at the specified interval.

Start Position

String

%=-1

Value of the incremental load marker that defines the initial reading position.

Tables

String

A semicolon-delimited (;) list of objects to read from the source. Supports the % wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.

Thread pool count

Integer

10

The number of parallel running threads. The default value of zero specifies single-threaded operation.

When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice.