Shopify Connector for Azure Data Factory (Pipeline)Shopify Connector can be used to integrate Shopify REST API in your App / BI Tools. You can read/write data about Customers, Orders, OrderItems, Products and more. In this article you will learn how to quickly and efficiently integrate Shopify data in Azure Data Factory (Pipeline) without coding. We will use high-performance Shopify Connector to easily connect to Shopify and then access the data inside Azure Data Factory (Pipeline). Let's follow the steps below to see how we can accomplish that! Shopify Connector for Azure Data Factory (Pipeline) is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few. |
Connect to Shopify in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from Shopify using Azure Data Factory (Pipeline) we first need to create a DSN (Data Source) which will access data from Shopify. We will later be able to read data using Azure Data Factory (Pipeline). Perform these steps:
-
Download and install ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User data source (User DSN) based on ZappySys API Driver
ZappySys API Driver-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
in design-time , when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit. -
Create and use System DSN
if the client application is launched under a System Account, e.g. as a Windows Service.
Usually, this is an ideal option to use
in a production environment . Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
Azure Data Factory (Pipeline) uses a Service Account, when a solution is deployed to production environment, therefore for production environment you have to create and use a System DSN. -
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
-
When the Configuration window appears give your data source a name if you haven't done that already, then select "Shopify" from the list of Popular Connectors. If "Shopify" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
ShopifyDSNShopify -
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
Steps how to get and use Shopify credentials : Access Token [Http]
Setting up your Shopify store account for API access involves creating an "app" for your store. The "app" is installed into the Shopify account and configured with the appropriate access levels for your data integration needs.- Visit https://accounts.shopify.com and log into your Shopify store account.
- After logging in, select the store to connect to with the ZappySys Shopify Connector.
- Select the Settings link (usually in the lower-left corner) to launch the Settings screen.
- On the left menu panel, select Apps and sales channels.
- On the Apps and sales channels screen, select Develop apps (near the top of the screen).
- On the App development screen, select Create an app (near the upper-right corner of the screen).
- Give the app that will be used to provide Shopify API access a name, select the appropriate developer from the App developer drop-down, and then select Create app.
- Select Configure Admin API scopes and the Admin API access scopes screen will appear.
-
In the Admin API access scopes screen, select every access scope checkbox that applies to your integration needs. It is generally not a good idea to allow more access than what is needed in order to fulfill your integration needs.
- To enable the reading of customer information, select read_customers.
- To enable the writing of customer information, select write_customers.
- To enable the reading of inventory item information, select read_inventory.
- To enable the writing of inventory item information, select write_inventory.
- To enable the reading of order information, select read_orders.
- To enable the writing of order information, select write_orders.
- Install the app by selecting the Install app button (near the upper-right corner of the screen). If any other prompts for installation appears, select Install.
- After the app is installed, the Admin API access token will be available in the API credentials tab of the page. It can only be revealed ONCE for security purposes. Select Reveal token once to show the new Admin API access token. SAVE THE ADMIN API ACCESS TOKEN IN A SAFE PLACE WHERE YOU HAVE IT CONFIDENTIAL, SECURE, AND NOT ACCESSIBLE TO UNAUTHORIZED INDIVIDUALS. The Admin API access token will be needed in this process later.
- In the ZappySys connector API screen, enter the subdomain of your Shopify store into the Subdomain parameter textbox. For example, if your Shopify URL is https://acmetoys.myshopify.com, the subdomain would be acmetoys.
- In the same screen, enter the Admin API access token saved from step 11 above into the Admin API Access Token textbox. In order to edit the text in this field, select the ellipses (...) button that appears when the textbox is clicked and edit the access token with the dialog box that appears.
- Select the Test Connection button at the bottom of the window to verify proper connectivity with the Shopify store.
- If the connection test succeeds, select OK.
Fill in all required parameters and set optional parameters if needed:
ShopifyDSNShopifyAccess Token [Http]https://[$Subdomain$].myshopify.com/admin/api/2023-01Required Parameters Sub-domain Fill-in the parameter... Admin API Access Token Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True -
Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:
ZappySys API Driver - ShopifyShopify Connector can be used to integrate Shopify REST API in your App / BI Tools. You can read/write data about Customers, Orders, OrderItems, Products and more.ShopifyDSN -
Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in Azure Data Factory (Pipeline) to retrieve data from Shopify. Hit OK button to use this query in the next step.
SELECT * FROM Products
Some parameters configured in this window will be passed to the Shopify API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful datamuch faster . -
Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in Azure Data Factory (Pipeline):
ZappySys API Driver - ShopifyShopify Connector can be used to integrate Shopify REST API in your App / BI Tools. You can read/write data about Customers, Orders, OrderItems, Products and more.ShopifyDSNSELECT * FROM Products
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHERE
clause,LIMIT
keyword will be performed on the client side, meaning that thewhole result set will be retrieved from the Shopify API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Shopify servers). -
Click OK to finish creating the data source.
Video Tutorial
Read data in Azure Data Factory (ADF) from ODBC datasource (Shopify)
-
To start press New button:
-
Select "Azure, Self-Hosted" option:
-
Select "Self-Hosted" option:
-
Set a name, we will use "OnPremisesRuntime":
-
Download and install Microsoft Integration Runtime.
-
Launch Integration Runtime and copy/paste Authentication Key from Integration Runtime configuration in Azure Portal:
-
After finishing registering the Integration Runtime node, you should see a similar view:
-
Go back to Azure Portal and finish adding new Integration Runtime. You should see it was successfully added:
-
Go to Linked services section and create a new Linked service based on ODBC:
-
Select "ODBC" service:
-
Configure new ODBC service. Use the same DSN name we used in the previous step and copy it to Connection string box:
ShopifyDSNDSN=ShopifyDSN -
For created ODBC service create ODBC-based dataset:
-
Go to your pipeline and add Copy data connector into the flow. In Source section use OdbcDataset we created as a source dataset:
-
Then go to Sink section and select a destination/sink dataset. In this example we use precreated AzureBlobStorageDataset which saves data into an Azure Blob:
-
Finally, run the pipeline and see data being transferred from OdbcDataset to your destination dataset:
Actions supported by Shopify Connector
Learn how to perform common Shopify actions directly in Azure Data Factory (Pipeline) with these how-to guides:
- Create a Customer
- Create a Location
- Create a Product
- Create a Product Variant
- Create an Order
- Delete a Customer
- Delete a Location
- Delete a product
- Delete a product variant
- Delete an Order
- Get Customer
- Get Customers
- Get Inventory Item
- Get Inventory Items
- Get Inventory Levels
- Get Location
- Get Locations
- Get Order
- Get Order Items
- Get Orders
- Get Orders Count
- Get Payouts
- Get Product
- Get Product Variants
- Get Products
- Get Products Count
- Insert Inventory Levels
- Update a Customer
- Update a Location
- Update a Product
- Update a Product Variant
- Update an Order
- Update Inventory Item
- Update Inventory Levels
- Generic Request
- Generic Request (Bulk Write)
Conclusion
In this article we showed you how to connect to Shopify in Azure Data Factory (Pipeline) and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Shopify, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).
We encourage you to download Shopify Connector for Azure Data Factory (Pipeline) and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.
Download Shopify Connector for Azure Data Factory (Pipeline) Documentation
More integrations
Other connectors for Azure Data Factory (Pipeline)
Other application integration scenarios for Shopify
How to connect Shopify in Azure Data Factory (Pipeline)?
How to get Shopify data in Azure Data Factory (Pipeline)?
How to read Shopify data in Azure Data Factory (Pipeline)?
How to load Shopify data in Azure Data Factory (Pipeline)?
How to import Shopify data in Azure Data Factory (Pipeline)?
How to pull Shopify data in Azure Data Factory (Pipeline)?
How to push data to Shopify in Azure Data Factory (Pipeline)?
How to write data to Shopify in Azure Data Factory (Pipeline)?
How to POST data to Shopify in Azure Data Factory (Pipeline)?
Call Shopify API in Azure Data Factory (Pipeline)
Consume Shopify API in Azure Data Factory (Pipeline)
Shopify Azure Data Factory (Pipeline) Automate
Shopify Azure Data Factory (Pipeline) Integration
Integration Shopify in Azure Data Factory (Pipeline)
Consume real-time Shopify data in Azure Data Factory (Pipeline)
Consume real-time Shopify API data in Azure Data Factory (Pipeline)
Shopify ODBC Driver | ODBC Driver for Shopify | ODBC Shopify Driver | SSIS Shopify Source | SSIS Shopify Destination
Connect Shopify in Azure Data Factory (Pipeline)
Load Shopify in Azure Data Factory (Pipeline)
Load Shopify data in Azure Data Factory (Pipeline)
Read Shopify data in Azure Data Factory (Pipeline)
Shopify API Call in Azure Data Factory (Pipeline)