Shopify Setup Guide
Prerequisites
- Access to a Shopify store
- A custom or legacy custom app for your Shopify store.
With a custom app:
- Log in to your Shopify account.
- Go to the Dev Dashboard.
- On the navigation menu, select Apps and then click Create app.
- In the Start from Dev Dashboard section, enter an App name.
- Click Create.
- Select the
2025-10Webhooks API Version from the drop-down menu. - 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
Note: By default, only the last 60 days' worth of orders can be retrieved for a shop. To access all orders, request access to the
read_all_ordersscope from Shopify.
- You can leave all other sections and fields unchanged.
- Click Release.
- On the navigation menu in the Dev Dashboard, navigate to your app name.
- Click on Install App. You will be redirected to your Shopify account, where you can select the store in which you want to install the custom app.
- On the navigation menu in the Dev Dashboard, click your app name and select Settings.
- In the Credentials section, make a note of the client ID and client secret.
With a legacy app:
-
Log in to your Shopify account.
-
On the left-hand navigation menu, click on Apps, and then select App and sales channel settings.
-
Click on Develop apps, then Create an app.
-
Enter a name and developer for your app and select Create app.
-
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_all_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* By default, only the last 60 days' worth of orders can be retrieved for a shop. To access all orders, request access to the
read_all_ordersscope from Shopify.The Staff Member stream is restricted to Shopify Plus accounts and requires the
read_usersaccess scope. You will need to contact Shopify to enable this scope for your app. -
Click on Install App.
-
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
- Enter the Shop Name for your Shopify store. For example, if your URL was
https://NAME.myshopify.com, then the name would beNAME. - Enter the credentials you obtained earlier.
- (Optional) Enter a Replication Start Date. If present, any data before this date will not be replicated. Not supported by all streams.
- Enter a Name for the connector.
- (Optional) Enter a Description for the connector.
- Select the Owner of the connector.
- (Optional) Verify that your Shopify account is successfully connected by clicking on Test Connection.
- 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 Memberandstaff_member_id. - We sync metafields for the following tables:
Collection,Customer,Draft Order,Order,Product,Product VariantandShop. - 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