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.

Connect to ShipStation Data in CloverDX (formerly CloverETL)



Transfer ShipStation data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for ShipStation enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with ShipStation as sources. In this article, you will use the JDBC Driver for ShipStation to set up a simple transfer into a flat file. The CData JDBC Driver for ShipStation enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with ShipStation as sources. In this article, you will use the JDBC Driver for ShipStation to set up a simple transfer into a flat file.

Connect to ShipStation as a JDBC Data Source

  1. Create the connection to ShipStation data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.shipstation.jar file.
  3. Enter the JDBC URL.

    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.

    A typical JDBC URL is below:

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

Query ShipStation Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the ShipStation JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT Id, Color FROM Tags WHERE CustomerId = '1368175'

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Tags table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.