Query ShipStation Data as a MySQL Database in Node.js

Ready to get started?

Download for a free trial:

Download Now

Learn more:

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.



Execute MySQL queries against ShipStation data from Node.js.

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 start querying using Node.js.

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.

Query ShipStation from Node.js

The following example shows how to define a connection and execute queries to ShipStation with the mysql module. You will need the following information:

  • Host name or address, and port: The machine and port where the MySQL remoting service is listening for MySQL connections.
  • Username and password: The username and password of a user you authorized on the Users tab of the SQL Gateway.
  • Database name: The DSN you configured for the MySQL remoting service.

Connect to ShipStation data and start executing queries with the code below:

var mysql      = require('mysql');
var connection = mysql.createConnection({
  host     : 'localhost',
  database : 'CData ShipStation Sys',
  port	   : '3306',
  user     : 'mysql_user',
  password : 'test'
});
connection.connect();
connection.query('SELECT * FROM Tags', function(err, rows, fields) {
  if (err) throw err;
  console.log(rows);
});

connection.end();