Automate ShipEngine Integration Tasks from PowerShell

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 ShipEngine.

ADO.NET Provider

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

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

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

ShipEngine API Profile Settings

Retrieve your ShipEngine API Key from the Dashboard at app.shipengine.com under API Management.

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 ShipEngine:

    
   $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\ShipEngine.apip;ProfileSettings='APIKey=your_api_key';")
   $conn.Open()
   

3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

   $sql="SELECT BatchId, Error from BatchErrors"
   
   $da= New-Object System.Data.CData.API.APIDataAdapter($sql, $conn)
   $dt= New-Object System.Data.DataTable
   $da.Fill($dt)
   
   $dt.Rows | foreach {
   	Write-Host $_.batchid $_.error
   }