Query ShipStation Data as a SQL Server Database in Node.js

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

CData Connect AI 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 AI pushes all supported SQL operations (filters, JOINs, etc) directly to ShipStation, leveraging server-side processing to quickly return ShipStation data.

Configure ShipStation Connectivity for NodeJS

Connectivity to ShipStation from NodeJS is made possible through CData Connect AI. To work with ShipStation data from NodeJS, we start by creating and configuring a ShipStation connection.

1. Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection

2. Select "ShipStation" from the Add Connection panel
👁 Selecting a data source

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.
   👁 Configuring a connection (Salesforce is shown)
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add ShipStation Connection page and update the User-based permissions. 👁 Updating permissions
   

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create. 👁 Creating a new PAT
   
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to ShipStation data from Node.js.

Query ShipStation from Node.js

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

• server: tds.cdata.com
• port: 14333
• user: a Connect AI user (e.g. [email protected])
• password: the PAT for the above user
• database: The connection you configured for ShipStation (ShipStation1)

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

var sql = require('mssql')
var config = {
	server: 'tds.cdata.com',
	port: 14333, 
	user: '[email protected]', //update me
	password: 'CONNECT_USER_PAT', //update me	
	options: {
		encrypt: true,
		database: 'ShipStation1'
	}
}

sql.connect(config, err => { 
 if(err){
 throw err ;
 }
 new sql.Request().query('SELECT * FROM Tags', (err, result) => {
 console.dir(result)
 })
 
});

sql.on('error', err => {
 console.log("SQL Error: " ,err);
})