How to integrate Amazon Selling Partner (SP-API) with UiPath

Learn how to quickly and efficiently connect Amazon Selling Partner (SP-API) with UiPath 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 for UiPath (often referred to as the Amazon Selling Partner (SP-API) 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 Amazon Selling Partner (SP-API) ODBC Driver

Step-by-step instructions

To get data from Amazon Selling Partner (SP-API) using UiPath, we first need to create an ODBC data source. We will later read this data in UiPath. 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):

   

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

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

   AmazonSellingPartnerSpApiDSN

   Amazon Selling Partner (SP-API)

   

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.

   Private app

   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:

   1. Register as an Amazon Private SP-API Developer. You may need to wait for a day or two to get approved (check approval status).
   2. 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:
   3. Continue by naming your application in the App name field, choose SP API as API Type, and select the Roles for your app (i.e. permissions):
   4. Once you do that, click View link in LWA credentials column to copy Client identifier and Client secret (we will use them later):
   5. Now it's time to Authorize your app:
   6. Finish authorizing it by presing Authorize app button:
   7. Finally, copy the Refresh Token (we will use it in the next step):
   8. 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.
   9. Click Test Connection to confirm the connection is working.
   10. 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:

   1. Set Authentication Type to Private app [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:

   AmazonSellingPartnerSpApiDSN

   Amazon Selling Partner (SP-API)

   Private app [OAuth]

   https://sellingpartnerapi-na.amazon.com

   Required 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

   

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

   

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 UiPath 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 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 UiPath:

   

   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

   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'
   --)

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

9. Click OK to finish creating the data source.

Video Tutorial

Read Amazon Selling Partner (SP-API) data in UiPath Studio (workstation)

Here we will be reading Amazon Selling Partner (SP-API) data on your workstation. To accomplish that we will create and run UiPath process package locally. Later on, we'll explore how to publish the package to Orchestrator and run it remotely. For now, let's focus on working locally and get started!

1. Open UiPath Studio.

2. Before we really begin the work, make sure UiPath Studio is set as your profile (blue application icon).

3. In case, it is set to UiPath StudioX, you can change it in UiPath StudioX Settings:

   

   Simply select UiPath Studio option:

   

4. Start by creating a new project based on UiPath Process template:

   

5. Add Run Query activity in Main Sequence box:

   

6. Click Configure Connection... button to create an ODBC connection:

   

7. Continue by clicking Connection Wizard:

   

8. When the window opens, select ODBC-based driver, provider, and then choose ODBC data source:

   AmazonSellingPartnerSpApiDSN

   AmazonSellingPartnerSpApiDSN

   
   You can also select Use connection string option and use whole ODBC connection string instead. Obtain the connection string by pressing Copy Settings button in your data source configuration.

9. Once you do that, it's time to configure a SQL query:

   
   Make sure, you enclose the query in double quotes!

10. Proceed by adding a Write CSV activity after Run Query:

    
    In this article we are using Write CSV, but you can freely add any other destination of your choice, e.g. Write DataTable to Excel.

11. Once you do that, configure the added Write CSV, this will write Amazon Selling Partner (SP-API) data to a CSV file:

    

12. It's time for fun! Which means it's time for debugging! Just run the package locally to debug:

    

13. Finally, ensure there are no execution errors!

    

Run UiPath package using Orchestrator (via robot)

UiPath also offers the ability to execute packages remotely using Orchestrator and a robot. This is achieved by publishing the package to UiPath Orchestrator, installing UiPath Assistant on the remote machine, connecting it to Orchestrator, enabling us to run the package remotely. It may sound complicated at first glance, but further steps will clear things out. Let's not waste our precious time and delve into the details!

Publish process package from UiPath Studio

1. First of all, open the UiPath process package we created in the previous step
2. Set the option that our process package Starts in Background:
3. We are ready to Publish it:
4. Make sure, you publish it to the Shared folder in UiPath Orchestrator Tenant workspace:
5. Finally, success! We are ready for the next step - creating UiPath robot - so we can automate the job:

Create robot in UiPath Orchestrator

1. First of all, let's open UiPath Orchestrator from UiPath Automation Cloud console:
2. It's time to create a robot, which will run unattended packages:
3. But first we have to create a runtime. Choose to host our robot on-premise, not in UiPath infrastructure:
4. Let's move along and Create new machine template, this will create a machine in UiPath Orchestrator:
5. Configure the machine to run in Production environment:
6. We are ready to Create new robot account in the new machine:
7. Let's make our robot to work only on background automations:
8. Continue by selecting newly created robot:
9. Select Shared folder, so that everyone in the team can benefit from it:
   This is the folder where we published our UiPath process package "MyProcess"
10. We are almost done! We are given machine Client ID and Client secret which we will use to connect UiPath Assistant to our created machine in Orchestrator. Let's leave this open for a while and see how we can do it in the next step.

Connect UiPath Assistant to Orchestrator

We are ready to connect UiPath Assistant to the machine we created in Orchestrator. UiPath Assistant will run our package in a remote machine. Let's connect it and give it some work!

1. Connect to a remote machine (where your UiPath process package will be running).
2. Install UiPath Studio there.
3. Then configure ODBC data source:

   If you chose Use user or system data source option in connection configuration, when creating UiPath process package, then create an identical ODBC data source on the same remote machine. Use the same configuration as the one created in your workstation in the first step.

   Use Copy Settings and Load Settings buttons to make your life easier. They will help you to transfer settings between different ODBC data sources.

   If you chose Use connection string option, then you don't have to do anything. However, you still have to install ODBC PowerPack on the remote machine.

4. Continue by opening UiPath Assistant and going to Preferences:
5. Find Orchestrator Settings menu item and click it:
6. And here even bigger fun begins! But fear not, all you have to do is open your web browser window with Client ID & Client secret we obtained in the previous step and simply copy and paste those values into UiPath Assistant. Also, don't forget to configure Orchestrator URL:
7. Finally, we get rewarded for the hard work with the Connected as Unattended status:

Create and run UiPath process in Orchestrator

We are at the finish line! Let's create and run UiPath process. This will execute the package on your remote machine using the UiPath Assistant configured earlier.

1. First of all, open UiPath Orchestrator from UiPath Automation Cloud console.
2. Then proceed by going to Process in Shared folder:
3. Continue by simply clicking on Add process button:
4. Select the process package we created in UiPath Studio:
5. Rest a while, and just hit Next, unless your package has requirements:
6. Then simply hit Create button:
7. But let's not stop here and Start the process by creating a job right away:
8. Use the same Production runtime we created before and hit Start:
9. We've reached the final step! In the CSV destination file or destination of your choice you should see Amazon Selling Partner (SP-API) data:

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.

To achieve this, you must first create a data source in the Data Gateway (server-side) and then create an ODBC data source in UiPath (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:

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

   

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
   

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
   AmazonSellingPartnerSpApiDSN

   ZappySys API Driver

   

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

     
   • 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:

     AmazonSellingPartnerSpApiDSN

     

     ZappySys 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+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:

   
   • 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:

   
   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 UiPath. To achieve that, let's perform these steps:

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

   

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

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

   ZappySysGatewayDSN

   localhost,5000

   
   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
   

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

   AmazonSellingPartnerSpApiDSN

   AmazonSellingPartnerSpApiDSN

   
   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:

   

7. Once you do that, test the connection:

   

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

   

9. Done!

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

Access data in UiPath via the gateway

Finally, we are ready to read data from Amazon Selling Partner (SP-API) in UiPath via the Data Gateway. Follow these final steps:

1. Go back to UiPath.

2. Add Run Query activity in Main Sequence box:

   

3. Click Configure Connection... button to create an ODBC connection:

   

4. Continue by clicking Connection Wizard:

   

5. When the window opens, select ODBC-based driver, provider, and then choose ODBC data source:

   ZappySysGatewayDSN

   ZappySysGatewayDSN

   
   You can also select Use connection string option and use whole ODBC connection string instead. Obtain the connection string by pressing Copy Settings button in your data source configuration.

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

7. That's it!

Now you can connect to Amazon Selling Partner (SP-API) data in UiPath via the Data Gateway.

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 UiPath, 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 UiPath 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):

Explore UiPath connectors

Amazon Ads

Amazon Athena

Apache Derby

Apache Hive

Apache Spark

Asana

Azure DevOps

Cosmos DB

Dropbox

DuckDB (Parquet)

ElasticSearch

FastSpring

Gmail

Google Ads

Google BigQuery

Google Calendar

Google Drive

Google Search Console

Google Sheets

Hubspot

Infor Data Lake

Jira

Mailchimp

ManageEngine ServiceDesk Plus (Zoho)

MariaDB

MySQL

Neo4j

OData

OneDrive

Outlook Mail (Office 365)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Starburst

Stripe

Trino

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

More Amazon Selling Partner (SP-API) integrations

SSIS

SQL Server

Microsoft Fabric

Power BI

SSRS

Informatica PowerCenter

MS Access

Excel

SSAS

C#

Python

Java

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

PowerShell

Alteryx

ODBC