Query ShipStation Data through ODBC 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.



Use node-odbc to execute SQL queries against ShipStation data from Node.js.

Node.js is a JavaScript runtime environment that allows you to run JavaScript code outside of a browser. With the CData ODBC Driver for ShipStation, you can access live ShipStation data from Node.js apps and scripts. In this article, we walk through installing node-odbc and the required tools to create a simple Node.js app with access to live ShipStation data.

With built-in optimized data processing, the CData ODBC Driver offers unmatched performance for interacting with live ShipStation data in Node.js. When you issue complex SQL queries from Node.js to ShipStation, the driver pushes supported SQL operations, like filters and aggregations, directly to ShipStation and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting 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.

Building node-odbc

In order to connect to ShipStation through the CData ODBC Driver, you need to build node-odbc manually (after installing the required tools).

Installing the Required Tools

The following commands install the tools required to build node-odbc (note the -g parameter, which installs the tools globally).

npm i -g windows-build-tools
npm i -g node-gyp

Building node-odbc

After installing the required tools, create a directory for the Node.js app and install odbc (which builds the binary for us to use in our Node.js script).

mkdir nodeodbc
cd nodeodbc
npm i -g node

Querying ShipStation from Node.js

With the ODBC Driver installed, a DSN Configured, and node-odbc built, we are ready to query live ShipStation data from a Node.js app. The sample code below connects to a specific DSN and queries the Tags table.

myscript.js

const odbc = require('odbc');

async function queryShipStation() {
    const connection = await odbc.connect(`DSN=CData ShipStation Source`);
    const data = await connection.query('SELECT Id, Color FROM Tags');
    console.log(data);
}

queryShipStation();

Once you write the app, use node to execute the script:

node myscript.js

Download a free, 30-day trial of the CData ODBC Driver for ShipStation and start working with your live ShipStation data in Node.js. Reach out to our Support Team if you have any questions.