Query ShipStation Data as a MySQL Database in Node.js

Ready to get started?

Learn more or sign up for a free trial:

CData Connect



Execute MySQL queries against ShipStation data from Node.js.

You can use CData Connect Cloud to query ShipStation data through a MySQL interface. Follow the procedure below to create a virtual database for ShipStation in Connect Cloud and start querying using Node.js.

CData Connect Cloud provides a pure MySQL, cloud-to-cloud interface for ShipStation, allowing you to easily query live ShipStation data in Node.js — without replicating the data to a natively supported database. As you query data in Node.js, CData Connect Cloud pushes all supported SQL operations (filters, JOINs, etc) directly to ShipStation, leveraging server-side processing to quickly return ShipStation data.

Create a Virtual MySQL Database for ShipStation Data

CData Connect Cloud uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Login to Connect Cloud and click Databases.
  2. Select "ShipStation" from Available Data Sources.
  3. Enter the necessary authentication properties to connect to ShipStation.

    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.
  4. Click Test Database.
  5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to ShipStation data from any MySQL client.

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 address of your instance of the Connect Cloud (myinstance.cdatacloud.net) and the port (3306)
  • Username and password: The username and password of a user you authorized on Connect Cloud
  • Database name: The database you configured for ShipStation (shipstationdb)

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

var mysql      = require('mysql');
var fs         = require('fs');
var connection = mysql.createConnection({
  host     : 'myinstance.cdatacloud.net',
  database : 'shipstationdb',
  port	   : '3306',
  user     : 'admin',
  password : 'password',
  ssl      : {
    ca : fs.readFileSync('C:/certs/myCA.pem')
  }
});
connection.connect();
connection.query('SELECT * FROM Tags', function(err, rows, fields) {
  if (err) throw err;
  console.log(rows);
});

connection.end();