ingestr

Appearance

Shopify ​

Shopify is a comprehensive e-commerce platform that enables individuals and businesses to create online stores.

ingestr supports Shopify as a source.

URI format ​

The URI format for Shopify is as follows:

plaintext
shopify://<shopify store URL>?api_key=token

URI parameters:

  • shopify store URI: the URL of the Shopify store you'd like to connect to, e.g. myawesomestore.myshopify.com
  • api_key: the API key used for authentication with the Shopify API

The URI is used to connect to the Shopify API for extracting data. More details on setting up Shopify integrations can be found here.

Setting up a Shopify Integration ​

Shopify requires a few steps to set up an integration, please follow the guide dltHub has built here.

Once you complete the guide, you should have an API key and the store name to connect to. Let's say your API key is shpkey_12345 and the store you'd like to connect to is my-store, here's a sample command that will copy the data from the Shopify store into a DuckDB database:

sh
ingestr ingest --source-uri 'shopify://my-store.myshopify.com?api_key=shpkey_12345' --source-table 'orders' --dest-uri duckdb:///shopify.duckdb --dest-table 'shopify.orders'

The result of this command will be a table in the shopify.duckdb database with JSON columns.

Tables ​

Shopify source allows ingesting the following sources into separate tables:

  • orders
  • customers
  • discounts: Uses the GraphQL API, discountNodes query, take a look at the Shopify docs for more details.
  • products
  • inventory_items
  • transactions
  • balance
  • events
  • price_rules: this is a deprecated table, please use discounts instead.

Use these as --source-table parameter in the ingestr ingest command.