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.

Analyze ShipStation Data in R

Use standard R functions and the development environment of your choice to analyze ShipStation data with the CData JDBC Driver for ShipStation.

Access ShipStation data with pure R script and standard SQL on any machine where R and Java can be installed. You can use the CData JDBC Driver for ShipStation and the RJDBC package to work with remote ShipStation data in R. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular, open-source R language. This article shows how to use the driver to execute SQL queries to ShipStation and visualize ShipStation data by calling standard R functions.

Install R

You can match the driver's performance gains from multi-threading and managed code by running the multithreaded Microsoft R Open or by running open R linked with the BLAS/LAPACK libraries. This article uses Microsoft R Open 3.2.3, which is preconfigured to install packages from the Jan. 1, 2016 snapshot of the CRAN repository. This snapshot ensures reproducibility.

Load the RJDBC Package

To use the driver, download the RJDBC package. After installing the RJDBC package, the following line loads the package:


Connect to ShipStation as a JDBC Data Source

You will need the following information to connect to ShipStation as a JDBC data source:

  • Driver Class: Set this to cdata.jdbc.shipstation.ShipStationDriver
  • Classpath: Set this to the location of the driver JAR. By default this is the lib subfolder of the installation folder.

The DBI functions, such as dbConnect and dbSendQuery, provide a unified interface for writing data access code in R. Use the following line to initialize a DBI driver that can make JDBC requests to the CData JDBC Driver for ShipStation:

driver <- JDBC(driverClass = "cdata.jdbc.shipstation.ShipStationDriver", classPath = "MyInstallationDir\lib\cdata.jdbc.shipstation.jar", identifier.quote = "'")

You can now use DBI functions to connect to ShipStation and execute SQL queries. Initialize the JDBC connection with the dbConnect function.

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 sample dbConnect call, including a typical JDBC connection string:

conn <- dbConnect(driver,"jdbc:shipstation:APIKey='YourAPIKey';APISecret='YourAPISecret'")

Schema Discovery

The driver models ShipStation APIs as relational tables, views, and stored procedures. Use the following line to retrieve the list of tables:


Execute SQL Queries

You can use the dbGetQuery function to execute any SQL query supported by the ShipStation API:

tags <- dbGetQuery(conn,"SELECT Id, Color FROM Tags WHERE CustomerId = '1368175'")

You can view the results in a data viewer window with the following command:


Plot ShipStation Data

You can now analyze ShipStation data with any of the data visualization packages available in the CRAN repository. You can create simple bar plots with the built-in bar plot function:

par(las=2,ps=10,mar=c(5,15,4,2)) barplot(tags$Color, main="ShipStation Tags", names.arg = tags$Id, horiz=TRUE)