Shopify Connector for Alteryx : Make generic REST API request via SQL

Learn how to make generic REST API request using the Shopify Connector for Alteryx. 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 ODBC Driver Powering this integration

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

Built on the ZappySys API Driver, the Shopify ODBC Driver is a high-performance, low-code / no-code solution. It enables you to connect to Shopify data without any coding right in your SQL Server, or any ODBC/JDBC application. Part of the ODBC PowerPack.

Documentation

Create data source using Shopify ODBC Driver

Download and install ODBC PowerPack (if you haven't already).
Search for odbc and open the ODBC Data Sources (64-bit):
Create a User data source (User DSN) based on the ZappySys API Driver driver:

ZappySys API Driver
- Create and use a User DSN if the client application runs under a User Account. This is the ideal option at design time (e.g., when developing in Visual Studio). Use it for both types of applications (64-bit and 32-bit).
- Create and use a System DSN if the client application runs under a System Account (e.g., as a Windows Service). This is usually the required option in a production environment. If your Windows Service is a 32-bit application, you must use the 32-bit ODBC Data Source Administrator to configure this
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

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.

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:

ShopifyDSN

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:

ShopifyDSN

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

Then go to Preview tab to start building a SQL query.
Once you do that, proceed by opening Query Builder:

ZappySys API Driver - Shopify

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

ShopifyDSN
Then simply select the Make Generic REST API Request endpoint (action).
Continue by configuring the Required parameters. You can also set optional parameters too.
Move on by hitting Preview Data button to preview the results.

If you see the results you need, simply copy the generated query:

Make Generic REST API Request

Required Parameters
HTTP - Url or File Path	Select the value from the dropdown
Optional Parameters
HTTP - Request Body
HTTP - Is MultiPart Body (Pass File data/Mixed Key/value)
HTTP - Headers (e.g. hdr1:aaa \|\| hdr2:bbb)	Accept: / \|\| Cache-Control: no-cache
Parser - Filter (e.g. $.rows[*] )
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)
Advanced Properties
HTTP - Request Method	GET
HTTP - Request Format (Content-Type)	ApplicationJson
Parser - Response Format (Default=Json)	Default
Parser - Encoding
Parser - CharacterSet
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

SELECT * FROM generic_request 
WITH (
    URL='/inventory_levels/set.json'
  --OR Use full URL
  --URL='https://MY-STORE-HERE.myshopify.com/admin/api/2023-01/inventory_levels/set.json'
  	
  , RequestMethod='POST'
  , Body='{"location_id":25801916516,"inventory_item_id":43512280416356,"available":42}' --needed if you call PUT, POST
  , Filter='$.inventory_level' --change table name here
  , Headers='Content-Type: application/json'
  , Meta='inventory_item_id:long; location_id:long; available:int; updated_at: datetime'
)

Click OK to use built SQL query and close the Query Builder.
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 Alteryx:
ZappySys API Driver - Shopify

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

ShopifyDSN
```
SELECT * FROM generic_request 
WITH (
    URL='/inventory_levels/set.json'
  --OR Use full URL
  --URL='https://MY-STORE-HERE.myshopify.com/admin/api/2023-01/inventory_levels/set.json'
  	
  , RequestMethod='POST'
  , Body='{"location_id":25801916516,"inventory_item_id":43512280416356,"available":42}' --needed if you call PUT, POST
  , Filter='$.inventory_level' --change table name here
  , Headers='Content-Type: application/json'
  , Meta='inventory_item_id:long; location_id:long; available:int; updated_at: datetime'
)
```
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).

Let's not stop here and explore SQL query examples, including how to use them in Stored Procedures and Views (virtual tables) in the next steps.

Shopify SQL query examples

Use these SQL queries in your Alteryx data source:

Set inventory level (generic API)

Sets inventory level using a generic API call to the /inventory_levels/set.json endpoint. This method provides direct control over the API request body.

SELECT * FROM generic_request 
WITH (
    URL='/inventory_levels/set.json'
  --OR Use full URL
  --URL='https://MY-STORE-HERE.myshopify.com/admin/api/2023-01/inventory_levels/set.json'
  	
  , RequestMethod='POST'
  , Body='{"location_id":25801916516,"inventory_item_id":43512280416356,"available":42}' --needed if you call PUT, POST
  , Filter='$.inventory_level' --change table name here
  , Headers='Content-Type: application/json'
  , Meta='inventory_item_id:long; location_id:long; available:int; updated_at: datetime'
)

Execute GraphQL query

Executes a GraphQL query against the Shopify Admin API using the generic_request table. This is useful for accessing data or performing operations not available via the standard REST API endpoints.

SELECT * FROM generic_request 
WITH (
    URL='/graphql.json'
  --OR Use full URL
  --URL='https://MY-STORE-HERE.myshopify.com/admin/api/2023-10/graphql.json'
  
  , RequestMethod='POST'
  , Filter='$.data.products.nodes' --change table name here e.g. products
  , Headers='Content-Type: application/json'
  --change table name and columns below here e.g. products... and id, title etc
  -- change pagesize if needed (i.e. max 250)
  , Body='{
 "query" : "<<{
 
 products(first: 250 [$tag$])
 {
    nodes {
      id
      title
      createdAt
    }
    
    pageInfo {
      hasNextPage
      endCursor
    }
    
  }
  
},FUN_JSONENC>>"
}'
	, NextUrlAttributeOrExpr='$.data.products.pageInfo.endCursor' --change table name 
	, NextUrlEndIndicator='false'
	, StopIndicatorAttributeOrExpr='$.data.products.pageInfo.hasNextPage' --change table name 
	, UseConnection='True'
	, EnablePageTokenForBody='True'
	, HasDifferentNextPageInfo='True'
	, NextPageBodyPart='after: \"[$pagetoken$]\"'
	--Use metadata to speed up execution. To get Metadata Run query without Meta clause. 
	-- Then click View Metadata button found in Botttom Result Grid Toolbar. Get Compact format and paste below
	--, Meta='id:String(255); title:String(255); createdAt:DateTime; '
)

Call generic API request

Calls a generic Shopify REST API endpoint (e.g. /products.json) using the generic_request table. This allows accessing any REST endpoint by specifying the URL, RequestMethod, and other parameters.

SELECT * FROM generic_request 
WITH (
    URL='/products.json'
  --OR Use full URL
  --URL='https://MY-STORE-HERE.myshopify.com/admin/api/2023-01/products.json'
  	
  , RequestMethod='GET'
  , Body='{}' --needed if you call PUT, POST
  , Filter='$.products[*]' --change table name here
  , Headers='Content-Type: application/json'
  , PagingMode='ByResponseHeaderRfc5988'
  
  
  --Use metadata to speed up execution. To get Metadata Run query without Meta clause. 
  --Then click View Metadata button found in Botttom Result Grid Toolbar. Get Compact format and paste below
  , Meta='id:String(255); title:String(255); created_at:DateTime; '
)

Get DynamicRequest

SELECT * FROM __DynamicRequest__

generic_request endpoint belongs to __DynamicRequest__ table(s), and can therefore be used via those table(s).

Create SQL view in ODBC data source

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.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

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"
```

Make generic REST API request in Alteryx via SQL view

Open Alteryx Designer.
First, verify your DCM Settings to ensure you can access ODBC drivers. Go to Options > User Settings > Edit User Settings.

If DCM Mode is set to DCM Only, change it to DCM Optional if you would like to access the legacy Generic ODBC Connection.

After changing this setting, you may need to click Save and restart the connection window for the "Generic ODBC" icon to appear.
Drag an Input Data tool onto your Alteryx canvas.
In the Configuration pane, click Set Up a Connection.
Note for DCM Users: If your environment has DCM (Data Connection Manager) enabled, the classic "Generic ODBC" icon may be hidden. To find it, select Data sources on the left and type "ODBC" in the search bar.
Once the ODBC window opens, click Connect Asset and select your ShopifyDSN DSN from the list.

Ensure you have configured a 64-bit System DSN in the Windows ODBC Data Source Administrator before this step.
After selecting your DSN, configure your SQL Query in the Input Data tool configuration:
To save your data, drag an Output Data tool and connect it to the Input Data tool.
Configure the Output Data tool to write to a CSV file:
Press Run (Ctrl+R) to execute the workflow. Verify the results in the Results Window at the bottom.

Advanced topics

Creating SQL stored procedures

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 Stored 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 Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored 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 Stored 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';
```

Conclusion

And there you have it — a complete guide on how to make generic REST API request in Alteryx without writing complex code. All of this was powered by Shopify ODBC Driver, 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 Alteryx, so you can skip the trial and error. Find your next step-by-step guide below: