ShipHero to Databricks

This page provides you with instructions on how to extract data from ShipHero and load it into Delta Lake on Databricks. (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 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 Delta Lake?

Delta Lake is an open source storage layer that sits on top of existing data lake file storage, such AWS S3, Azure Data Lake Storage, or HDFS. It uses versioned Apache Parquet files to store data, and a transaction log to keep track of commits, to provide capabilities like ACID transactions, data versioning, and audit history.

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 Delta Lake on Databricks

To create a Delta table, you can use existing Apache Spark SQL code and change the format from parquet, csv, or json to delta. Once you have a Delta table, you can write data into it using Apache Spark's Structured Streaming API. The Delta Lake transaction log guarantees exactly-once processing, even when there are other streams or batch queries running concurrently against the table. By default, streams run in append mode, which adds new records to the table. Databricks provides quickstart documentation that explains the whole process.

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.

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 move data from ShipHero to Delta Lake on Databricks automatically. 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 your Delta Lake on Databricks data warehouse.