Shopify is an e-commerce platform that allows businesses to create and manage their online stores, sell products, and handle payments and shipping.

Shopify is a cloud-based e-commerce platform that provides businesses with the tools they need to create and manage their online stores. With Shopify, businesses can easily set up an online store, customize the design and layout, add products, and manage inventory. The platform also includes features for handling payments, shipping, and taxes, as well as tools for marketing and analytics. Shopify is designed to be user-friendly and accessible to businesses of all sizes, from small startups to large enterprises. It offers a range of pricing plans to suit different needs and budgets, and provides 24/7 customer support to help businesses get the most out of the platform.

Prerequisites

To obtain an Access Token for Shopify, you need to follow these steps:

1. Log in to your Shopify account.
2. Click on the Apps tab on the left-hand side of the screen.
3. Click on the Manage private apps link at the bottom of the page.
4. Click on the Create a new private app button.
5. Enter a name for your private app and provide an email address for the developer.
6. Under the Admin API section, select the areas of your store that you want the app to have access to.
7. Click on the Save button to create the private app.
8. On the next screen, you will see the API key and password for your private app. Use these to generate an Access Token.

To obtain the Store URL for Shopify, you need to follow these steps:

1. Log in to your Shopify account.
2. Click on the Online Store tab on the left-hand side of the screen.
3. Click on the Domains link at the top of the page.
4. Your store URL will be displayed under the Primary domain section.

Settings

Access Token

A unique code that allows an application to access a Shopify store's data.

Store

The name or URL of the Shopify store that the application will connect to.

Start Date

The date from which the application will start retrieving data from the Shopify store.

Admin URL

The Admin URL of the Shopify store (e.g. https://your-store.myshopify.com/admin). Overrides the 'store' setting when provided.

Is Plus Account

Set to true to expose streams compatible with Shopify Plus accounts:

• users
• giftcard
• multipass
• publishablepublish
• publishableunpublish

ShopifyQL Queries

List of ShopifyQL queries to sync as individual streams. Each entry produces one table in your destination. Add as many entries as needed — no code changes are required.

Each query object supports the following fields:

• name (required): Stream name — becomes the table name in your destination. Use lowercase letters, numbers, and underscores only. Treat as immutable after the first sync; renaming orphans the old table and creates a new empty one.
• query (required): The full ShopifyQL query string, written exactly as you would in the Shopify Analytics query editor. SINCE/UNTIL dates must be set explicitly — the tap does not inject start_date automatically. All values are returned as strings; cast to numeric or date types in your dbt models.
• primary_keys (optional): List of column names that uniquely identify a row. Required for destinations that enforce a primary key (e.g. target-bigquery).
• replication_key (optional): Column name to use as the replication key for incremental syncs. When set, the tap reads the last synced value from state and injects or replaces the SINCE clause on subsequent runs. Also set replication-method: INCREMENTAL and replication-key in Meltano stream metadata. Omit for full-refresh streams.

Example:

shopifyql_queries:
  - name: sales_over_time
    primary_keys: [day]
    replication_key: day
    query: >
      FROM sales
        SHOW orders, gross_sales, net_sales, total_sales
        TIMESERIES day
        SINCE 2024-01-01 UNTIL today
        ORDER BY day ASC
        LIMIT 1000