ShipHero to Looker

This page provides you with instructions on how to extract data from ShipHero and analyze it in Looker. (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 Looker?

Looker is a powerful, modern business intelligence platform that has become the new standard for how modern enterprises analyze their data. From large corporations to agile startups, savvy companies can leverage Looker's analysis capabilities to monitor the health of their businesses and make more data-driven decisions.

Looker is differentiated from other BI and analysis platforms for a number of reasons. Most notable is the use of LookML, a proprietary language for describing dimensions, aggregates, calculations, and data relationships in a SQL database. LookML enables organizations to abstract the query logic behind their analyses from the content of their reports, making their analytics easy to manage, evolve, and scale.

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 Looker

To perform its analyses, Looker connects to your company's database or data warehouse, where the data you want to analyze is stored. Some popular data warehouses include Amazon Redshift, Google BigQuery, and Snowflake.

Looker's documentation offers instructions on how to configure and connect your data warehouse. In most cases, it's simply a matter of creating and copying access credentials, which may include a username, password, and server information. You can then move data from your various data sources into your data warehouse for Looker to use.

Analyzing data in Looker

Once your data warehouse is connected to Looker, you can build constructs known as explores, each of which is a SQL view containing a specific set of data for analysis. An example might be "orders" or "customers."

Once you've selected any given explore, you can filter data based on any column available in the view, group data based on certain fields in the view (known as dimensions), calculate outputs such as sums and counts (known as measures), and pick a visualization type such as a bar chart, pie chart, map, or bubble chart.

Beyond this simple use case, Looker offers a broad universe of functionality that allows you to conduct analyses and share them with your organization. You can get started with this walkthrough in Looker's documentation.

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 Looker 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 SQL Data Warehouse, 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 from ShipHero to Looker automatically. With just a few clicks, Stitch starts extracting your ShipHero data via the API, structuring it in a way that is optimized for analysis, and inserting that data into a data warehouse that can be easily accessed and analyzed by Looker.