Shopify Connector for SSIS : Make generic REST API request

Learn how to make generic REST API request using the Shopify Connector for SSIS. This connector enables you to read and write Shopify data effortlessly. Integrate, manage, and automate customers, orders, products, and inventory — almost no coding required. We'll walk you through the exact setup.

Let's dive in!

Shopify Connector

Powering this integration

High performance
Bidirectional
Low-code / No-code
Easy to use

Built on the ZappySys API Connector Framework, the Shopify Connector for SSIS is a high-performance, low-code / no-code solution. It enables you to read and write Shopify data without any programming right in your SSIS package. Part of the SSIS PowerPack.

Documentation

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!).

Make generic REST API request in SSIS

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:

Admin Access Token (Custom App)

Shopify authentication

Method: Admin API Access Token (Recommended for Single-Store Connections)

This method uses a permanent Admin API Access Token generated from a "Custom App" within your Shopify Admin. This is the simplest way to connect if you are only integrating with your own store.

Quick Setup Summary:

Log in to your Shopify Admin and click Settings (the gear icon in the bottom left).
Select Apps from the left-side settings menu.
Click the Develop apps button at the top right of the page.
Open your app (or create a new one) and configure the necessary Admin API access scopes.
Click Install app. Once installed, navigate to the API credentials tab.

Important: Your Admin API access token (shpat_xxx) is only revealed once. Please copy and store it securely immediately after clicking "Reveal token once."

Note: If you are using the Shopify Dev Dashboard (via a Partner Account), you must use the OAuth Authorization Code Grant method, as those apps do not issue permanent 'shpat' tokens.

Video Tutorial: How to Get Admin API Access Token in Shopify?

Part 1: Create and Configure the Shopify App

Visit https://accounts.shopify.com and log into your Shopify store account.
After logging in, select the store you wish to connect to.
Select Settings (gear icon in the lower-left corner) to launch the Settings screen.
On the left menu panel, select Apps. (Note: Sales channels are now managed in a separate menu item).
On the Apps page, select Develop apps (near the top right of the screen).
Note: If this is your first time accessing this section, you may need to click "Allow custom app development" to proceed.
On the App development screen, select Create an app.
Give the app a name (e.g., "ZappySys Connector"), select the appropriate developer from the drop-down, and select Create app.
Click Configure Admin API scopes.
In the Admin API access scopes screen, select the checkboxes based on which features you plan to use:
- For Customers: read_customers, write_customers
- For Orders: read_orders, write_orders
- For Products: read_products, write_products
- For Inventory: read_inventory, write_inventory
- For Locations: read_locations
- For Payouts/Analytics: read_all_orders or read_analytics
Important: If you select fewer scopes than required, some connector features will not work. To ensure full functionality, select both read and write permissions for the resources you need to access.
After selecting your scopes, click Save at the top or bottom of the page.
Install the app by clicking the Install app button (upper-right corner). If prompted, confirm by selecting Install.

Part 2: Get Admin API Access Token

Once the app is installed, you will be taken to the API credentials tab.
Look for the Admin API access token section. Select Reveal token once to show the token (it starts with shpat_).
IMPORTANT: Copy and save this token immediately in a secure location. You cannot view it again after leaving this page.

Note: You may also see an API Key or Secret Key in this section; these are not required for this specific authentication method. Use only the Admin API access token.

Part 3: Configure the ZappySys Connector

Open the ZappySys connector configuration screen.
Enter Subdomain: Enter the unique subdomain of your Shopify store into the Subdomain parameter textbox.
How to find your Subdomain:

If you use a custom domain (e.g., www.my-store.com), you must still use your internal Shopify subdomain:
- Method 1 (Admin URL): While logged into Shopify, check your browser address bar.
  - If the URL is admin.shopify.com/store/my-unique-slug, your subdomain is my-unique-slug.
  - If the URL is my-unique-slug.myshopify.com/admin, your subdomain is my-unique-slug.
- Method 2 (Domains Setting): Go to Settings > Domains. Look for the "Primary domain for the online store" or the fallback domain ending in .myshopify.com. The part before the dots is your subdomain.
Enter Access Token: Paste the shpat_xxx token you saved in Step 14 into the Admin API Access Token textbox.
Tip: Click the ellipses (...) button inside the textbox to open a larger dialog for easier pasting.
Click Test Connection to verify the settings.
If the test is successful, click OK to save the configuration.

API Connection Manager configuration

Just perform these simple steps to finish authentication configuration:

Set Authentication Type to Admin Access Token (Custom App) [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:

Shopify

Admin Access Token (Custom App) [Http]

https://[$Subdomain$].myshopify.com/admin/api/2025-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

OAuth Authorization Code Grant (3-legged) - RECOMMENDED

Shopify authentication

Authenticate using OAuth 2.0 Authorization Code Flow (3-legged). Use this for apps built in the Dev Dashboard (https://dev.shopify.com). This is the primary OAuth flow supported for public apps and apps created in the Dev Dashboard.

Method: OAuth Authorization Code Grant (3-Legged)

This method is for apps built in the Shopify Dev Dashboard. Use this if you are a Partner or developer building a multi-store integration.

Note: If you are connecting to your own single store, the Admin Access Token method is significantly simpler. Use this OAuth method only if your integration specifically requires a Client ID and Secret.

Part 1: Create and Configure App in Dev Dashboard

Log in to the Shopify Dev Dashboard using your Partner account.
Click Apps in the left menu, then click Create app.
Select Start from Dev Dashboard (manual setup) and give your app a name.
Step 1: Configure Scopes and URLs via "Versions"
- Click the Versions tab at the top of the app screen.
- Click Create version (or edit the Draft).
- In the URLs section, enter https://zappysys.com/oauth into Allowed redirection URL(s).
- Select your Admin API scopes based on which features you plan to use:
  - For Customers: read_customers, write_customers
  - For Orders: read_orders, write_orders
  - For Products: read_products, write_products
  - For Inventory: read_inventory, write_inventory
  - For Locations: read_locations
  - For Payouts/Analytics: read_all_orders or read_analytics
  Important: If you select fewer scopes than required, some connector features will not work. To ensure full functionality, select both read and write permissions for the resources you need to access.
- Click Release (top right). Note: Settings only become active once a version is Released.
Step 2: Set Distribution Method
- Click Distribution in the left-side menu.
- Select Custom Distribution.
- Enter your Shopify store URL (e.g., your-store.myshopify.com) and click Generate link.
- Action Required: Copy the generated install link, open it in your browser, and follow the prompts to install/unlock the app for your store. You must complete this step before testing the connection in ZappySys.

Part 2: Get Client Credentials

Click on Settings in the left-side navigation of your app.
In the Client credentials section, copy the Client ID and Client Secret (click the eye icon to reveal).

Part 3: Configure the ZappySys Connector

Open the ZappySys connector and select OAuth Authorization Code Grant (3-legged).
Subdomain: Enter your store handle (the part before .myshopify.com).
Client ID / Secret: Paste the credentials from Steps 6 and 7.
Redirect URI: Enter https://zappysys.com/oauth.
Click Test Connection. You will be prompted to authorize the app in your browser.

Note on Tokens: Successful authorization generates an "Offline" Access Token (starting with shpca_). This token does not expire and does not require a refresh token.

Troubleshooting: If you see "App no longer available," ensure you have completed the Distribution step and followed the Install Link in Step 5 to unlock the app for your store.

API Connection Manager configuration

Just perform these simple steps to finish authentication configuration:

Set Authentication Type to OAuth Authorization Code Grant (3-legged) - RECOMMENDED [OAuth]
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.
Press Generate Token button to generate the tokens.
Finally, hit OK button:

Shopify

OAuth Authorization Code Grant (3-legged) - RECOMMENDED [OAuth]

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

Required Parameters
Redirect URI (*Must match App Settings*)	Fill-in the parameter...

Select Generic Table (Bulk Read or Write) table from the dropdown and hit Preview Data:

API Source - Shopify

Read and write Shopify data effortlessly. Integrate, manage, and automate customers, orders, products, and inventory — almost no coding required.

Shopify

Generic Table (Bulk Read or Write)

Required Parameters
HTTP - Url or File Path	Fill-in the parameter...
HTTP - Request Method	Fill-in the parameter...
Optional Parameters
HTTP - Request Body
HTTP - Is MultiPart Body (Pass File data/Mixed Key/value)
HTTP - Request Format (Content-Type)	ApplicationJson
HTTP - Headers (e.g. hdr1:aaa \|\| hdr2:bbb)	Accept: / \|\| Cache-Control: no-cache
Parser - Response Format (Default=Json)	Default
Parser - Filter (e.g. $.rows[*] )
Parser - Encoding
Parser - CharacterSet
Download - Enable reading binary data	False
Download - File overwrite mode	AlwaysOverwrite
Download - Save file path
Download - Enable raw output mode as single row	False
Download - Raw output data RowTemplate	{Status:'Downloaded'}
Download - Request Timeout (Milliseconds)
General - Enable Custom Search/Replace
General - SearchFor (e.g. (\d)-(\d)--regex)
General - ReplaceWith (e.g. $1-***)
General - File Compression Type
General - Date Format
General - Enable Big Number Handling	False
General - Wait time (Ms) - Helps to slow down pagination (Use for throttling)	0
JSON/XML - ExcludedProperties (e.g. meta,info)
JSON/XML - Flatten Small Array (Not preferred for more than 10 items)
JSON/XML - Max Array Items To Flatten	10
JSON/XML - Array Transform Type
JSON/XML - Array Transform Column Name Filter
JSON/XML - Array Transform Row Value Filter
JSON/XML - Array Transform Enable Custom Columns
JSON/XML - Enable Pivot Transform
JSON/XML - Array Transform Custom Columns
JSON/XML - Pivot Path Replace With
JSON/XML - Enable Pivot Path Search Replace	False
JSON/XML - Pivot Path Search For
JSON/XML - Include Pivot Path	False
JSON/XML - Throw Error When No Match for Filter	False
JSON/XML - Parent Column Prefix
JSON/XML - Include Parent When Child Null	False
Pagination - Mode
Pagination - Attribute Name (e.g. page)
Pagination - Increment By (e.g. 100)	1
Pagination - Expression for Next URL (e.g. $.nextUrl)
Pagination - Wait time after each request (milliseconds)	0
Pagination - Max Rows Expr
Pagination - Max Pages Expr
Pagination - Max Rows DataPath Expr
Pagination - Max Pages	0
Pagination - End Rules
Pagination - Next URL Suffix
Pagination - Next URL End Indicator
Pagination - Stop Indicator Expr
Pagination - Current Page
Pagination - End Strategy Type	DetectBasedOnRecordCount
Pagination - Stop based on this Response StatusCode
Pagination - When EndStrategy Condition Equals	True
Pagination - Max Response Bytes	0
Pagination - Min Response Bytes	0
Pagination - Error String Match
Pagination - Enable Page Token in Body	False
Pagination - Placeholders (e.g. {page})
Pagination - Has Different NextPage Info	False
Pagination - First Page Body Part
Pagination - Next Page Body Part
Csv - Column Delimiter	,
Csv - Has Header Row	True
Csv - Throw error when column count mismatch	False
Csv - Throw error when no record found	False
Csv - Allow comments (i.e. line starts with # treat as comment and skip line)	False
Csv - Comment Character	#
Csv - Skip rows	0
Csv - Ignore Blank Lines	True
Csv - Skip Empty Records	False
Csv - Skip Header Comment Rows	0
Csv - Trim Headers	False
Csv - Trim Fields	False
Csv - Ignore Quotes	False
Csv - Treat Any Blank Value As Null	False
Xml - ElementsToTreatAsArray

SSIS API Source - Read from table or endpoint

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)

Conclusion

And there you have it — a complete guide on how to make generic REST API request in SSIS without writing complex code. All of this was powered by Shopify Connector, which handled the REST API pagination and authentication for us automatically.

Download the trial now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):

Download Chat

More actions supported by Shopify Connector

Got another use case in mind? We've documented the exact setups for a variety of essential Shopify operations directly in SSIS, so you can skip the trial and error. Find your next step-by-step guide below: