Query ShipStation Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for ShipStation, DataGrip can work with live ShipStation data. This article shows how to establish a connection to ShipStation data in DataGrip.

Create a New Driver Definition for ShipStation

The steps below describe how to create a new Data Source in DataGrip for ShipStation.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData ShipStation Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.shipstation.jar).
   • Set Class to cdata.jdbc.shipstation.ShipStation.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to ShipStation

1. Once the connection is saved, click the plus (), then "Data Source" then "CData ShipStation Driver" to create a new ShipStation Data Source.
2. In the new window, configure the connection to ShipStation with a JDBC URL.

   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.

   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.
3. Set URL to the connection string, e.g., jdbc:shipstation:APIKey='YourAPIKey';APISecret='YourAPISecret'
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against ShipStation

To browse through the ShipStation entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT Id, Color FROM Tags WHERE CustomerId = '1368175'

Download a free, 30-day trial of the CData JDBC Driver for ShipStation and start working with your live ShipStation data in DataGrip. Reach out to our Support Team if you have any questions.