Shopify to Delta Lake

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

Shopify is an ecommerce platform for online and retail point-of-sale systems. It lets businesses set up and manage online stores, accept credit card payments, and track and respond to orders.

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 Shopify

The first step to getting Shopify data into your data warehouse is pulling that data off of Shopify's servers using either the Shopify REST API or webhooks. We'll focus on the API here because it allows you to retrieve all of your historical data rather than just new real-time data.

Shopify's API offers numerous endpoints that can provide information on transactions, customers, refunds, and more. Using methods outlined in the API documentation, you can retrieve the data you need. For example, to get a list of all transactions for a given ID, you could call GET /admin/orders/#[id]/transactions.json.

Sample Shopify data

The Shopify API returns JSON-formatted data. Here's an example of the kind of response you might see when querying the transactions endpoint.

{
  "transactions": [
    {
      "id": 179259969,
      "order_id": 450789469,
      "kind": "refund",
      "gateway": "bogus",
      "message": null,
      "created_at": "2017-08-05T12:59:12-04:00",
      "test": false,
      "authorization": "authorization-key",
      "status": "success",
      "amount": "209.00",
      "currency": "USD",
      "location_id": null,
      "user_id": null,
      "parent_id": null,
      "device_id": null,
      "receipt": {},
      "error_code": null,
      "source_name": "web"
    },
    {
      "id": 389404469,
      "order_id": 450789469,
      "kind": "authorization",
      "gateway": "bogus",
      "message": null,
      "created_at": "2017-08-01T11:57:11-04:00",
      "test": false,
      "authorization": "authorization-key",
      "status": "success",
      "amount": "409.94",
      "currency": "USD",
      "location_id": null,
      "user_id": null,
      "parent_id": null,
      "device_id": null,
      "receipt": {
        "testcase": true,
        "authorization": "123456"
      },
      "error_code": null,
      "source_name": "web",
      "payment_details": {
        "credit_card_bin": null,
        "avs_result_code": null,
        "cvv_result_code": null,
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      }
    },
    {
      "id": 801038806,
      "order_id": 450789469,
      "kind": "capture",
      "gateway": "bogus",
      "message": null,
      "created_at": "2017-08-05T10:22:51-04:00",
      "test": false,
      "authorization": "authorization-key",
      "status": "success",
      "amount": "250.94",
      "currency": "USD",
      "location_id": null,
      "user_id": null,
      "parent_id": null,
      "device_id": null,
      "receipt": {},
      "error_code": null,
      "source_name": "web"
    }
  ]
}

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 Shopify data up to date

So, now what? You've built a script that pulls data from Shopify and loads it into your data warehouse, but what happens tomorrow when you have new transactions?

The key is to build your script in such a way that it can identify incremental updates to your data. Thankfully, Shopify's API results include fields like created_at 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.

Other data warehouse options

Delta Lake on Databricks 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, or Panoply, which works with Redshift instances. Others choose a data lake, like Amazon S3. 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, To Snowflake, To Panoply, and To S3.

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 Shopify to Delta Lake automatically. With just a few clicks, Stitch starts extracting your Shopify data, structuring it in a way that's optimized for analysis, and inserting that data into your Delta Lake data warehouse.