Shopify Legacy Setup Guide
Prerequisites
- Access to a Shopify store
- A private app for your Shopify store:
- Go to
https://admin.shopify.com/store/YOURSTORE/settings/apps/development. - Enable private development if it isn't enabled.
- Create a private application by clicking on Create an app.
- Click on Configure Admin API scopes and select the resources you want to allow access to. Matia only needs read-level access.
Note: 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. - 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!
- Go to
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 Admin API Token for your private application in your Shopify store.
- (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 Streams
This connector outputs the following streams:
- Abandoned Checkout
- Balance Transaction
- Collection
- Company
- Country
- Customer
- Discount Code
- Dispute
- Draft Order
- Fulfillment
- Gift Card
- Inventory_Item
- Location
- Metafield
- Order
- Payout
- Product
- Product Variant
- Refund
- [Shopify Plus] Staff Member
- Tender_Transaction
- Transaction
Supported Sync Modes
- Full Refresh
- Incremental