Learn about our Shopify integration
Shopify is an ecommerce platform that helps SMBs to sell their products online.
With Codat's Shopify integration, you can securely retrieve your SMB customers' commerce transactions, standardized to our commerce data model.
Data type coverage
View the coverage of our Shopify integration in the Data Coverage Explorer.
Approaches to merchant data sharing
When setting up the integration, you can take one of two approaches for enabling your merchants to connect and share their commerce data, as follows:
Created by merchants exclusively for their Shopify stores.
Built by you and must be approved by Shopify before use. A single public app can be installed on multiple Shopify stores.
In general, custom apps require less initial setup, with tasks completed by the merchant. Public apps require more initial setup, with tasks completed by you, the Codat client. Choose the option that best suits your circumstances.
About custom apps
A custom app is exclusively linked to a merchant's individual Shopify store and can't be linked to multiple stores. Custom apps are not listed on the Shopify app store or subject to Shopify's app approval process. With this approach, each merchant creates a custom app in their Shopify store.
Custom apps use API access tokens (API keys) for authentication.
There are no additional provider requirements when using this approach.
To connect their commerce data using a custom app, the merchant does the following:
- Creates a custom app and assigns it the required API scopes.
- Gets the API access token for the app.
- Enters the access token in Link.
To get started, see Set up Shopify using custom apps.
About public apps
Public apps are built to connect to multiple Shopify stores owned by multiple merchants. This means you can use a single public app to access data from multiple different merchant stores.
Public apps offer a low-friction way for merchants to link their commerce data to Codat. With this approach, you build a single public app and use its secure credentials to authorize your access to Shopify commerce data.
Listed apps are published on the Shopify app store whereas unlisted apps are not. Only listed apps can be discovered directly from the app store by merchants.
Public apps use an OAuth 2.0 authentication flow.
If you choose this connection method, you need to do the following:
Create a public app that's configured with a Codat redirect URL, webhooks, and the required permissions.
Submit your app to Shopify for approval before production use.
If your app is approved, enter its secure credentials in the Codat Portal.
If you choose this connection method, you should be aware of Shopify's requirements for public apps, as well as the specific functionality that your app will need to provide. These are outlined in Requirements for public apps.
To get started, see Set up Shopify using public apps.
OAuth requirements to apps
If your app is not yet installed or being reinstalled, it must direct the user to their OAuth journey. To comply with this, you need a basic mapping of the Shopify store to a Codat company, which then generates a Link URL that redirects the user either to the OAUth screen, or to your app's dashboard.