SSRS Shopify Connector
In this article you will learn how to integrate Using Shopify Connector you will be able to connect, read, and write data from within SSRS. Follow the steps below to see how we would accomplish that. 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. |
See also
|
Video Tutorial - Integrate Shopify data in SSRS
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download / install required driver for
Shopify integration in SSRS - How to configure connection for
Shopify - Features about
API Driver (Authentication / Query Language / Examples / Driver UI) - Using
Shopify Connection in SSRS
Create Data Source in ZappySys Data Gateway based on ZappySys API Driver
-
Download and install ZappySys ODBC PowerPack.
-
Search for gateway in start menu and Open ZappySys Data Gateway:
-
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:
-
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
-
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 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.- 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:
ShopifyDSNAccess 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 Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... -
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:
-
Click OK to finish creating the data source.
Read data in SSRS from ZappySys Data Gateway
- Open Visual Studio and create a new SSRS project
-
Then add a new Shared Data Source (you can create a non-shared data source inside report too):
-
Continue with creating the Shared Data Source. Select Microsoft SQL Server as Type and hit Build button to proceed further:
-
Once a window opens, configure it similarly. Configure "ShopifyDSN" as database name. Finally, hit Test Connection and OK:
ShopifyDSN
-
Another window opens, and it should look similarly to this one below which ends the creation of a Data Source:
-
Now it's time to create a Dataset. If you don't have a report created, in one of the wizard's steps it will look like this:
-
If you did not follow through report's creation wizard and already had report created, you can simply add a new dataset:
-
Finally, once you complete the report, similar results show up:
Passing Parameters to SSRS Report / Filter data
If you want to parameterized your report then refer to this articleCreate 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
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
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>';
-
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';
-
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''')
-
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.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
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'
-
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"
-
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''')
-
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 SSRS and integrate data without any coding. Click here to Download Shopify Connector for SSRS 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 SSRS
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.Parameter | Description |
---|---|
Customer Id(s) - Comma separated |
|
Parameter | Description |
---|---|
Order Id(s) - Comma separated |
|
Parameter | Description |
---|---|
Order Id(s) - Comma separated |
|
Parameter | Description |
---|---|
Product Id(s) - Comma separated |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Product Id(s) - Comma separated |
|
||||||||||||||||||||||||||||||||||||||
Since Product Id |
|
||||||||||||||||||||||||||||||||||||||
Only Fields to Show |
|
||||||||||||||||||||||||||||||||||||||
Created Before |
|
||||||||||||||||||||||||||||||||||||||
Created After |
|
||||||||||||||||||||||||||||||||||||||
Updated Before |
|
||||||||||||||||||||||||||||||||||||||
Updated After |
|
Parameter | Description |
---|---|
Url |
|
Body |
|
IsMultiPart |
|
Filter |
|
Headers |
|
Other App Integration scenarios for Shopify
Other Connectors for SSRS
Download Shopify Connector for SSRS
Documentation
How to connect Shopify in SSRS?
How to get Shopify data in SSRS?
How to read Shopify data in SSRS?
How to load Shopify data in SSRS?
How to import Shopify data in SSRS?
How to pull Shopify data in SSRS?
How to push data to Shopify in SSRS?
How to write data to Shopify in SSRS?
How to POST data to Shopify in SSRS?
Call Shopify API in SSRS
Consume Shopify API in SSRS
Shopify SSRS Automate
Shopify SSRS Integration
Integration Shopify in SSRS
Consume real-time Shopify data in SSRS
Consume realtime Shopify API data in SSRS
Shopify ODBC Driver | ODBC Driver for Shopify | ODBC Shopify Driver | SSIS Shopify Source | SSIS Shopify Destination
Connect Shopify in SSRS
Load Shopify in SSRS
Load Shopify data in SSRS
Read Shopify data in SSRS
Shopify API Call in SSRS