How to integrate Amazon Selling Partner (SP-API) with Qlik Cloud
Learn how to quickly and efficiently connect Amazon Selling Partner (SP-API) with Qlik Cloud for smooth data access.
Read and write Amazon Selling Partner (SP-API) data effortlessly. Integrate, manage, and automate listings, orders, payments, and reports — almost no coding required. You can do it all using the high-performance Amazon Selling Partner (SP-API) ODBC Driver (powered by Amazon Selling Partner (SP-API) Connector for ZappySys API Driver). 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 Amazon Selling Partner (SP-API) ODBC Driver
Video instructions
Watch this quick walkthrough to see how to configure your Amazon Selling Partner (SP-API) ODBC data source, or scroll down for the step-by-step written guide.
Step-by-step instructions
To get data from Amazon Selling Partner (SP-API) using Qlik Cloud, we first need to create an ODBC data source. We will later read this data in Qlik Cloud. Perform these steps:
-
Download and install ODBC PowerPack (if you haven't already).
-
Search for
odbcand 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 "Amazon Selling Partner (SP-API)" from the list of Popular Connectors. If "Amazon Selling Partner (SP-API)" 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:
AmazonSellingPartnerSpApiDSNAmazon Selling Partner (SP-API)
-
Select your authentication scenario below to expand connection configuration steps to:
- Configure the authentication in Amazon Selling Partner (SP-API).
- Enter those details into the ZappySys API Driver data source configuration.
Amazon Selling Partner (SP-API) authentication
Amazon Sellers can use SP-API to set up private integrations and build solutions exclusively for their Amazon store. Private app is available only to your organization and is self-authorized. A private developer builds application(s) that integrate their own company with Amazon APIs. [API reference]
Perform the following steps to authenticate calls using Amazon SP-API Private app:
- Register as an Amazon Private SP-API Developer. You may need to wait for a day or two to get approved (check approval status).
-
Once your developer account is approved,
login to your account, visit developer console
and click Add new app client button to create a Private app:
-
Continue by naming your application in the App name field,
choose
SP APIas API Type, and select the Roles for your app (i.e. permissions):
-
Once you do that, click View link in LWA credentials column to
copy Client identifier and Client secret (we will use them later):
-
Now it's time to Authorize your app:
-
Finish authorizing it by presing Authorize app button:
-
Finally, copy the Refresh Token (we will use it in the next step):
-
Now go to SSIS package or ODBC data source and use Private app authentication configuration:
- In the ClientId field paste the Client identifier value you copied in the previous step.
- In the ClientSecret field paste the Client secret value you copied in the previous step.
- Leave the default value in the TokenUrl field.
- In the Refresh Token field paste the Refresh Token value you copied in the previous step.
- Click Test Connection to confirm the connection is working.
- Done! Now you are ready to use Amazon Selling Partner (SP-API) Connector!
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
Private app [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:
AmazonSellingPartnerSpApiDSNAmazon Selling Partner (SP-API)Private app [OAuth]https://sellingpartnerapi-na.amazon.comRequired Parameters ClientId Fill-in the parameter... ClientSecret Fill-in the parameter... TokenUrl Fill-in the parameter... Optional Parameters TokenUIMode OnlyRefreshToken AuthUrl (Do not Use for Private app - Self Authorization) https://sellercentral.amazon.com/apps/authorize/consent?application_id=[YOUR-APPLICATION-ID]&version=beta OrdersApiVersion v0 SellerApiVersion v1 ShippingApiVersion v1 ServicesApiVersion v1 FbaApiVersion v1 SalesApiVersion v1 ReportsApiVersion 2021-06-30 ProductsFeesApiVersion v0 ProductPricingApiVersion v0 CatalogItemsApiVersion 2022-04-01 VendorOrdersApiVersion v1 RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True
Find full details in the Amazon Selling Partner (SP-API) Connector authentication reference. -
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 - Amazon Selling Partner (SP-API)Read and write Amazon Selling Partner (SP-API) data effortlessly. Integrate, manage, and automate listings, orders, payments, and reports — almost no coding required.AmazonSellingPartnerSpApiDSN
-
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 Qlik Cloud to retrieve data from Amazon Selling Partner (SP-API). Hit OK button to use this query in the next step.
SELECT * FROM Orders --WHERE AmazonOrderId='902-1845936-5435065' WITH( CreatedAfter='1900-01-01T00:00:00' -- , CreatedBefore='1900-01-01T00:00:00' -- , LastUpdatedAfter='1900-01-01T00:00:00' -- , LastUpdatedBefore='1900-01-01T00:00:00' -- , OrderStatuses='Pending~Unshipped~PartiallyShipped~PendingAvailability~Shipped~Canceled~Unfulfillable' -- , MarketplaceIds='ATVPDKIKX0DER~A2Q3Y263D00KWC~A2EUQ1WTGCTBG2' -- , FulfillmentChannels='AFN~MFN' -- , PaymentMethods='COD~CVS~Other' -- , AmazonOrderIds='1111111,222222,333333' ) --CONNECTION( -- ServiceUrl='https://sellingpartnerapi-na.amazon.com' --)
Some parameters configured in this window will be passed to the Amazon Selling Partner (SP-API) 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 Qlik Cloud:
ZappySys API Driver - Amazon Selling Partner (SP-API)Read and write Amazon Selling Partner (SP-API) data effortlessly. Integrate, manage, and automate listings, orders, payments, and reports — almost no coding required.AmazonSellingPartnerSpApiDSNSELECT * FROM Orders --WHERE AmazonOrderId='902-1845936-5435065' WITH( CreatedAfter='1900-01-01T00:00:00' -- , CreatedBefore='1900-01-01T00:00:00' -- , LastUpdatedAfter='1900-01-01T00:00:00' -- , LastUpdatedBefore='1900-01-01T00:00:00' -- , OrderStatuses='Pending~Unshipped~PartiallyShipped~PendingAvailability~Shipped~Canceled~Unfulfillable' -- , MarketplaceIds='ATVPDKIKX0DER~A2Q3Y263D00KWC~A2EUQ1WTGCTBG2' -- , FulfillmentChannels='AFN~MFN' -- , PaymentMethods='COD~CVS~Other' -- , AmazonOrderIds='1111111,222222,333333' ) --CONNECTION( -- ServiceUrl='https://sellingpartnerapi-na.amazon.com' --)
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHEREclause,LIMITkeyword will be performed on the client side, meaning that thewhole result set will be retrieved from the Amazon Selling Partner (SP-API) 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 Amazon Selling Partner (SP-API) servers). -
Click OK to finish creating the data source.
Set up Qlik Direct Access data gateway
To connect to the Amazon Selling Partner (SP-API) data, you need a secure pipeline between your Qlik Cloud tenant and the Amazon Selling Partner (SP-API) ODBC DSN. Let's download, deploy, and register the Qlik data gateway to make this happen.
-
First, log into your My Qlik tenants portal and choose your tenant:
-
Navigate to Administration.
-
Select Spaces.
-
-
Create a shared space if you do not have one yet:
-
Click Create new.
-
Name shared space and confirm.
-
-
Next, let's grab the gateway installer:
-
Navigate to Administration.
-
Select Data gateways.
-
-
Download the gateway:
-
Click Deploy.
-
Select Data Gateway - Direct Access (Windows).
-
Check acknowledgement box.
-
Click Download.
-
-
If you are not running this locally, copy the installer to your target machine.
The ODBC PowerPack and the Qlik Direct Access gateway must be installed on the exact same machine. -
Install the Qlik Direct Access gateway.
-
Once installed, open an elevated Command Prompt on the gateway machine:
-
Link the gateway to your tenant:
-
Navigate to ConnectorAgent directory.
-
Run tenant URL setup command.
cd \ cd "Program Files\Qlik\ConnectorAgent\ConnectorAgent" ConnectorAgent.exe qcs set_config --tenant_url https://<tenant>.qlikcloud.com -
-
Generate your data gateway key:
ConnectorAgent.exe qcs generate_keys -
Start the gateway service:
ConnectorAgent.exe service start -
Generate and copy the registration payload:
-
Run registration command.
-
Copy output text.
ConnectorAgent.exe qcs get_registration -
-
Now let's head back to the Qlik Cloud Administration page to complete the data gateway registration.
-
Create the gateway entry in your tenant and apply the key:
-
Name gateway.
-
Select Direct Access for Gateway type.
-
Select shared space.
-
Paste generated key.
-
Click Create.
-
-
Finally, verify the status shows Connected:
Create ODBC connection in Analytics
With the gateway actively running, let's build the actual ODBC connection in Analytics.
-
Navigate to your My Qlik tenants page, choose your tenant, select the Analytics tile, and click the Create menu item:
-
Click the Data connection tile:
-
Next, let's create the ODBC data connection by selecting your shared space and finding the right connector:
-
Pick your shared space.
-
Search for odbc.
-
Choose the ODBC (via Direct Access gateway) option.
-
-
Finally, configure the ODBC connection fields to wrap up the setup:
-
Select your Data gateway.
-
Select the System DSN option.
-
Choose the ODBC source (DSN).
-
Select the DB2 SQL syntax.
-
Name the connection.
-
Click Test connection, then click Create.
AmazonSellingPartnerSpApiDSN
-
-
Connection is ready!
You are now successfully wired up to your Amazon Selling Partner (SP-API) data. Let's see how to actually load it into your dashboard.
Load Amazon Selling Partner (SP-API) data into Qlik Cloud
Depending on your specific use case, you can choose one of the two methods below to bring your data into the Qlik Cloud environment for analysis.
Use Analytics app with Data load editor
This is the best method if you need to run dynamic SQL. We will use your new gateway connection in the Data load editor to pull the data and verify it visually.
-
Navigate to your My Qlik tenants page, choose your tenant, select the Analytics tile, and click the Create menu item:
-
Click the Application tile to start creating a new application:
-
Next, create the application within your shared space:
Name the application.
Select your shared space.
Click the Create button.
-
Now, open the new application and click the Data load editor option:
-
With the editor open, you can configure your DSN and SQL query before running the data load:
-
Select your shared space connection.
-
Click the gateway connection button to use the ODBC (via Direct Access gateway) option.
-
Name the table as MyData and prepare your SQL load script.
-
Click Load data.
SELECT * FROM Orders --WHERE AmazonOrderId='902-1845936-5435065' WITH( CreatedAfter='1900-01-01T00:00:00' -- , CreatedBefore='1900-01-01T00:00:00' -- , LastUpdatedAfter='1900-01-01T00:00:00' -- , LastUpdatedBefore='1900-01-01T00:00:00' -- , OrderStatuses='Pending~Unshipped~PartiallyShipped~PendingAvailability~Shipped~Canceled~Unfulfillable' -- , MarketplaceIds='ATVPDKIKX0DER~A2Q3Y263D00KWC~A2EUQ1WTGCTBG2' -- , FulfillmentChannels='AFN~MFN' -- , PaymentMethods='COD~CVS~Other' -- , AmazonOrderIds='1111111,222222,333333' ) --CONNECTION( -- ServiceUrl='https://sellingpartnerapi-na.amazon.com' --)
LIB CONNECT TO 'My Shared Space:Gateway Connection'; MyData: LOAD *; SQL SELECT * FROM Orders --WHERE AmazonOrderId='902-1845936-5435065' WITH( CreatedAfter='1900-01-01T00:00:00' -- , CreatedBefore='1900-01-01T00:00:00' -- , LastUpdatedAfter='1900-01-01T00:00:00' -- , LastUpdatedBefore='1900-01-01T00:00:00' -- , OrderStatuses='Pending~Unshipped~PartiallyShipped~PendingAvailability~Shipped~Canceled~Unfulfillable' -- , MarketplaceIds='ATVPDKIKX0DER~A2Q3Y263D00KWC~A2EUQ1WTGCTBG2' -- , FulfillmentChannels='AFN~MFN' -- , PaymentMethods='COD~CVS~Other' -- , AmazonOrderIds='1111111,222222,333333' ) --CONNECTION( -- ServiceUrl='https://sellingpartnerapi-na.amazon.com' --) -
-
Once the data has successfully loaded, go to the sheet to build your dashboard:
Select the Sheet option.
Select the Fields section.
Drag and drop the fields onto the sheet to create your visuals.
MyData
-
Your Amazon Selling Partner (SP-API) data is now ready for analysis!
Use Data flow for data integration
Use this method if you want to build a complete source-to-destination pipeline directly inside Qlik Cloud.
-
Navigate to your My Qlik tenants page, choose your tenant, select the Analytics tile, and click the Create menu item:
-
Click the Data flow tile to start building your integration:
-
Next, create the data flow within your shared space:
Name your data flow.
Select your shared space.
Click the Create button.
-
Now that the data flow is created, open the editor and browse your available connections:
Select the Editor tab.
Click the Browse connections button.
-
Select the gateway-backed ODBC connection we set up earlier:
Choose your gateway connection.
Click Next.
-
Select your source tables and the specific fields you want to import:
Select one or multiple tables.
Uncheck any unwanted columns (optional).
Click Finish.
-
Map your source and destination nodes to define the flow:
Connect the source node to the destination node.
Click Run flow to start the integration process.
-
Wait for the successful completion message to appear:
-
Your Amazon Selling Partner (SP-API) data integration is now complete!
Optional: Centralized data access via ZappySys Data Gateway
In some situations, you may need to provide Amazon Selling Partner (SP-API) 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 Qlik Cloud (client-side) to connect to it.
Let's not wait and get going!
Create Amazon Selling Partner (SP-API) data source in the gateway
In this section we will create a data source for Amazon Selling Partner (SP-API) in the Data Gateway. Let's follow these steps to accomplish that:
-
Search for
gatewayin the Windows Start Menu and open ZappySys Data Gateway Configuration:
-
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
-
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
AmazonSellingPartnerSpApiDSNZappySys API Driver
-
When the ZappySys API Driver configuration window opens, go back to ODBC Data Source Administrator where you already have the Amazon Selling Partner (SP-API) 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 - Amazon Selling Partner (SP-API)Read and write Amazon Selling Partner (SP-API) data effortlessly. Integrate, manage, and automate listings, orders, payments, and reports — almost no coding required.AmazonSellingPartnerSpApiDSN
-
The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then go to Data Gateway configuration and in data source configuration window click Load settings:
AmazonSellingPartnerSpApiDSNZappySys API Driver - Configuration [Version: 2.0.1.10418]ZappySys API Driver - Amazon Selling Partner (SP-API)Read and write Amazon Selling Partner (SP-API) data effortlessly. Integrate, manage, and automate listings, orders, payments, and reports — almost no coding required.AmazonSellingPartnerSpApiDSN
-
Once a window opens, just paste the settings by pressing
CTRL+Vor by clicking right mouse button and then Paste option.
-
Open ODBC data source configuration and click Copy settings:
-
Once done, go to the Network Settings tab and Add a firewall rule for inbound traffic:
- This will initially allow all inbound traffic.
- Click Edit IP filters to restrict access to specific IP addresses or ranges.
-
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:
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 Qlik Cloud. To achieve that, let's perform these steps:
-
Search for
odbcand open the ODBC Data Sources (64-bit):
-
Create a User data source (User DSN) based on the ODBC Driver 17 for SQL Server driver:
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. -
Then set a Name for the data source (e.g.
Gateway) and the address of the Data Gateway:ZappySysGatewayDSNlocalhost,5000
Make sure you separate the hostname and port with a comma, e.g.localhost,5000. -
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
-
Then set the default database property to
AmazonSellingPartnerSpApiDSN(the one we used in the Data Gateway):AmazonSellingPartnerSpApiDSNAmazonSellingPartnerSpApiDSN
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). -
Continue by checking the Trust server certificate option:
-
Once you do that, test the connection:
-
If the connection is successful, everything is good:
-
Done!
We are ready to move to the final step. Let's do it!
Access data in Qlik Cloud via the gateway
Finally, we are ready to read data from Amazon Selling Partner (SP-API) in Qlik Cloud via the Data Gateway. Follow these final steps:
-
Go back to Qlik Cloud.
-
Navigate to your My Qlik tenants page, choose your tenant, select the Analytics tile, and click the Create menu item:
-
Click the Data connection tile:
-
Next, let's create the ODBC data connection by selecting your shared space and finding the right connector:
-
Pick your shared space.
-
Search for odbc.
-
Choose the ODBC (via Direct Access gateway) option.
-
-
Finally, configure the ODBC connection fields to wrap up the setup:
-
Select your Data gateway.
-
Select the System DSN option.
-
Choose the ODBC source (DSN).
-
Select the DB2 SQL syntax.
-
Name the connection.
-
Click Test connection, then click Create.
ZappySysGatewayDSN
-
-
Read the data the same way we discussed at the beginning of this article.
-
That's it!
Now you can connect to Amazon Selling Partner (SP-API) data in Qlik Cloud via the ZappySys Data Gateway.
john and your password.
Explore supported Amazon Selling Partner (SP-API) Connector actions
Got a specific use case in mind? We've mapped out exactly how to perform a variety of essential Amazon Selling Partner (SP-API) operations directly in Qlik Cloud, so you don't have to figure out the setup from scratch. Check out the step-by-step guides below:
- Download Report File to Local Disk
- Get FBA Inventory Summaries (Fulfilled By Amazon)
- Get Market Place Participations
- Get Order (Single)
- Get Order Items (For Single Order)
- Get Orders
- Get Orders Items (For All Orders **Slow**)
- Get Report Data - Comma Separated File (CSV)
- Get Report Data - JSON File
- Get Report Data - Tab Separated File (TSV)
- Get Report Data - XML File
- Get Report Filters
- Get Report Options
- Get Report Types
- Get Vendor PurchaseOrder Items
- Get Vendor PurchaseOrders
- Search Catalog Items
- Make Generic REST API Request
- Make Generic REST API Request (Bulk Write)
Conclusion
In this article we showed you how to connect to Amazon Selling Partner (SP-API) in Qlik Cloud and integrate data without writing complex code — all of this was powered by Amazon Selling Partner (SP-API) 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):