Learn more
 

Ready to get started?

Download a free trial of the ShipStation Driver to get started:

 Download Now

Learn more:

ShipStation Icon ShipStation JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with ShipStation.

In this article

Related articles

Load ShipStation Data to a Database Using Embulk


Use CData JDBC drivers with the open source ETL/ELT tool Embulk to load ShipStation data to a database.

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for ShipStation, Embulk easily loads data from ShipStation to any supported destination. In this article, we explain how to use the CData JDBC Driver for ShipStation in Embulk to load ShipStation data to a MySQL dtabase.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live ShipStation data. When you issue complex SQL queries to ShipStation, the driver pushes supported SQL operations, like filters and aggregations, directly to ShipStation and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Configure a JDBC Connection to ShipStation Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for ShipStation\lib).

Embulk supports JDBC connectivity, so you can easily connect to ShipStation and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with ShipStation.

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.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the ShipStation JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.shipstation.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a typical JDBC connection string for ShipStation:

jdbc:shipstation:APIKey='YourAPIKey';APISecret='YourAPISecret'

Load ShipStation Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

  1. Install the JDBC Input Plugin in Embulk.
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
    2. embulk gem install embulk-input-jdbc
  2. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql embulk gem install embulk-output-mysql

With the input and output plugins installed, we are ready to load ShipStation data into MySQL using Embulk.

Create a Job to Load ShipStation Data

Start by creating a config file in Embulk, using a name like shipstation-mysql.yml.

  1. For the input plugin options, use the CData JDBC Driver for ShipStation, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.shipstation.ShipStationDriver), and the JDBC URL from above
  2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (shipstation-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.shipstation.jar driver_class: cdata.jdbc.shipstation.ShipStationDriver url: jdbc:shipstation:APIKey='YourAPIKey';APISecret='YourAPISecret' table: "Tags" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Tags" mode: insert

After creating the file, run the Embulk job.

embulk run shipstation-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered ShipStation Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in: type: jdbc driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.shipstation.jar driver_class: cdata.jdbc.shipstation.ShipStationDriver url: jdbc:shipstation:APIKey='YourAPIKey';APISecret='YourAPISecret' query: "SELECT Id, Color FROM Tags WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Tags" mode: insert

More Information & Free Trial

By using CData JDBC Driver for ShipStation as a connector, Embulk can integrate ShipStation data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.