Replicate Multiple ShipStation Accounts

Ready to get started?

Learn more or sign up for a free trial:

CData Sync



Replicate multiple ShipStation accounts to one or many databases.

CData Sync for ShipStation 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 ShipStation connections. In this article we show how to use the CLI to replicate multiple ShipStation accounts.

Configure ShipStation Connections

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

Windows

<?xml version="1.0" encoding="UTF-8" ?> <CDataSync> <DatabaseType>SQLite</DatabaseType> <DatabaseProvider>System.Data.SQLite</DatabaseProvider> <ConnectionString>APIKey='YourAPIKey';APISecret='YourAPISecret'</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>APIKey='YourAPIKey';APISecret='YourAPISecret'</ConnectionString> <ReplicateAll>False</ReplicateAll> <NotificationUserName></NotificationUserName> <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString> </CDataSync>

Use the BASIC Authentication standard to connect.

  1. Login to your ShipStation account
  2. Click on the settings icon in the upper right corner. A column menu will show up on the left
  3. Click Account -> API Settings
  4. On the API Settings page, note the API Key and API Secret.

Authenticating to ShipStation

  • APIKey: Set this to the API key from the API settings page.
  • APISecret: Set this to the Secret key from the API settings page.

Configure Queries for Each ShipStation 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 ShipStation API. The statement below caches and incrementally updates a table of ShipStation data:

REPLICATE Tags;

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 ShipStation accounts into the same database:

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

REPLICATE PROD_Tags SELECT * FROM Tags

Alternatively, you can use a different schema:

REPLICATE PROD.Tags SELECT * FROM Tags

Run Sync

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

Windows

ShipStationSync.exe -g MyProductionShipStationConfig.xml -f MyProductionShipStationSync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar ShipStationSync.jar -g MyProductionShipStationConfig.xml -f MyProductionShipStationSync.sql