Shippo to Panoply

This page provides you with instructions on how to extract data from Shippo and load it into Panoply. (If this manual process sounds onerous, check out Stitch, which can do all the heavy lifting for you in just a few clicks.)

What is Shippo?

Shippo provides a web platform and API that helps businesses coordinate and track shipping with multiple carriers.

What is Panoply?

Panoply is a managed data warehouse platform that lets users set up an Amazon Redshift instance in just a few clicks. Complex tasks like schema building, data mining, modeling, scaling, performance tuning, security, and backup are handled by an array of machine learning algorithms. Panoply can import data with no schema, no modeling, and no configuration, and you can use your favorite analysis, SQL, and visualization tools just as you would if you were creating a Redshift data warehouse on your own.

Getting data out of Shippo

Shippo provides a REST API that lets you get information about shipments, manifests, rates, and many more elements. If, for example, you wanted to retrieve a customs declaration, you could call GET /customs/declarations/[objectID].

Sample Shippo data

The Shippo API returns data in JSON format. For example, the result of a call to retrieve a customs declaration might look like this:

{
   "object_created":"2017-11-17T01:01:08.306Z",
   "object_updated":"2017-11-17T01:01:08.306Z",
   "object_id":"e2197a54da9d470480f4f8796cc419cb",
   "object_owner":"potamus@goshippo.com",
   "object_state":"VALID",
   "certify_signer":"Oscar Potamus",
   "certify":true,
   "items":[
      "5087f181d1dc4b14b73fdbf636498886"
   ],
   "non_delivery_option":"ABANDON",
   "contents_type":"MERCHANDISE",
   "contents_explanation":"T-Shirt purchase",
   "exporter_reference":"",
   "importer_reference":"",
   "invoice":"#123123",
   "commercial_invoice":false,
   "license":"",
   "certificate":"",
   "notes":"",
   "eel_pfc":"NOEEI_30_37_a",
   "aes_itn":"",
   "disclaimer":"",
   "incoterm":"",
   "metadata":"Order ID #123123",
   "test": true
}

Preparing Shippo data

If you don't already have a data structure in which to store the data you retrieve, you'll have to create a schema for your data tables. Then, for each value in the response, you'll need to identify a predefined datatype (INTEGER, DATETIME, etc.) and build a table that can receive them. Shippo's API documentation should tell you what fields are provided by each endpoint, along with their corresponding datatypes.

Complicating things is the fact that the records retrieved from the source may not always be "flat" – some of the objects may actually be lists. This means you'll likely have to create additional tables to capture the unpredictable cardinality in each record.

Loading data into Panoply

Once you've identified all the columns you want to insert, you can use the CREATE TABLE statement in Reshift to set up a table to receive your data.

With the table built, you might think that the easiest way to migrate your data (especially if there isn't much of it) would be to build INSERT statements to add data to your Redshift table row by row. Think again! Redshift isn't optimized for inserting data one row at a time. If you have a high volume of data to be inserted, we suggest moving the data into Amazon S3 and then using the COPY command to load it into Redshift.

Keeping Shippo data up to date

At this point you've coded up a script or written a program to get the data you want and successfully moved it into your data warehouse. But how will you load new or updated data? It's not a good idea to replicate all of your data each time you have updated records. That process would be painfully slow and resource-intensive.

Instead, identify key fields that your script can use to bookmark its progression through the data and use to pick up where it left off as it looks for updated data. Auto-incrementing fields such as updated_at or created_at work best for this. When you've built in this functionality, you can set up your script as a cron job or continuous loop to get new data as it appears in Shippo.

And remember, as with any code, once you write it, you have to maintain it. If Shippo modifies its API, or the API sends a field with a datatype your code doesn't recognize, you may have to modify the script. If your users want slightly different information, you definitely will have to.

Other data warehouse options

Panoply is great, but sometimes you need to optimize for different things when you're choosing a data warehouse. Some folks choose to go with Amazon Redshift, Google BigQuery, PostgreSQL, or Snowflake, which are RDBMSes that use similar SQL syntax. If you're interested in seeing the relevant steps for loading data into one of these platforms, check out To Redshift, To BigQuery, To Postgres, and To Snowflake.

Easier and faster alternatives

If all this sounds a bit overwhelming, don’t be alarmed. If you have all the skills necessary to go through this process, chances are building and maintaining a script like this isn’t a very high-leverage use of your time.

Thankfully, products like Stitch were built to solve this problem automatically. With just a few clicks, Stitch starts extracting your Shippo data via the API, structuring it in a way that is optimized for analysis, and inserting that data into your Panoply data warehouse.