Automate AfterShip Integration Tasks from PowerShell

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Are you in search of a quick and easy way to access AfterShip data from PowerShell? This article demonstrates how to utilize the AfterShip Cmdlets for tasks like connecting to AfterShip 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 AfterShip.

ADO.NET Provider

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

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

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

AfterShip API Profile Settings

Obtain your API key from the AfterShip account management panel by navigating to My Account > Settings > API Keys.

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

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

    $sql="SELECT Slug, Name from AllCouriers"
    
    $da= New-Object System.Data.CData.API.APIDataAdapter($sql, $conn)
    $dt= New-Object System.Data.DataTable
    $da.Fill($dt)
    
    $dt.Rows | foreach {
    	Write-Host $_.slug $_.name
    }
      

Ready to get started?

Connect to live data from AfterShip with the API Driver

Connect to AfterShip