Automate Gorgias 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 Gorgias.

ADO.NET Provider

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

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

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

Gorgias API Profile Settings

Use your Gorgias login email as the User and your API key as the Password. Your Domain is the subdomain from your Gorgias portal URL.

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

    
   $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\Gorgias.apip;ProfileSettings='User=your_email;Password=your_api_key;Domain=your_subdomain';")
   $conn.Open()
   

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

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