Shopify Connector for PowerShellShopify 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 PowerShell without coding. We will use high-performance Shopify Connector to easily connect to Shopify and then access the data inside PowerShell. Let's follow the steps below to see how we can accomplish that! Shopify Connector for PowerShell is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few. |
Connect to Shopify in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from Shopify using PowerShell we first need to create a DSN (Data Source) which will access data from Shopify. We will later be able to read data using PowerShell. Perform these steps:
-
Download and install ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User data source (User DSN) based on ZappySys API Driver
ZappySys API Driver-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
in design-time , when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit. -
Create and use System DSN
if the client application is launched under a System Account, e.g. as a Windows Service.
Usually, this is an ideal option to use
in a production environment . Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
-
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 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.- 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:
ShopifyDSNShopifyAccess 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 -
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 - 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.ShopifyDSN -
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 PowerShell to retrieve data from Shopify. Hit OK button to use this query in the next step.
SELECT * FROM Products
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 datamuch faster . -
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 PowerShell:
ZappySys API Driver - 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.ShopifyDSNSELECT * FROM Products
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHERE
clause,LIMIT
keyword will be performed on the client side, meaning that thewhole 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). -
Click OK to finish creating the data source.
Video Tutorial
Read Shopify data in PowerShell
Sometimes, you need to quickly access and work with your Shopify data in PowerShell. Whether you need a quick data overview or the complete dataset, this article will guide you through the process. Here are some common scenarios:
Viewing data in a terminal- Quickly peek at Shopify data
- Monitor data constantly in your console
- Export data to a CSV file so that it can be sliced and diced in Excel
- Export data to a JSON file so that it can ingested by other processes
- Export data to an HTML file for user-friendly view and easy sharing
- Create a schedule to make it an automatic process
- Store data internally for analysis or for further ETL processes
- Create a schedule to make it an automatic process
- Integrate data with other systems via external APIs
In this article, we will delve deeper into how to quickly view the data in PowerShell terminal and how to save it to a file. But let's stop talking and get started!
Reading individual fields
- Open your favorite PowerShell IDE (we are using Visual Studio Code).
-
Then simply follow these instructions:
"DSN=ShopifyDSN"
For your convenience, here is the whole PowerShell script:
# Configure connection string and query $connectionString = "DSN=ShopifyDSN" $query = "SELECT * FROM Customers" # Instantiate OdbcDataAdapter and DataTable $adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString) $table = New-Object System.Data.DataTable # Fill the table with data $adapter.Fill($table) # Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab $format = "{0}`t{1}`t{2}`t{3}" # Display data in the console foreach ($row in $table.Rows) { # Construct line based on the format and individual Shopify fields $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"]) Write-Host $line }
Access specific Shopify table field using this code snippet:
You will find more info on how to manipulate$field = $row["ColumnName"]
DataTable.Rows
property in Microsoft .NET reference.For demonstration purposes we are using sample tables which may not be available in Shopify. -
To read values in a console, save the script to a file and then execute this command inside PowerShell terminal:
You can also use even a simpler command inside the terminal, e.g.:
. 'C:\Users\john\Documents\dsn.ps1'
Retrieving all fields
However, there might be case, when you want to retrieve all columns of a query. Here is how you do it:

Again, for your convenience, here is the whole PowerShell script:
# Configure connection string and query
$connectionString = "DSN=ShopifyDSN"
$query = "SELECT CustomerId, CompanyName, Country, Phone FROM Customers"
# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable
# Fill the table with data
$adapter.Fill($table)
# Display data in the console
foreach ($row in $table.Rows) {
$line = ""
foreach ($column in $table.Columns) {
$value = $row[$column.ColumnName]
# Let's handle NULL values
if ($value -is [DBNull])
{
$value = "(NULL)"
}
$line += $value + "`t"
}
Write-Host $line
}
LIMIT
keyword in the query, e.g.:
SELECT * FROM Customers LIMIT 10
Using a full ODBC connection string
In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:
-
Open ODBC data source configuration and click Copy settings:
ZappySys API Driver - 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.ShopifyDSN
-
The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then just paste the connection string into your script:
- You are good to go! The script will execute the same way as using a DSN.
Have in mind that a full connection string has length limitations.
Proceed to the next step to find out the details.
Limitations of using a full connection string
Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:
"Connection string exceeds maximum allowed length of 1024"
But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:
- Open your ODBC data source.
- Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
- Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
- Continue by pasting the copied connection string into a newly created file and save it.
-
Finally, the last step! Just construct a shorter ODBC connection string using this format:
DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt
- Our troubles are over! Now you should be able to use this connection string in PowerShell with no problems.
Write Shopify data to a file in PowerShell
Save data to a CSV file
Export data to a CSV file so that it can be sliced and diced in Excel:
# Configure connection string and query
$connectionString = "DSN=ShopifyDSN"
$query = "SELECT * FROM Customers"
# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable
# Fill the table with data
$adapter.Fill($table)
# Export table data to a file
$table | ConvertTo-Csv -NoTypeInformation -Delimiter "`t" | Out-File "C:\Users\john\saved-data.csv" -Force
Save data to a JSON file
Export data to a JSON file so that it can ingested by other processes (use the above script, but change this part):
# Export table data to a file
$table | ConvertTo-Json | Out-File "C:\Users\john\saved-data.json" -Force
Save data to an HTML file
Export data to an HTML file for user-friendly view and easy sharing (use the above script, but change this part):
# Export table data to a file
$table | ConvertTo-Html | Out-File "C:\Users\john\saved-data.html" -Force
ConvertTo-Csv
, ConvertTo-Json
, and ConvertTo-Html
for other data manipulation scenarios.
Actions supported by Shopify Connector
Learn how to perform common Shopify actions directly in PowerShell 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
- Generic Request
- Generic Request (Bulk Write)
Conclusion
In this article we showed you how to connect to Shopify in PowerShell 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 PowerShell 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 PowerShell Documentation
More integrations
Other connectors for PowerShell
Other application integration scenarios for Shopify
How to connect Shopify in PowerShell?
How to get Shopify data in PowerShell?
How to read Shopify data in PowerShell?
How to load Shopify data in PowerShell?
How to import Shopify data in PowerShell?
How to pull Shopify data in PowerShell?
How to push data to Shopify in PowerShell?
How to write data to Shopify in PowerShell?
How to POST data to Shopify in PowerShell?
Call Shopify API in PowerShell
Consume Shopify API in PowerShell
Shopify PowerShell Automate
Shopify PowerShell Integration
Integration Shopify in PowerShell
Consume real-time Shopify data in PowerShell
Consume real-time Shopify API data in PowerShell
Shopify ODBC Driver | ODBC Driver for Shopify | ODBC Shopify Driver | SSIS Shopify Source | SSIS Shopify Destination
Connect Shopify in PowerShell
Load Shopify in PowerShell
Load Shopify data in PowerShell
Read Shopify data in PowerShell
Shopify API Call in PowerShell