Learn more
 

Ready to get started?

Download a free trial of the ShipStation ODBC Driver to get started:

 Download Now

Learn more:

ShipStation Icon 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.

In this article

Related articles

Replicate ShipStation Data from PowerShell


Write a quick PowerShell script to query ShipStation data. Use connectivity to the live data to replicate ShipStation data to SQL Server.



The CData ODBC Driver for ShipStation enables out-of-the-box integration with Microsoft's built-in support for ODBC. The ODBC driver instantly integrates connectivity to the real ShipStation data with PowerShell.

You can use the .NET Framework Provider for ODBC built into PowerShell to quickly automate integration tasks like replicating ShipStation data to other databases. This article shows how to replicate ShipStation data to SQL Server in 5 lines of code.

You can also write PowerShell code to download ShipStation data. See the examples below.

Create an ODBC Data Source for ShipStation

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.

Connect to ShipStation

The code below shows how to use the DSN to initialize the connection to ShipStation data in PowerShell:

$conn = New-Object System.Data.Odbc.OdbcConnection $conn.ConnectionString = "DSN=CData ShipStation Source x64"

Back Up ShipStation Data to SQL Server

After you enable caching, you can use the code below to replicate data to SQL Server.

Set the following connection properties to configure the caching database:

  • CacheProvider: The name of the ADO.NET provider. This can be found in the Machine.config for your version of .NET. For example, to configure SQL Server, enter System.Data.SqlClient.

  • CacheConnection: The connection string of properties required to connect to the database. Below is an example for SQL Server:

    Server=localhost;Database=RSB;User Id=sqltest;Password=sqltest;

The SQL query in the example can be used to refresh the entire cached table, including its schema. Any already existing cache is deleted.

$conn.Open() # Create and execute the SQL Query $SQL = "CACHE DROP EXISTING SELECT * FROM " + $Tags $cmd = New-Object System.Data.Odbc.OdbcCommand($sql,$conn) $count = $cmd.ExecuteNonQuery() $conn.Close()

The driver gives you complete control over the caching functionality. See the help documentation for more caching commands and usage examples. See the help documentation for steps to replicate to other databases.

Other Operations

To retrieve ShipStation data in PowerShell, call the Fill method of the OdbcDataAdapter method. To execute data manipulation commands, initialize the OdbcCommand object and then call ExecuteNonQuery. Below are some more examples commands to ShipStation through the .NET Framework Provider for ODBC:

Retrieve ShipStation Data

$sql="SELECT Id, Color from Tags" $da= New-Object System.Data.Odbc.OdbcDataAdapter($sql, $conn) $dt= New-Object System.Data.DataTable $da.Fill($dt) $dt.Rows | foreach { $dt.Columns | foreach ($col in dt{ Write-Host $1[$_] } }