Azure Data Factory (ADF) Shopify Connector In this article you will learn how to integrate Shopify data to Azure Data Factory (ADF) without coding in just a few clicks (live / bi-directional connection to Shopify). 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.. Using Shopify Connector you will be able to connect, read, and write data from within Azure Data Factory (ADF). Follow the steps below to see how we would accomplish that. Download  Help File  Buy  Driver mentioned in this article is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. ODBC PowerPack - System Requirements and Installation Getting Started - Using ODBC PowerPack ODBC API Driver Help File

See also Connect Shopify in SSIS Connect Shopify in SQL Server Connect Shopify in Power BI Connect Shopify in SSRS Connect Shopify in Informatica Connect Shopify in MS Access Connect Shopify in MS Excel Connect Shopify in SSAS Connect Shopify in C# Connect Shopify in Python Connect Shopify in JAVA Connect Shopify in Tableau Connect Shopify in SAP Crystal Reports Connect Shopify in ODBC

Create ODBC Data Source (DSN) based on ZappySys API Driver

To get data from Shopify using Azure Data Factory (ADF) 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 (ADF). Perform these steps:

1. Install ZappySys ODBC PowerPack.

2. Open ODBC Data Sources (x64):
   

3. Create a System Data Source (System DSN) based on ZappySys API Driver

   ZappySys API Driver

   
   You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version. Furthermore, a User DSN may be created instead, but then you will not be able to use the connection from Windows Services (or any application running under a Windows System Account).

4. 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:

   ShopifyDSN

   Shopify

   

5. 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.

    Access Token [Http]

   Steps to get 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.

   1. Visit https://accounts.shopify.com and log into your Shopify store account.
   2. After logging in, select the store to connect to with the ZappySys Shopify Connector.
   3. Select the Settings link (usually in the lower-left corner) to launch the Settings screen.
   4. On the left menu panel, select Apps and sales channels.
   5. On the Apps and sales channels screen, select Develop apps (near the top of the screen).
   6. On the App development screen, select Create an app (near the upper-right corner of the screen).
   7. 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.
   8. Select Configure Admin API scopes and the Admin API access scopes screen will appear.
   9. 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.
      After selecting all applicable access scopes, select Save.
   10. 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.
   11. 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.
   12. 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.
   13. 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.
   14. Select the Test Connection button at the bottom of the window to verify proper connectivity with the Shopify store.
   15. If the connection test succeeds, select OK.

   Fill in all required parameters and set optional parameters if needed:

   ShopifyDSN

   Shopify

   Access Token [Http]

   https://[$Subdomain$].myshopify.com/admin/api/2023-01

   Required Parameters
   Sub-domain	Fill in the parameter...
   Admin API Access Token	Fill in the parameter...
   Optional Parameters
   RetryMode	Fill in the parameter...
   RetryStatusCodeList	Fill in the parameter...
   RetryCountMax	Fill in the parameter...
   RetryMultiplyWaitTime	Fill in the parameter...

   

6. Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
   

7. Click OK to finish creating the data source.

Read data in Azure Data Factory (ADF) from ODBC datasource (Shopify)

1. To start press New button:

   

2. Select "Azure, Self-Hosted" option:

   

3. Select "Self-Hosted" option:

   

4. Set a name, we will use "OnPremisesRuntime":

   

5. Download and install Microsoft Integration Runtime.

6. Launch Integration Runtime and copy/paste Authentication Key from Integration Runtime configuration in Azure Portal:

   

7. After finishing registering the Integration Runtime node, you should see a similar view:

   

8. Go back to Azure Portal and finish adding new Integration Runtime. You should see it was successfully added:

   

9. Go to Linked services section and create a new Linked service based on ODBC:

   

10. Select "ODBC" service:

    

11. Configure new ODBC service. Use the same DSN name we used in the previous step and copy it to Connection string box:

    ShopifyDSN

    DSN=ShopifyDSN

    

12. For created ODBC service create ODBC-based dataset:

    

13. Go to your pipeline and add Copy data connector into the flow. In Source section use OdbcDataset we created as a source dataset:

    

14. 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:

    

15. Finally, run the pipeline and see data being transferred from OdbcDataset to your destination dataset:

    

Create Custom Store Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Store Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
   

2. Enter the desired Procedure name and click on OK:
   

3. Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store procedure in the ZappySys Driver:
   Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
   

   CREATE PROCEDURE [usp_get_orders]
       @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
    AS
       SELECT * FROM Orders where OrderDate >= '<@fromdate>';
   

   
   

4. That's it now go to Preview Tab and Execute your Store Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
   

   Exec usp_get_orders '1996-01-01';

   
   

5. Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
   As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
   

   SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

   
   

6. Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.
   

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
   

2. Enter the desired Table name and click on OK:
   

3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
   Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
   

   SELECT
     "ShipCountry",
     "OrderID",
     "CustomerID",
     "EmployeeID",
     "OrderDate",
     "RequiredDate",
     "ShippedDate",
     "ShipVia",
     "Freight",
     "ShipName",
     "ShipAddress",
     "ShipCity",
     "ShipRegion",
     "ShipPostalCode"
   FROM "Orders"
   Where "ShipCountry"='USA'

   
   

5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
   

   SELECT * FROM "vt__usa_orders_only"

   
   

6. Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
   As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
   

   SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

   
   

7. Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.
   

Conclusion

In this article we discussed how to connect to Shopify in Azure Data Factory (ADF) and integrate data without any coding. Click here to Download Shopify Connector for Azure Data Factory (ADF) and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download Shopify Connector for Azure Data Factory (ADF) Documentation 

Actions supported by Shopify Connector

Shopify Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.

Other App Integration scenarios for Shopify

Other Connectors for Azure Data Factory (ADF)

Download Shopify Connector for Azure Data Factory (ADF) Documentation 

Common Searches: