Connect to ShipStation Data in Ruby

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.



Connect to ShipStation data in Ruby with ruby-dbi, dbd-odbc, and ruby-odbc.

The CData ODBC Driver for ShipStation makes it easy to integrate connectivity to live ShipStation data in Ruby. This article shows how to create a simple Ruby app that connects to ShipStation data, executes a query, and displays the results.

Create an ODBC Connection to ShipStation Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Installing Ruby and Necessary Gems

If you do not have Ruby installed, refer to the Ruby installation page. With Ruby installed, you will need to install the ruby-dbi, dbd-odbc, and ruby-odbc gems:

gem install dbi gem install dbd-odbc gem install ruby-odbc

Create a Ruby App with Connectivity to ShipStation Data

Create a new Ruby file (for example: ShipStationSelect.rb) and open it in a text editor. Copy the following code into your file:

#connect to the DSN require 'DBI' cnxn = DBI.connect('DBI:ODBC:CData ShipStation Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT Id, Color FROM Tags WHERE CustomerId = '1368175'") #display the names of the columns resultSet.column_names.each do |name| print name, "\t" end puts #display the results while row = resultSet.fetch do (0..resultSet.column_names.size - 1).each do |n| print row[n], "\t" end puts end resultSet.finish #close the connection cnxn.disconnect if cnxn

With the file completed, you are ready to display your ShipStation data with Ruby. To do so, simply run your file from the command line:

ruby ShipStationSelect.rb Writing SQL-92 queries to ShipStation allows you to quickly and easily incorporate ShipStation data into your own Ruby applications. Download a free trial today!