Ready to get started?

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

 Download Now

Learn more:

ShipStation Icon ShipStation ODBC Driver

The ShipStation ODBC Driver is a powerful tool that allows you to connect with live data from ShipStation, directly from any applications that support ODBC connectivity.

Access ShipStation data like you would a database - read, write, and update ShipStation Marketplaces, Orders, Products, Items, etc. through a standard ODBC Driver interface.

How to Query ShipStation Data in MySQL Workbench



Execute MySQL queries against live ShipStation data from MySQL Workbench.

You can use the SQL Gateway from the ODBC Driver for ShipStation to query ShipStation data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live ShipStation data in MySQL Workbench.

Connect to ShipStation Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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 the SQL Gateway

See the SQL Gateway Overview to set up connectivity to ShipStation data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query ShipStation from MySQL Workbench

The steps below outline connecting to the virtual ShipStation database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live ShipStation data.

Connect to ShipStation through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for ShipStation).
  3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
  4. Click Store in Vault to set and store the password.
  5. Click Test Connection to ensure the connection is configured properly and click OK.

Query ShipStation Data

  1. Open the connection you just created (CData SQL Gateway for ShipStation).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve ShipStation data, like SELECT * FROM `CData ShipStation Sys`.Tags;

With access to live ShipStation data from MySQL Workbench, you can easily query and update ShipStation, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for ShipStation and the CData SQL Gateway.