Learn more
 

Ready to get started?

Connect to live data from Shippo with the API Driver

Connect to Shippo

In this article

Related articles

Replicate Shippo Data from PowerShell


Write a quick PowerShell script to query Shippo data. Use connectivity to the live data to replicate Shippo data to SQL Server.



The CData ODBC Driver for Shippo enables out-of-the-box integration with Microsoft's built-in support for ODBC. The ODBC driver instantly integrates connectivity to the real Shippo data with PowerShell.

You can use the .NET Framework Provider for ODBC built into PowerShell to quickly automate integration tasks like replicating Shippo data to other databases. This article shows how to replicate Shippo data to SQL Server in 5 lines of code.

You can also write PowerShell code to download Shippo data. See the examples below.

Create an ODBC Data Source for Shippo

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Connect to Shippo

The code below shows how to use the DSN to initialize the connection to Shippo data in PowerShell:

$conn = New-Object System.Data.Odbc.OdbcConnection $conn.ConnectionString = "DSN=CData API Source x64"

Back Up Shippo Data to SQL Server

After you enable caching, you can use the code below to replicate data to SQL Server.

Set the following connection properties to configure the caching database:

  • CacheProvider: The name of the ADO.NET provider. This can be found in the Machine.config for your version of .NET. For example, to configure SQL Server, enter System.Data.SqlClient.

  • CacheConnection: The connection string of properties required to connect to the database. Below is an example for SQL Server:

    Server=localhost;Database=RSB;User Id=sqltest;Password=sqltest;

The SQL query in the example can be used to refresh the entire cached table, including its schema. Any already existing cache is deleted.

$conn.Open() # Create and execute the SQL Query $SQL = "CACHE DROP EXISTING SELECT * FROM " + $Orders $cmd = New-Object System.Data.Odbc.OdbcCommand($sql,$conn) $count = $cmd.ExecuteNonQuery() $conn.Close()

The driver gives you complete control over the caching functionality. See the help documentation for more caching commands and usage examples. See the help documentation for steps to replicate to other databases.

Other Operations

To retrieve Shippo data in PowerShell, call the Fill method of the OdbcDataAdapter method. To execute data manipulation commands, initialize the OdbcCommand object and then call ExecuteNonQuery. Below are some more examples commands to Shippo through the .NET Framework Provider for ODBC:

Retrieve Shippo Data

$sql="SELECT ObjectId , OrderStatus from Orders" $da= New-Object System.Data.Odbc.OdbcDataAdapter($sql, $conn) $dt= New-Object System.Data.DataTable $da.Fill($dt) $dt.Rows | foreach { $dt.Columns | foreach ($col in dt{ Write-Host $1[$_] } }