Ready to get started?

Download a free trial of the ShipStation Cmdlets to get started:

 Download Now

Learn more:

ShipStation Icon ShipStation Data Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to ShipStation. The Cmdlets allow users to easily read, write, update, and delete live data - just like working with SQL server.

How to pipe ShipStation Data to CSV in PowerShell

Use standard PowerShell cmdlets to access ShipStation tables.

The CData Cmdlets Module for ShipStation is a standard PowerShell module offering straightforward integration with ShipStation. Below, you will find examples of using our ShipStation Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your ShipStation Data

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.

$conn = Connect-ShipStation  -APIKey "$APIKey" -APISecret "$APISecret"

Selecting Data

Follow the steps below to retrieve data from the Tags table and pipe the result into to a CSV file:

Select-ShipStation -Connection $conn -Table Tags | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myTagsData.csv -NoTypeInformation

You will notice that we piped the results from Select-ShipStation into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.