Skip to main content

Shopify Setup Guide

Prerequisites

With a custom app:

  1. Log in to your Shopify account.
  2. Go to the Dev Dashboard.
  3. On the navigation menu, select Apps and then click Create app.
  4. In the Start from Dev Dashboard section, enter an App name.
  5. Click Create.
  6. Select the 2025-10 Webhooks API Version from the drop-down menu.
  7. In the Scopes field in the Access section, enter the following scopes:

read_analytics, read_assigned_fulfillment_orders, read_companies, read_content, read_customers, read_discounts, read_draft_orders, read_files, read_fulfillments, read_gift_cards, read_inventory, read_locales, read_locations, read_marketing_events, read_merchant_managed_fulfillment_orders, read_orders, read_price_rules, read_product_listings, read_products, read_publications, read_reports, read_returns, read_resource_feedbacks, read_script_tags, read_shipping, read_shopify_payments_accounts, read_shopify_payments_disputes, read_shopify_payments_payouts, read_themes, read_third_party_fulfillment_orders, read_translations

  1. You can leave all other sections and fields unchanged.
  2. Click Release.
  3. On the navigation menu in the Dev Dashboard, navigate to your app name and select Home.
  4. In the Distribution section, click Select distribution method.
  5. Select the Custom distribution option and click Select.
  6. In the confirmation dialog box, click Select custom distribution.
  7. In the Custom distribution section, enter the domain of your Shopify store.
  8. Click Generate link.
  9. Copy the generated link and paste it into your browser. You will be redirected to your Shopify account, where you can select the store in which you want to install the custom app.
  10. On the navigation menu in the Dev Dashboard, click your app name and select Settings.
  11. In the Credentials section, make a note of the client ID and client secret.

With a legacy app:

  1. Log in to your Shopify account.

  2. On the left-hand navigation menu, click on Apps, and then select App and sales channel settings.

  3. Click on Develop apps, then Create an app.

  4. Enter a name and developer for your app and select Create app.

  5. Configure the Admin API scopes for your app. Matia only needs read-level access:

    read_analytics
    read_assigned_fulfillment_orders
    read_companies
    read_content
    read_customers
    read_discounts
    read_draft_orders
    read_files
    read_fulfillments
    read_gift_cards
    read_inventory
    read_locales
    read_locations
    read_marketing_events
    read_merchant_managed_fulfillment_orders
    read_orders
    read_price_rules
    read_product_listings
    read_products
    read_publications
    read_reports
    read_returns
    read_resource_feedbacks
    read_script_tags
    read_shipping
    read_shopify_payments_accounts
    read_shopify_payments_disputes
    read_shopify_payments_payouts
    read_themes
    read_third_party_fulfillment_orders
    read_translations

    Note: The Staff Member stream is restricted to Shopify Plus accounts and requires the read_users access scope. You will need to contact Shopify to enable this scope for your app.

  6. Click on Install App.

  7. Find your Admin API Token under the API credentials section. You will be able to view this token only once, so make sure to save it!

Setup Guide

  1. Enter the Shop Name for your Shopify store. For example, if your URL was https://NAME.myshopify.com, then the name would be NAME.
  2. Enter the Admin API Token for your private application in your Shopify store.
  3. (Optional) Enter a Replication Start Date. If present, any data before this date will not be replicated. Not supported by all streams.
  4. Enter a Name for the connector.
  5. (Optional) Enter a Description for the connector.
  6. Select the Owner of the connector.
  7. (Optional) Verify that your Shopify account is successfully connected by clicking on Test Connection.
  8. Click Connect.

Notes

  • Shopify's REST Admin API is legacy as of October 1, 2024. Wherever possible, we leverage the newer GraphQL API instead. The choice of API for a particular stream depends on factors such as data availability, endpoint utility and rate limiting.
  • We support Shopify Plus accounts. You will be able to sync data for restricted streams and properties such as Staff Member and staff_member_id.
  • We sync metafields for the following tables: Collection, Customer, Draft Order, Order, Product, Product Variant and Shop.
  • If an update in a child object does not trigger an update in its parent object, we cannot capture it until the parent object is updated.

Supported Sync Modes

  • Full Refresh
  • Incremental