Shopify Connector for SSISShopify 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 SSIS without coding. We will use high-performance Shopify Connector to easily connect to Shopify and then access the data inside SSIS. Let's follow the steps below to see how we can accomplish that! Shopify Connector for SSIS is based on ZappySys API Connector Framework which is a part of SSIS PowerPack. It is a collection of high-performance SSIS connectors that enable you to integrate data with virtually any data provider supported by SSIS, including SQL Server. SSIS PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few (if you are new to SSIS and SSIS PowerPack, find out more on how to use them). |
Connect to Shopify in other apps
|
Video Tutorial - Integrate Shopify data in SSIS
This video covers the following topics and more, so please watch carefully. After watching the video, follow the steps outlined in this article:
- How to download and install the required PowerPack for
Shopify integration in SSIS - How to configure the connection for
Shopify - Features of the
ZappySys API Source (Authentication / Query Language / Examples / Driver UI) - How to use the
Shopify in SSIS
Prerequisites
Before we begin, make sure the following prerequisites are met:
- SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
- Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
- SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).
Read data from Shopify in SSIS (Export data)
In this section we will learn how to configure and use Shopify Connector in API Source to extract data from Shopify.
-
Begin with opening Visual Studio and Create a New Project.
-
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.
In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link. -
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
-
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
-
Select New Connection to create a new connection:
-
Use a preinstalled Shopify Connector from Popular Connector List or press Search Online radio button to download Shopify Connector. Once downloaded simply use it in the configuration:
Shopify -
Now it's time to configure authentication. Firstly, configure authentication settings in Shopify service and then proceed by configuring API Connection Manager. Start by expanding an authentication type:
Shopify authentication
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.
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
Access Token [Http]
- Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Finally, hit OK button:
ShopifyAccess 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 -
Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.
API Source - 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. -
That's it! We are done! Just in a few clicks we configured the call to Shopify using Shopify Connector.
You can load the source data into your desired destination using the Upsert Destination , which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV , Excel , Azure Table , Salesforce , and more . You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)
Write data to Shopify using SSIS (Import data)
In this section we will learn how to configure and use Shopify Connector in the API Destination to write data to Shopify.
Video tutorial
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download SSIS PowerPack for
Shopify integration in SSIS - How to configure connection for
Shopify - How to write or lookup data to
Shopify - Features about SSIS API Destination
- Using
Shopify Connector in SSIS
Step-by-step instructions
In upper section we learned how to read data, now in this section we will learn how to configure Shopify in the API Source to POST data to the Shopify.
-
Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.
-
From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
-
Select New Connection to create a new connection:
API Destination - 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. -
Use a preinstalled Shopify Connector from Popular Connector List or press Search Online radio button to download Shopify Connector. Once downloaded simply use it in the configuration:
Shopify -
Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.
Shopify authentication
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.
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
Access Token [Http]
- Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Finally, hit OK button:
ShopifyAccess 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 -
Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.
API Destination - 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. -
Finally, map the desired columns:
API Destination - 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. -
That's it; we successfully configured the POST API Call. In a few clicks we configured the Shopify API call using ZappySys Shopify Connector
Load Shopify data into SQL Server using Upsert Destination (Insert or Update)
Once you configured the data source, you can load Shopify data into SQL Server using Upsert Destination.
Upsert Destination can merge or synchronize source data with the target table.
It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets.
Upsert Destination also supports very fast bulk upsert
operation along with bulk delete
.
Upsert operation
- a database operation which performs INSERT
or UPDATE
SQL commands
based on record's existence condition in the target table.
It
Upsert Destination supports INSERT
, UPDATE
, and DELETE
operations,
so it is similar to SQL Server's MERGE
command, except it can be used directly in SSIS package.
-
From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.
-
Connect your SSIS source component to Upsert Destination.
-
Double-click on Upsert Destination component to open configuration window.
-
Start by selecting the Action from the list.
-
Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.
-
Then select a table from the Target Table list or click New button to create a new table based on the source columns.
-
Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).
-
Finally, click Map All button to map all columns and then select the Key columns to match the columns on:
-
Click OK to save the configuration.
-
Run the package and Shopify data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:
-
Done!
Deploy and schedule SSIS package
After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in this article:
Running SSIS package in Azure Data Factory (ADF)
To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:
Actions supported by Shopify Connector
Learn how to perform common Shopify actions directly in SSIS 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
- Make Generic API Request
- Make Generic API Request (Bulk Write)
Conclusion
In this article we showed you how to connect to Shopify in SSIS and integrate data without any coding, saving you time and effort.
We encourage you to download Shopify Connector for SSIS 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 SSIS Documentation