BigCommerce

Devart SSIS Data Flow Components for BigCommerce support BigCommerce API v2 and v3, and you can create connections using any API version. Note that BigCommerce API v3 are not yet complete, and does not cover yet all BigCommerce features. When using BigCommerce API v3 connection, Devart SSIS Data Flow Components for BigCommerce work with BigCommerce objects, supported in API v3, via API v3, and other objects are accessed via API v2.

Besides the schema of some BigCommerce objects (especially, product-related) is different in API v2 and API v3.

 

ExpandedToggleIcon        Connection Dialog

To connect to BigCommerce, first you need to select the API Version to use. You also need to select the Authentication Type. API v2 supports both Basic and OAuth authentication kinds. But if you select API v3, you must use OAuth authentication.

 

The following connection options are required for Basic authentication:

1.Host - The API Path - the path where all XML requests to BigCommerce should be sent;
2.User Id - The user name to login with;
3.Authentication Token - An automatically generated key that is used for connecting to BigCommerce;

To get the Host, User Id, and Authentication Token parameters, sign in to BigCommerce in the browser, point to the Settings link in the bottom left corner of the page, and then in the Advanced Settings column click the Legacy API Settings link. After this, you can find all the necessary parameters in the opened Legacy API Account Details. Copy the Username parameter to the User Id box, API Path parameter to the Host box, and API Token parameter to the Authentication Token box.

 

The following connection options are required for OAuth authentication:

4.Store Id - The store hash from the API Path. For example, when you log in to your BigCommerce store Control Panel, an URL, similar to the following, opens in your browser: https://store-kj3jh4c.mybigcommerce.com/manage/dashboard . The part of the URL, highlighted with bold, is the store Id required.
5.Client Id - Client Id of your API account. See how to find it below.
6.Access Token - the OAuth access token to login with. See how to find it below.

 

ExpandedToggleIcon        Obtaining Connection Parameters for OAuth Authentication

To get parameters for OAuth authentication using Store Credentials, you need to create an API user. For this, perform the following actions:

1.Sign in to your BigCommerce Control Panel.
2.In the menu on the left, click Advanced Settings.
3.Then click API Accounts.
4.A list of API accounts, displaying the assigned scopes opens. Note that the required parameters are displayed only once, when creating an API account. It's not possible to view these parameters for an already created account. If you don't have the parameters for an existing parameters, stored anywhere, the only way to obtain them is to create a new API account. To create a new account, click Create API Account.
5.Specify the API user name and select the necessary OAuth scopes to allow Skyvia access.
6.Click Save. The necessary connection parameter are displayed and automatically downloaded as a text file. In Skyvia, you will need client ID and access token from there. Be sure to store these parameters somewhere, as you won't be able to see them for this API account any more.

 

 

ExpandedToggleIcon        Advanced Connection Options

The following table describes the options that you can include in the Connection String using the Advanced Connection Editor dialog box:

 

Option

Description

Access Token

An automatically generated key that is used for connecting to BigCommerce using OAuth authentication. See BigCommerce documentation for more information on how to get it.

API Version

The version of BigCommerce API to use - API v2 or v3.

Authentication Token

An automatically generated key that is used for connecting to BigCommerce using basic authentication. See BigCommerce documentation for more information on how to get it.

Authentication Type

Determines whether to use legacy Basic-Auth credentials or OAuth tokens for authentication.

Client Id

A unique ID of a BigCommerce client application. Used only for OAuth authentication. See BigCommerce documentation for more information on how to get it.

Connection Lifetime

When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by Connection Lifetime. The default value is 0 (connection always returns to pool).

Connection Timeout

The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. The default value is 15.

Default Command Timeout

The time in seconds to wait while trying to execute a command before terminating the attempt and generating an error.

Failover Retries

The number of retry attempts to re-run a command in case when the command failed because of an exception, that indicates that the reason of the failure may be temporary.

Local SQL Engine

Determines whether to enable local SQL processing (enabled by default). Local SQL processing allows performing complex SELECT statements that cannot be directly compiled to BigCommerce API calls. In this case ll the data from the mentioned cloud objects is queried to the local cache, and then the query is performed against the cache.

If local SQL processing is disabled, only simple SELECT statements that can be directly translated into BigCommerce API calls can be used. More complex SELECT statements will fail.

Max Pool Size

The maximum number of connections allowed in the pool. Setting the Max Pool Size value in the connection string can affect performance. The default value is 100.

Min Pool Size

The minimum number of connections allowed in the pool. The default value is 0.

Persist Security Info

Indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.

Pooling

If true, by default, the connection is drawn from the appropriate pool or is created and added to the appropriate pool.

Proxy Host

The host name or IP address of proxy server.

Proxy Password

The password for the proxy server account.

Proxy Port

The port number of the proxy server. The default value is 3128.

Proxy User

The proxy server account name.

Readonly

Indicates whether the connection is read-only (allows only SELECT statements).

Server

The API Path - the path where all XML requests to BigCommerce should be sent.

Store Dates

Determines whether to treat date values as dates in the BigCommerce store timezone. Please note that the UTC Dates parameter has a higher priority, and if it is set to True, date values are treated as UTC dates regardless of the Store Dates value.

Store Id

A unique identifier of the store (the first part of the store URL after the protocol). Used only for OAuth authentication.

Token Server

Not used for BigCommerce.

Use Custom Fields

Determines whether you will be able to get product custom fields via the CustomFields field of the Products object through this connection. Applicable only for BigCommerce API v3 connections. If set to True, this field returns a JSON array, containing information about custom fields and their values for products, if such are available. Otherwise, it always returns null values.

This parameter does not affect working with custom fields for customers and customer addresses, and it also does not affect access to product custom fields via the ProductCustomFields object.

Please note that processing custom fields may take an additional time and API calls, so it's recommended to set this parameter to True only if you need to work with product custom fields via this connection.

User ID

The BigCommerce user name to login with.

UTC Dates

If set to True, dates will be converted to UTC format during import, and the date values entered by the user (in SELECT statements, etc.) are considered UTC dates when sending them to the data source.