If you want to create data sources for custom Klips, you're in the right place.
If you want to add pre-built Klips, see Pre-built Klips and the Klip Gallery and Klip Gallery: Shopify.
If you're using PowerMetrics and want to create data sources for custom metrics, go here.
Visualize, discover, and act on your data with Klips and Klip dashboards.
Ready to get the most from your Shopify ecommerce and point of sale data? Get started by setting up a connection between Klipfolio and your Shopify data and adding some data sources.
When you're finished adding Shopify data sources, you'll use them to power your custom Klips.
This article includes:
- Connecting to your Shopify data
- Adding a Shopify pre-built or custom data source
- Pagination: Managing the number of query responses
- Custom building: About APIs and queries
- I've added Shopify data sources - What's next?
Connecting to your Shopify data
Here are a few things to note about connecting Klipfolio to your Shopify data:
Your data is safe with us. The first time you connect your Shopify data to Klipfolio, you'll be prompted to sign in to Shopify and give permission to allow Klipfolio to securely access data within your Shopify account. We are serious about protecting your data privacy.
Managing your connections. By default, your connection name looks like this: yourname@Shopify <date and time created>. You can modify the default connection name when you create a new connection or from your list of connections, accessed by clicking your Account Name (located at the bottom of the left navigation sidebar) and selecting Account > Connected Accounts or by clicking the button in the left navigation sidebar and selecting Connections.
You can use and reuse the same account connection every time you connect to Shopify. If you have trouble accessing an existing connection, your OAuth token may have expired. If that happens to you, check out these troubleshooting tips.
Setting permissions in Shopify. To integrate with Klipfolio, you install our app in your Shopify store. Before doing this, you need to ensure you’re enabled with the right set of permissions in Shopify. Note: If you’re the store owner or administrator you likely already have all the necessary permissions.
To set permissions, in Shopify, click Settings > Users and permissions and choose the desired Staff member. Select permissions as shown below. Go here if you want to learn more about Shopify staff permissions.
Adding a Shopify pre-built or custom data source
Our pre-built data sources focus on the most sought-after Shopify data. Either use them as complete solutions or as starting points for custom building.
Need a unique set of data? When our pre-built data sources don't include exactly what you're looking for, create your own custom data source. You can either use a pre-built data source query as a base or write your own queries from scratch.
To add a Shopify pre-built or custom data source:
- Click the + beside Data Sources in the left navigation sidebar.
If you don’t see the option above, go to the bottom of the left navigation sidebar and click your Account Name > Data Sources > Create a New Data Source instead.
- On the Where is your data? page, select Shopify.
- Select a pre-built data source from the left section of the Choose a pre-built or custom connection page or click Create a custom Shopify data source.
- If this is your first time connecting to Shopify:
- Enter your Shop Name and click Continue.
- Click Connect an account.
- Enter your Shopify email and click Continue.
- Enter your Shopify password and click Log in.
- Enter your Authentication code and click Log in.
- On the Name new connection screen, optionally, change the connection name and click Apply.
- Click Continue.
- If you have connected with Shopify before:
- Enter your Shop Name and click Continue.
- Select an existing connection (account) from the drop-down list and click Continue.
- On the Configure your data source page, use the information in the URL text box as a base and modify it to get the specific data you're looking for. Make sure you replace <yourShopName> with your own shop name.
Need help writing your query? Refer to the Shopify API documentation for more information.
- Choose whether or not to Paginate. Learn more here.
- Click Get data.
- Ensure this is the data you’re looking for and, optionally, select the checkbox to Model your data. Learn more about modelling your data source. Note: Shopify returns JSON formatted data. Learn how to model JSON data.
- Click Continue.
- Name, choose refresh settings, and, optionally, share your data source.
- Click Save.
The data source is added to your account and is ready to use for custom Klips. You can see all your data sources in your Data Source Library, accessed by clicking Data Sources in the left navigation sidebar (or by going to the bottom of the left navigation sidebar and clicking your Account Name > Data Sources).
Pagination: Managing the number of query responses
To manage the number of query responses, you can:
- Paginate your response by selecting the Paginate option. This action returns the most data.
Note: Shopify has replaced page-based pagination with cursor-based pagination. If the end-point in your URL includes a Shopify API version that doesn’t support cursor-based pagination your query will only return 50 records. To avoid this issue, we recommend removing the api/<version>
portion from your query, as in our sample queries below.
- Add limits to your query. To get a specific number of responses, add a limits parameter to your query.
For example, https://<yourShopName>.myshopify.com/admin/orders.json?limit=100
.
Note: If you add limits to your query, make sure Paginate is not selected because it will override the limits you set.
- Let Klipfolio manage the number of responses. If you don't select Paginate or add limits, Klipfolio will return 50 responses.
Custom building: About APIs and queries
Want to learn more about custom building? This section is for you. Klipfolio connects to hundreds of services in the cloud that have a REST API. If you take the time to learn your service’s API to create queries for the data you want, your possibilities are endless. Here’s a quick overview video on APIs and Klipfolio:
If you need help using APIs, ask a data analyst or developer.
Refer to the Shopify API documentation to discover more data requests.
See the reference table below for API related information and sample queries.
API Documentation | Shopify API documentation |
Authentication Method |
OAuth Token Authentication |
Response Format | JSON |
Sample Queries |
For orders:
For products:
For shop information:
For countries: |
Next steps
Great! You've connected to your Shopify data and created one (or more) data sources. Now you're ready to use those data sources in custom Klips.
Want to learn more?
Check out these related articles: