Shopify Connector for Tableau

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 Tableau without coding. We will use high-performance Shopify Connector to easily connect to Shopify and then access the data inside Tableau.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

Create Data Source in ZappySys Data Gateway based on API Driver

  1. Download and install ODBC PowerPack.

  2. Search for gateway in start menu and Open ZappySys Data Gateway:
    Open ZappySys Data Gateway

  3. Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
    ZappySys Data Gateway - Add User

  4. Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.

    ShopifyDSN

    ZappySys Data Gateway - Add Data Source

  5. 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
    ODBC DSN Template Selection
  6. 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.
    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 RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN HTTP Connection Configuration

  7. 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 - 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.
    ShopifyDSN
    Open Query Builder in API ODBC Driver to read and write data to REST API
  8. 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 Tableau to retrieve data from Shopify. Hit OK button to use this query in the next step.

    SELECT * FROM Products
    Configure table/endpoint parameters in ODBC data source based on API Driver
    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 data much faster.
  9. 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 Tableau:

    ZappySys API Driver - 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.
    ShopifyDSN
    SELECT * FROM Products
    API ODBC Driver-based data source data preview
    You can also access data quickly from the tables dropdown by selecting <Select table>.
    A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole 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).
  10. Click OK to finish creating the data source.

Read data in SQL Server using ZappySys Data Gateway

To read the data in SQL Server, the first thing you have to do is create a Linked Server:

  1. First, let's open SQL Server Management Studio, create a new Linked Server, and start configuring it:

    LS_TO_SHOPIFY_IN_GATEWAY
    Microsoft OLE DB Driver for SQL Server
    localhost,5000
    ShopifyDSN
    ShopifyDSN
    SSMS SQL Server Configure Linked Server
    Choose SQL Server Native Client 11.0 as Provider if you don't see the option shown above.
  2. Then click on Security option and configure username we created in ZappySys Data Gateway in one of the previous steps:

    SSMS SQL Server Configure Linked Server User Name
  3. Optional step. Under the Server Options, Enable RPC and RPC Out and Disable Promotion of Distributed Transactions(MSDTC).

    RPC and MSDTC Settings

    You need to enable RPC Out if you plan to use EXEC(...) AT [LS_TO_SHOPIFY_IN_GATEWAY] rather than OPENQUERY.
    If don't enabled it, you will encounter the Server 'LS_TO_SHOPIFY_IN_GATEWAY' is not configured for RPC error.

    Query Example:

    EXEC('SELECT * FROM Products') AT [LS_TO_SHOPIFY_IN_GATEWAY]


    If you plan to use 'INSERT INTO <TABLE> EXEC(...) AT [LS_TO_SHOPIFY_IN_GATEWAY]' in that case you need to Disable Promotion of Distributed Transactions(MSDTC).
    If don't disabled it, you will encounter the The operation could not be performed because OLE DB provider "SQLNCLI11" for linked server "MY_LINKED_SERVER_NAME" was unable to begin a distributed transaction. error.

    Query Example:

    INSERT INTO dbo.Products
    EXEC('SELECT * FROM Products') AT [LS_TO_SHOPIFY_IN_GATEWAY]
    

  4. Finally, open a new query and execute a query we saved in one of the previous steps:

    SELECT * FROM OPENQUERY([LS_TO_SHOPIFY_IN_GATEWAY], 'SELECT * FROM Products')
    Execute query at Linked Server to ZappySys Data Gateway in SSMS

    SELECT * FROM OPENQUERY([LS_TO_SHOPIFY_IN_GATEWAY], 'SELECT * FROM Products')

Create Linked Server using Code

In previous section you saw how to create a Linked Server from UI. You can do similar action by code too (see below). Run below script after changing necessary parameters. Assuming your Data Source name on ZappySys Data Gateway UI is 'ShopifyDSN'
USE [master]
GO
--///////////////////////////////////////////////////////////////////////////////////////
--Run below code in SSMS to create Linked Server and use ZappySys Drivers in SQL Server
--///////////////////////////////////////////////////////////////////////////////////////

-- Replace YOUR_GATEWAY_USER, YOUR_GATEWAY_PASSWORD
-- Replace localhost with IP/Machine name if ZappySys Gateway Running on different machine other than SQL Server
-- Replace Port 5000 if you configured gateway on a different port


--1. Configure your gateway service as per this article https://zappysys.com/links?id=10036

--2. Make sure you have SQL Server Installed. You can download FREE SQL Server Express Edition from here if you dont want to buy Paid version https://www.microsoft.com/en-us/sql-server/sql-server-editions-express

--Uncomment below if you like to drop linked server if it already exists
--EXEC master.dbo.sp_dropserver @server=N'LS_TO_SHOPIFY_IN_GATEWAY', @droplogins='droplogins'

--3. Create new linked server

EXEC master.dbo.sp_addlinkedserver
    @server = N'LS_TO_SHOPIFY_IN_GATEWAY'  --Linked server name (this will be used in OPENQUERY sql
, @srvproduct=N''
---- For MSSQL 2012,2014,2016 and 2019 use below (SQL Server Native Client 11.0)---
, @provider=N'SQLNCLI11'
---- For MSSQL 2022 or higher use below (Microsoft OLE DB Driver for SQL Server)---
--, @provider=N'MSOLEDBSQL'
, @datasrc=N'localhost,5000' --//Machine / Port where Gateway service is running
, @provstr=N'Network Library=DBMSSOCN;'
, @catalog=N'ShopifyDSN' --Data source name you gave on Gateway service settings

--4. Attach gateway login with linked server

EXEC master.dbo.sp_addlinkedsrvlogin
@rmtsrvname=N'LS_TO_SHOPIFY_IN_GATEWAY'  --linked server name
, @useself=N'False'
, @locallogin=NULL
, @rmtuser=N'YOUR_GATEWAY_USER' --enter your Gateway user name
, @rmtpassword='YOUR_GATEWAY_PASSWORD'  --enter your Gateway user's password
GO

--5. Enable RPC OUT (This is Optional - Only needed if you plan to use EXEC(...) AT YourLinkedServerName rather than OPENQUERY
EXEC sp_serveroption 'LS_TO_SHOPIFY_IN_GATEWAY', 'rpc', true;
EXEC sp_serveroption 'LS_TO_SHOPIFY_IN_GATEWAY', 'rpc out', true;

--Disable MSDTC - Below needed to support INSERT INTO from EXEC AT statement
EXEC sp_serveroption 'LS_TO_SHOPIFY_IN_GATEWAY', 'remote proc transaction promotion', false;

--Increase query timeout if query is going to take longer than 10 mins (Default timeout is 600 seconds)
--EXEC sp_serveroption 'LS_TO_SHOPIFY_IN_GATEWAY', 'query timeout', 1200;
GO

Create View in SQL Server

Finally, use this or similar query in a view or stored procedure, which you will be able to use in Tableau. We will create a view to return invoices:

  1. CREATE VIEW vwApiInvoices AS
     SELECT * FROM OPENQUERY([LS_TO_SHOPIFY_IN_GATEWAY], 'SELECT * FROM Invoices')

Read data in Tableau from SQL Server

Actually, we will be getting data from SQL Server which in turn will be getting data from ZappySys Data Gateway data source. Let's begin and see how to accomplish that:

  1. Open Tableau Desktop and click File > New
  2. To create new Connection click More > Microsoft SQL Server > Enter your credentials to connect to SQL Server (in our example before we used tdsuser): Tableau connect to SQL Server
  3. Once connection is created for SQL Server we can read Shopify data 3 different ways:
    1. Query View which contains OPENQUERY to Linked Server for Shopify data
    2. Use direct SQL Query using OPENQUERY
    3. Use Stored Procedure (Mostly useful to parameterize calls
  4. See below example to pull data from Shopify in Tableau using SQL View approach: Create data source in Tableau
  5. Once your data sources are created you can click on Sheet1 and drag fields to create visualizations for Tableau Dashboard: Create data source in Tableau

Passing Parameters to Shopify calls in Tableau (Dynamic SQL)

Now let's look at scenario where you have to pass parameters to build Dynamic Dashboard. You can try to insert Parameters in your Direct SQL when you build Dynamic SQL but we found some issues with that so we are going to suggest Stored Procedure approach. For more information on Known issue on Dynamic Metadata Check this post.
  1. First lets create a stored procedure in SQL Server for Parameter Example. Notice how we added WITH RESULT SETS in the code to describe metadata.
    --DROP PROC dbo.usp_GetInvoicesByCountry
    --GO
    /*
    Purpose: Parameterize Shopify call via SQL. Call ZappySys Drivers inside SQL Server.
    */
    CREATE PROC dbo.usp_GetInvoicesByCountry
    	@country varchar(100) 
    AS 
    
    DECLARE @sql varchar(max)
    --//Escape single ticks carefully
    SET @sql =  'SELECT OrderID,CustomerID,Country,Quantity FROM $
    WITH (Src=''https://services.odata.org/V3/Northwind/Northwind.svc/Invoices?$format=json@filter=Country eq '+ @country +'''
    	 ,Filter=''$.value[*]''
    	 ,DataFormat=''OData''
    )'
    
    DECLARE @sqlFull varchar(max)
    SET @sqlFull='SELECT * FROM OPENQUERY([LS_TO_SHOPIFY_IN_GATEWAY], ''' + REPLACE( @sql, '''', '''''' ) + ''' )'
    PRINT @sqlFull --//For DEBUG purpose
    
    EXECUTE (@sqlFull) 
    WITH RESULT SETS ( 
     (OrderID int,CustomerID varchar(100),Country varchar(100),Quantity int) --//describe first result. If you don't do this then wont work in Tableau 
    )
    GO
    -- Example call
    EXEC dbo.usp_GetInvoicesByCountry @country='Germany'
  2. Once you create a stored procedure go to Tableau datasource and select Database which contains the stored procedure we just created.
  3. Now find your stored proc and drag it on the datasource pane. You will see parameters UI as below. You can create new parameter - Select New Parameter under Value Column. Parameterize Tableau Shopify datasource (Stored Procedure Parameters)
  4. Thats it now you can reuse your parameterized datasource anywhere in Dashboard.
  5. If you have need to select Parameters from predefined values rather than free text then edit your parameter and select List option. Define values you like to select from as below. Allow Tableau Parameter selection from multiple values
  6. When you create Tableau Dashboard you will see Parameter dropdown (If you selected List) elase you may see Textbox to enter custom value. Tableau Dashboard Example - REST API Source with Parameterized Datasource

Firewall settings

So far we have assumed that Gateway is running on the same machine as SQL Server. However there will be a case when ZappySys ODBC PowerPack is installed on a different machine than SQL Server. In such case you may have to perform additional Firewall configurations. On most computers firewall settings wont allow outside traffic to ZappySys Data Gateway. In such case perform following steps to allow other machines to connect to Gateway.

Method-1 (Preferred)

If you are using newer version of ZappySys Data Gateway then adding firewall rule is just a single click.

  1. Search for gateway in start menu and open ZappySys Data Gateway.
  2. Go to Firewall Tab and click Add Firewall Rule button like below. This will create Firewall rule to all Inbound Traffic on Port 5000 (Unless you changed it). Allow Inbound Traffic - Add Firewall Rule for ZappySys Data Gateway

Method-2 Here is another way to add / edit Inbound Traffic rule in windows firewall. Use below method if you choose to customize your rule (for advanced users).
  1. Search for Windows Firewall Advanced Security in start menu.
  2. Under Inbound Rules > Right click and click [New Rule] >> Click Next
  3. Select Port on Rule Type >> Click Next
  4. Click on TCP and enter port number under specified local port as 5000 (use different one if you changed Default port) >> Click Next
  5. Select Profile (i.e. Private, Public) >> Click Next
  6. Enter Rule name [i.e. ZappySys Data Gateway – Allow Inbound ] >> Click Next
  7. Click OK to save the rule
SQL Server Firewall Allow Inbound Data Gateway

Actions supported by Shopify Connector

Learn how to perform common Shopify actions directly in Tableau with these how-to guides:

Conclusion

In this article we showed you how to connect to Shopify in Tableau 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 Tableau 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 Tableau Documentation

More integrations

Other connectors for Tableau

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

Other application integration scenarios for Shopify

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications

  • How to connect Shopify in Tableau?

  • How to get Shopify data in Tableau?

  • How to read Shopify data in Tableau?

  • How to load Shopify data in Tableau?

  • How to import Shopify data in Tableau?

  • How to pull Shopify data in Tableau?

  • How to push data to Shopify in Tableau?

  • How to write data to Shopify in Tableau?

  • How to POST data to Shopify in Tableau?

  • Call Shopify API in Tableau

  • Consume Shopify API in Tableau

  • Shopify Tableau Automate

  • Shopify Tableau Integration

  • Integration Shopify in Tableau

  • Consume real-time Shopify data in Tableau

  • Consume real-time Shopify API data in Tableau

  • Shopify ODBC Driver | ODBC Driver for Shopify | ODBC Shopify Driver | SSIS Shopify Source | SSIS Shopify Destination

  • Connect Shopify in Tableau

  • Load Shopify in Tableau

  • Load Shopify data in Tableau

  • Read Shopify data in Tableau

  • Shopify API Call in Tableau