Ready to get started?

Connect to live data from Shippo with the API Driver

Connect to Shippo

Automate Shippo Integration Tasks from PowerShell



Are you in search of a quick and easy way to access Shippo data from PowerShell? This article demonstrates how to utilize the Shippo Cmdlets for tasks like connecting to Shippo data, automating operations, downloading data, and more.

The CData API Driver for ADO.NET is a standard ADO.NET Provider that make it easy to accomplish data cleansing, normalization, backup, and other integration tasks by enabling real-time access to Shippo.

ADO.NET Provider

The ADO.NET Provider provides a SQL interface for Shippo; this tutorial shows how to use the Provider to retrieve Shippo data.

Once you have acquired the necessary connection properties, accessing Shippo data in PowerShell can be enabled in three steps.

Start by setting the Profile connection property to the location of the Shippo Profile on disk (e.g. C:\profiles\Shippo.apip). Next, set the ProfileSettings connection property to the connection string for Shippo (see below).

Shippo API Profile Settings

In order to authenticate to Shippo, you will need an API Key. You can find this API key under 'Settings' > 'API' > 'Generate Token'. After generating your key, set it to the APIKey in ProfileSettings connection property.

  1. Load the provider's assembly:

    [Reflection.Assembly]::LoadFile("C:\Program Files\CData\CData API Driver for ADO.NET\lib\System.Data.CData.API.dll")
  2. Connect to Shippo:

    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\Shippo.apip;ProfileSettings='APIKey=my_api_key';") $conn.Open()
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

    $sql="SELECT ObjectId , OrderStatus from Orders" $da= New-Object System.Data.CData.API.APIDataAdapter($sql, $conn) $dt= New-Object System.Data.DataTable $da.Fill($dt) $dt.Rows | foreach { Write-Host $_.objectid $_.orderstatus }