Replicate Multiple BigCommerce Accounts

Ready to get started?

Learn more or sign up for a free trial:

CData Sync



Replicate multiple BigCommerce accounts to one or many databases.

CData Sync for BigCommerce is a stand-alone application that provides solutions for a variety of replication scenarios such as replicating sandbox and production instances into your database. Both Sync for Windows and Sync for Java include a command-line interface (CLI) that makes it easy to manage multiple BigCommerce connections. In this article we show how to use the CLI to replicate multiple BigCommerce accounts.

Configure BigCommerce Connections

You can save connection and email notification settings in an XML configuration file. To replicate multiple BigCommerce accounts, use multiple configuration files. Below is an example configuration to replicate BigCommerce to SQLite:

Windows

<?xml version="1.0" encoding="UTF-8" ?> <CDataSync> <DatabaseType>SQLite</DatabaseType> <DatabaseProvider>System.Data.SQLite</DatabaseProvider> <ConnectionString>OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'</ConnectionString> <ReplicateAll>False</ReplicateAll> <NotificationUserName></NotificationUserName> <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString> <TaskSchedulerStartTime>09:51</TaskSchedulerStartTime> <TaskSchedulerInterval>Never</TaskSchedulerInterval> </CDataSync>

Java

<?xml version="1.0" encoding="UTF-8" ?> <CDataSync> <DatabaseType>SQLite</DatabaseType> <DatabaseProvider>org.sqlite.JDBC</DatabaseProvider> <ConnectionString>OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'</ConnectionString> <ReplicateAll>False</ReplicateAll> <NotificationUserName></NotificationUserName> <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString> </CDataSync>

BigCommerce authentication is based on the standard OAuth flow. To authenticate, you must initially create an app via the Big Commerce developer platform where you can obtain an OAuthClientId, OAuthClientSecret, and CallbackURL. These three parameters will be set as connection properties to your driver.

Additionally, in order to connect to your BigCommerce Store, you will need your StoreId. To find your Store Id please follow these steps:

  1. Log in to your BigCommerce account.
  2. From the Home Page, select Advanced Settings > API Accounts.
  3. Click Create API Account.
  4. A text box named API Path will appear on your screen.
  5. Inside you can see a URL of the following structure: https://api.bigcommerce.com/stores/{Store Id}/v3.
  6. As demonstrated above, your Store Id will be between the 'stores/' and '/v3' path paramters.
  7. Once you have retrieved your Store Id you can either click Cancel or proceed in creating an API Account in case you do not have one already.

Configure Queries for Each BigCommerce Instance

Sync enables you to control replication with standard SQL. The REPLICATE statement is a high-level command that caches and maintains a table in your database. You can define any SELECT query supported by the BigCommerce API. The statement below caches and incrementally updates a table of BigCommerce data:

REPLICATE Customers;

You can specify a file containing the replication queries you want to use to update a particular database. Separate replication statements with semicolons. The following options are useful if you are replicating multiple BigCommerce accounts into the same database:

You can use a different table prefix in the REPLICATE SELECT statement:

REPLICATE PROD_Customers SELECT * FROM Customers

Alternatively, you can use a different schema:

REPLICATE PROD.Customers SELECT * FROM Customers

Run Sync

After you have configured the connection strings and replication queries, you can run Sync with the following command-line options:

Windows

BigCommerceSync.exe -g MyProductionBigCommerceConfig.xml -f MyProductionBigCommerceSync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar BigCommerceSync.jar -g MyProductionBigCommerceConfig.xml -f MyProductionBigCommerceSync.sql