This page provides you with instructions on how to extract data from ShipHero and analyze it in Amazon QuickSight. (If the mechanics of extracting data from ShipHero seem too complex or difficult to maintain, check out Stitch, which can do all the heavy lifting for you in just a few clicks.)
What is ShipHero?
ShipHero is a warehouse management system (WMS) for third-party logistics (3PL) companies. It handles syncing inventory across multiple ecommerce platforms, tracks purchase orders and changes to inventory, and integrates with all major shipping carriers.
What is QuickSight?
Amazon QuickSight is the AWS business intelligence tool for creating dashboards and visualizations. Users are charged per session only for the time when they access dashboards or reports. QuickSight supports a variety of data sources, such as individual databases (Amazon Aurora, MariaDB, and Microsoft SQL Server), data warehouses (Amazon Redshift and Snowflake), and SaaS sources (Adobe Analytics, GitHub, and Salesforce), along with several common standard file formats.
Getting data out of ShipHero
ShipHero provides a RESTful API that lets developers get at order and product information stored in the platform. For example, to retrieve a particular order using the ShipHero API, you would call GET https://api-gateway.shiphero.com/v1.2/general-api/get-order/?token={token}&id={id}
.
Sample ShipHero data
Here's an example of the kind of response you might see with a query like the one above.
{ "Message": "success", "code": "200", "orders": { "total": 1, "results": { "25609950": { "total_tax": "7.23", "subtotal_price": "83.00", "shipping_lines": { "price": "12.00", "carrier": "genericlabel", "method": "genericlabel", "title": "Same Day Delivery arrives TODAY 10/26 (between 5–9 p.m.)" }, "total_discounts": "0.00", "order_date": "2018-10-26T08:31:59-04:00", "id": 25609950, "line_items": [ { "price": "4.00", "barcode": "1651301", "product_attributes": [], "backorder_quantity": 0, "custom_options": [], "subtotal": "4.00", "sku": "SNK-232-12-S", "name": "Salted Crispy Chickpeas - Salted chickpea snack", "quantity_pending_fulfillment": 0, "warehouse": "Primary", "large_thumbnail": "https://cdn.shopify.com/s/files/1/0100/5392/products/PulseOriginalPackage900_6d27579c-94bf-402f-a396-9392258a4e97.jpg?v=1435345124", "thumbnail": "https://cdn.shopify.com/s/files/1/0100/5392/products/PulseOriginalPackage900_6d27579c-94bf-402f-a396-9392258a4e97.jpg?v=1435345124", "custom_barcode": null, "quantity": 1 }, { "price": "3.50", "barcode": "2172478", "product_attributes": [], "backorder_quantity": 0, "custom_options": [], "subtotal": "3.50", "sku": "SNK-262-11-S", "name": "Brined & Roasted Pumpkin Seeds", "quantity_pending_fulfillment": 0, "warehouse": "Primary", "large_thumbnail": "https://cdn.shopify.com/s/files/1/0100/5392/products/StonyBrookPepitasPumpkinSeedsFront900.jpg?v=1440698241", "thumbnail": "https://cdn.shopify.com/s/files/1/0100/5392/products/StonyBrookPepitasPumpkinSeedsFront900.jpg?v=1440698241", "custom_barcode": null, "quantity": 1 } ], "total_price": "102.23", "authorizations": [ { "postauthed_amount": "0.00", "refunded_amount": "0.00", "authorized_amount": "102.23", "card_type": "American E", "date": "2015-10-26 12:32:11", "transaction_id": "" } ], "note_attributes": [ { "name": "Gift Note", "value": null }, { "name": "Packing Note", "value": "" } ], "fulfillment_status": "pending", "shipping_address": { "province": "NY", "province_code": "NY", "address1": "1 Broadway", "company": "", "phone": "111.222.3333", "country_code": "US", "city": "New York", "zip": "10003", "country": "UNITED STATES", "email": "none@none.com", "address2": "#11" }, "order_history": [ { "username": "user", "created_at": "2018-10-26 12:32:11", "information": "this is an order note" } ], "tags": [ "tag1", "tag2" ], "order_number": "52570" } } } }
Preparing ShipHero 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. ShipHero's 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. In these cases you'll likely have to create additional tables to capture the unpredictable cardinality in each record.
Loading data into QuickSight
You must replicate data from your SaaS applications to a data warehouse (such as Redshift) before you can report on it using QuickSight. Once you specify a data source you want to connect to, you must specify a host name and port, database name, and username and password to get access to the data. You then choose the schema you want to work with, and a table within that schema. You can add additional tables by specifying them as new datasets from the main QuickSight page.
Using data in QuickSight
QuickSights provides both a visual report builder and the ability to use SQL to select, join, and sort data. QuickSight lets you combine visualizations into dashboards that you can share with others, and automatically generate and send reports via email.
Keeping ShipHero 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.
The key is to build your script in such a way that it can identify incremental updates to your data. Thankfully, ShipHero's API results include fields like order_date that allow you to identify records that are new since your last update (or since the newest record you've copied). Once you've take new data into account, you can set your script up as a cron job or continuous loop to keep pulling down new data as it appears.
From ShipHero to your data warehouse: An easier solution
As mentioned earlier, the best practice for analyzing ShipHero data in Amazon QuickSight is to store that data inside a data warehousing platform alongside data from your other databases and third-party sources. You can find instructions for doing these extractions for leading warehouses on our sister sites ShipHero to Redshift, ShipHero to BigQuery, ShipHero to Azure Synapse Analytics, ShipHero to PostgreSQL, ShipHero to Panoply, and ShipHero to Snowflake.
Easier yet, however, is using a solution that does all that work for you. Products like Stitch were built to move data automatically, making it easy to integrate ShipHero with Amazon QuickSight. With just a few clicks, Stitch starts extracting your ShipHero data, structuring it in a way that's optimized for analysis, and inserting that data into a data warehouse that can be easily accessed and analyzed by Amazon QuickSight.