How to integrate Shopify with SAP Crystal Reports

Integrate SAP Crystal Reports and Shopify
Integrate SAP Crystal Reports and Shopify

Learn how to quickly and efficiently connect Shopify with SAP Crystal Reports for smooth data access.

Read and write Shopify data effortlessly. Integrate, manage, and automate customers, orders, products, and inventory — almost no coding required. You can do it all using the high-performance Shopify ODBC Driver for SAP Crystal Reports (often referred to as the Shopify Connector). We'll walk you through the entire setup.

Ready to dive in? Download the product to jump right in, or follow the step-by-step guide below to see how it works.

Create data source using Shopify ODBC Driver

Step-by-step instructions

To get data from Shopify using SAP Crystal Reports, we first need to create an ODBC data source. We will later read this data in SAP Crystal Reports. Perform these steps:

  1. Download and install ODBC PowerPack (if you haven't already).

  2. Search for odbc and open the ODBC Data Sources (64-bit):

    Open ODBC Data Source

  3. Create a User data source (User DSN) based on the ZappySys API Driver driver:

    ZappySys API Driver
    Create new User DSN for 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

  4. 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
    ODBC DSN Template Selection

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

    1. Visit https://accounts.shopify.com and log into your Shopify store account.
    2. After logging in, select the store you wish to connect to.
    3. Select Settings (gear icon in the lower-left corner) to launch the Settings screen.
    4. On the left menu panel, select Apps. (Note: Sales channels are now managed in a separate menu item).
    5. 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.
    6. On the App development screen, select Create an app.
    7. Give the app a name (e.g., "ZappySys Connector"), select the appropriate developer from the drop-down, and select Create app.
    8. Click Configure Admin API scopes.
    9. 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.

    10. After selecting your scopes, click Save at the top or bottom of the page.
    11. 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

    1. Once the app is installed, you will be taken to the API credentials tab.
    2. Look for the Admin API access token section. Select Reveal token once to show the token (it starts with shpat_).

    3. IMPORTANT: Copy and save this token immediately in a secure location. You cannot view it again after leaving this page.

      Reveal Token Screenshot

      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

    1. Open the ZappySys connector configuration screen.
    2. 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.
    3. 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.
    4. Click Test Connection to verify the settings.
    5. If the test is successful, click OK to save the configuration.
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to Admin Access Token (Custom App) [Http]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. 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
    ODBC DSN HTTP Connection Configuration

    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

    1. Log in to the Shopify Dev Dashboard using your Partner account.
    2. Click Apps in the left menu, then click Create app.
    3. Select Start from Dev Dashboard (manual setup) and give your app a name.
    4. 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.
    5. 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

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

    Part 3: Configure the ZappySys Connector

    1. Open the ZappySys connector and select OAuth Authorization Code Grant (3-legged).
    2. Subdomain: Enter your store handle (the part before .myshopify.com).
    3. Client ID / Secret: Paste the credentials from Steps 6 and 7.
    4. Redirect URI: Enter https://zappysys.com/oauth.
    5. 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:

    1. Set Authentication Type to OAuth Authorization Code Grant (3-legged) - RECOMMENDED [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. 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...
    ODBC DSN OAuth Connection Configuration

  6. 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 - Shopify
    Read and write Shopify data effortlessly. Integrate, manage, and automate customers, orders, products, and inventory — almost no coding required.
    ShopifyDSN
    Open Query Builder in API ODBC Driver to read and write data to REST API

  7. 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 SAP Crystal Reports to retrieve data from Shopify. Hit OK button to use this query in the next step. 

    SELECT * FROM Products
    Configure table/endpoint parameters in ODBC data source based on API Driver
    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 data much faster.

  8. 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 SAP Crystal Reports:

    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 Products
    API ODBC Driver-based data source data preview
    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).

  9. Click OK to finish creating the data source.

Video Tutorial

Read data in SAP Crystal Reports from the ODBC data source

  1. First of all, open SAP Crystal Reports and create the new Crystal Report.

    Create New Crystal Report

  2. And it will open the new data source selection window. Under ODBC(RDO) double click on the Make New Connection and Select the desired ODBC DSN, in our case we need to select ShopifyDSN which we created in upper section. And Click on Next.

    ShopifyDSN
    SAP Crystal Report - Select ODBC ShopifyDSN DSN

  3. Expand the Connection and under the data select the desired table(s) or view(s) and click Add > button and click on Next.

    ShopifyDSN
    ShopifyDSN
    SAP Crystal Report - Add ODBC ShopifyDSN DSN Tables

  4. Add the desired Fields to Display in the Reports. Here we are adding all fields and click on Finish.

    SAP Crystal Report - Add Display Fields

  5. That's it and you will be able to load the data in the Report.

    SAP Crystal Report - ShopifyDSN Data Output

Using ZappySys Driver Custom Views and Stored Procedure in SAP Crystal Report

You can create parameterized Stored Procedure and Virtual Tables on the same Data Source (ODBC DSN or Data Gateway Data Source). Please refer to this article for the same. You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Using Custom Views in the SAP Crystal Report

After establishing the connection with ShopifyDSN Data Source you can use the custom view in SQL Crystal Report.
ShopifyDSN
ShopifyDSN
SAP Crystal Report - Custom Views

Using Custom Stored Procedure in the SAP Crystal Report

  1. First of all, create the custom stored procedure in the ZappySys Driver. Please refer to this article to create the custom stored procedure.
    ZappySys Driver Custom Stored Procedure
  2. After establishing the connection with ShopifyDSN Data Source you can use the custom Stored Procedure in SQL Crystal Report. Same way you can write custom queries also in the query box.
    ShopifyDSN
    SAP Crystal Report - Custom Views

Optional: Centralized data access via ZappySys Data Gateway

In some situations, you may need to provide Shopify data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.

This configuration provides two primary advantages:

  • Centralized data access
    The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
  • Centralized access control
    Since all connections route through the gateway, access can be governed or revoked from a single location for all users.
Data Gateway
Local ODBC
data source
Simple configuration
Installation Single machine Per machine
Connectivity Local and remote Local only
Connections limit Limited by License Unlimited
Central data access
Central access control
More flexible cost

To achieve this, you must first create a data source in the Data Gateway (server-side) and then create an ODBC data source in SAP Crystal Reports (client-side) to connect to it.

Let's not wait and get going!

Create Shopify data source in the gateway

In this section we will create a data source for Shopify in the Data Gateway. Let's follow these steps to accomplish that:

  1. Search for gateway in the Windows Start Menu and open ZappySys Data Gateway Configuration:

    Open ZappySys Data Gateway Service Manager

  2. Go to the Users tab and follow these steps to add a Data Gateway user:

    • Click the Add button
    • In the Login field enter a username, e.g., john
    • Then enter a Password
    • Check the Is Administrator checkbox
    • Click OK to save
    Data Gateway - Add User

  3. Now we are ready to add a data source:

    • Click the Add button
    • Give the Data source a name (have it handy for later)
    • Then select Native - ZappySys API Driver
    • Finally, click OK
    ShopifyDSN
    ZappySys API Driver
    Data Gateway - Add data source

  4. When the ZappySys API Driver configuration window opens, go back to ODBC Data Source Administrator where you already have the Shopify ODBC data source created and configured, and follow these steps on how to Import data source configuration into the Gateway:

    • Open ODBC data source configuration and click Copy settings:
      ZappySys API Driver - Configuration [Version: 2.0.1.10418]
      ZappySys API Driver - Shopify
      Read and write Shopify data effortlessly. Integrate, manage, and automate customers, orders, products, and inventory — almost no coding required.
      ShopifyDSN
      Copy connection string for ODBC application
    • The window opens, telling us the connection string was successfully copied to the clipboard: Successful connection string copying for ODBC application

    • Then go to Data Gateway configuration and in data source configuration window click Load settings:

      ShopifyDSN
      ZappySys API Driver - Configuration [Version: 2.0.1.10418]
      ZappySys API Driver - Shopify
      Read and write Shopify data effortlessly. Integrate, manage, and automate customers, orders, products, and inventory — almost no coding required.
      ShopifyDSN
      Load configuration in ZappySys Data Gateway data source
    • Once a window opens, just paste the settings by pressing CTRL+V or by clicking right mouse button and then Paste option.

  5. Once done, go to the Network Settings tab and Add a firewall rule for inbound traffic:

    Data Gateway - Add firewall rule for inbound connections
    • This will initially allow all inbound traffic.
    • Click Edit IP filters to restrict access to specific IP addresses or ranges.

  6. Crucial Step: After creating or modifying the data source, you must:

    • Click the Save button to persist your changes.
    • Hit Yes when prompted to restart the Data Gateway service.

    This ensures all changes are properly applied:

    ZappySys Data Gateway - Save Changes
    Skipping this step may cause the new settings to fail, preventing you from connecting to the data source.

Create ODBC data source to connect to the gateway

In this part we will create an ODBC data source to connect to the ZappySys Data Gateway from SAP Crystal Reports. To achieve that, let's perform these steps:

  1. Search for odbc and open the ODBC Data Sources (64-bit):

    Open ODBC Data Source

  2. Create a User data source (User DSN) based on the ODBC Driver 17 for SQL Server driver:

    ODBC Driver 17 for SQL Server
    Create new User DSN for ODBC Driver 17 for SQL Server
    If you don't see the ODBC Driver 17 for SQL Server driver in the list, choose a similar version.

  3. Then set a Name for the data source (e.g. Gateway) and the address of the Data Gateway:

    ZappySysGatewayDSN
    localhost,5000
    ODBC driver for SQL Server - Setting hostname and port
    Make sure you separate the hostname and port with a comma, e.g. localhost,5000.

  4. Proceed with the authentication part:

    • Select SQL Server authentication
    • In the Login ID field enter the user name you created in the Data Gateway, e.g., john
    • Set Password to the one you configured in the Data Gateway
    ODBC driver for SQL Server - Selecting SQL Authentication

  5. Then set the default database property to ShopifyDSN (the one we used in the Data Gateway):

    ShopifyDSN
    ShopifyDSN
    ODBC driver for SQL Server - Selecting database
    Make sure to type the data source name manually or copy/paste it directly into the field. Using the dropdown might fail because the Trust server certificate option is not enabled yet (next step).

  6. Continue by checking the Trust server certificate option:

    ODBC driver for SQL Server - Trusting certificate

  7. Once you do that, test the connection:

    ODBC driver for SQL Server - Testing connection

  8. If the connection is successful, everything is good:

    ODBC driver for SQL Server - Testing connection succeeded

  9. Done!

We are ready to move to the final step. Let's do it!

Access data in SAP Crystal Reports via the gateway

Finally, we are ready to read data from Shopify in SAP Crystal Reports via the Data Gateway. Follow these final steps:

  1. Go back to SAP Crystal Reports.

  2. First of all, open SAP Crystal Reports and create the new Crystal Report.

    Create New Crystal Report

  3. And it will open the new data source selection window. Under ODBC(RDO) double click on the Make New Connection and Select the desired ODBC DSN, in our case we need to select ZappySysGatewayDSN which we created in upper section. And Click on Next.

    ZappySysGatewayDSN
    SAP Crystal Report - Select ODBC ZappySysGatewayDSN DSN

  4. Read the data the same way we discussed at the beginning of this article.

  5. That's it!

Now you can connect to Shopify data in SAP Crystal Reports via the Data Gateway.

If you are asked for authentication details, use Database authentication, SQL authentication or Basic authentication option and enter the credentials you used when configuring the Data Gateway, e.g. john and your password.

Supported Shopify Connector actions

Got a specific use case in mind? We've mapped out exactly how to perform a variety of essential Shopify operations directly in SAP Crystal Reports, so you don't have to figure out the setup from scratch. Check out the step-by-step guides below:

Conclusion

In this article we showed you how to connect to Shopify in SAP Crystal Reports and integrate data without writing complex code — all of this was powered by Shopify ODBC Driver.

Download ODBC PowerPack 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

Explore SAP Crystal Reports connectors

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

More Shopify integrations

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications