Using the CData ODBC Driver for ShipStation in PyCharm

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for ShipStation from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for ShipStation as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

1. Click File -> Settings to open the project settings window.
2. Click Project Interpreter from the Project: YourProjectName menu.
3. To add pyodbc, click the + button and enter pyodbc.
4. Click Install Package to install pyodbc.

Connect to ShipStation

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

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.

Below is the syntax for a DSN:

[CData ShipStation Source]
Driver = CData ODBC Driver for ShipStation
Description = My Description
APIKey = 'YourAPIKey'
APISecret = 'YourAPISecret'

Execute SQL to ShipStation

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for ShipStation};APIKey = 'YourAPIKey';APISecret = 'YourAPISecret'')
cursor = cnxn.cursor()
cursor.execute("SELECT Id, Color FROM Tags WHERE CustomerId = '1368175'")
rows = cursor.fetchall()
for row in rows:
 print(row.Id, row.Color)

After connecting to ShipStation in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to ShipStation data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].