Amazon Selling Partner (SP-API) Connector for Python In this article you will learn how to integrate Amazon Selling Partner (SP-API) data in Python (live / bi-directional connection to Amazon Selling Partner (SP-API)). Amazon Selling Partner Connector (SP-API) can be used to integrated SP-API that helps Amazon sellers to programmatically exchange data on listings, orders, payments, reports, and more.. Using Amazon Selling Partner (SP-API) Connector you will be able to connect, read, and write data from within Python. Follow the steps below to see how we would accomplish that. Download Documentation The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. ODBC PowerPack - System Requirements and Installation Getting Started - Using ODBC PowerPack ODBC API Driver Help File

Connect to Amazon Selling Partner (SP-API) in other apps Connect to Amazon Selling Partner (SP-API) in SSIS Connect to Amazon Selling Partner (SP-API) in SQL Server Connect to Amazon Selling Partner (SP-API) in Power BI Connect to Amazon Selling Partner (SP-API) in SSRS Connect to Amazon Selling Partner (SP-API) in Informatica Connect to Amazon Selling Partner (SP-API) in MS Access Connect to Amazon Selling Partner (SP-API) in MS Excel Connect to Amazon Selling Partner (SP-API) in SSAS Connect to Amazon Selling Partner (SP-API) in C# Connect to Amazon Selling Partner (SP-API) in JAVA Connect to Amazon Selling Partner (SP-API) in Tableau Connect to Amazon Selling Partner (SP-API) in SAP Crystal Reports Connect to Amazon Selling Partner (SP-API) in Azure Data Factory (Pipeline) Connect to Amazon Selling Partner (SP-API) in Azure Data Factory (SSIS) Connect to Amazon Selling Partner (SP-API) in Talend Studio Connect to Amazon Selling Partner (SP-API) in UiPath Connect to Amazon Selling Partner (SP-API) in PowerShell Connect to Amazon Selling Partner (SP-API) in ODBC

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from Amazon Selling Partner (SP-API) using Python we first need to create a DSN (Data Source) which will access data from Amazon Selling Partner (SP-API). We will later be able to read data using Python. Perform these steps:

1. Install ZappySys ODBC PowerPack.

2. Open ODBC Data Sources (x64):
   

3. Create a User Data Source (User DSN) based on ZappySys API Driver

   ZappySys API Driver

   
   You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version.

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:

   AmazonSellingPartner(SP-ApI)DSN

   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.

    OAuth (Self Authorize - Private App) [OAuth]

   Steps to get Amazon Selling Partner (SP-API) Credentials : OAuth (Self Authorize - Private App) [OAuth]
   To call Amazon SP-API you need to register as Developer and create an App to obtain Client ID / Client Secret. After that authorize to get a Refresh Token. Perform the following steps (Detailed steps found in the each link described below)

   1. Go to Register as a Private App developer. You can wait for day or two to get approval. Check status this way
   2. Once your Developer account is approved. Login to your account and create a new app and obtain Client ID and Client Secret.
   3. In the very last step can click here to learn how to obtain Refresh Token (Self-Authorize).
   4. Copy Client ID, Client Secret and Refresh Token and paste on the Connector UI. Refresh Token field is found under the Grid on the Connector UI and Client ID and Client Secret found in the Grid.
   5. For Video Tutorial check this blog post

   Fill in all required parameters and set optional parameters if needed:

   AmazonSellingPartner(SP-ApI)DSN

   Amazon Selling Partner (SP-API)

   OAuth (Self Authorize - Private App) [OAuth]

   https://sellingpartnerapi-na.amazon.com

   Required Parameters
   Optional Parameters
   ClientId	Fill in the parameter...
   ClientSecret	Fill in the parameter...
   TokenUrl	Fill in the parameter...
   TokenUIMode	Fill in the parameter...
   AuthUrl (Do not Use for Private App - Self Authorization)	Fill in the parameter...
   OrdersApiVersion	Fill in the parameter...
   SellerApiVersion	Fill in the parameter...
   ShippingApiVersion	Fill in the parameter...
   ServicesApiVersion	Fill in the parameter...
   FbaApiVersion	Fill in the parameter...
   SalesApiVersion	Fill in the parameter...
   ReportsApiVersion	Fill in the parameter...
   ProductsFeesApiVersion	Fill in the parameter...
   ProductPricingApiVersion	Fill in the parameter...
   CatalogItemsApiVersion	Fill in the parameter...
   VendorOrdersApiVersion	Fill in the parameter...
   RetryMode	Fill in the parameter...
   RetryStatusCodeList	Fill in the parameter...
   RetryCountMax	Fill in the parameter...
   RetryMultiplyWaitTime	Fill in the parameter...

   

6. Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
   

7. Click OK to finish creating the data source.

Video instructions

Read data in Python

Using ODBC DSN

1. Python code to get the data:
   

   AmazonSellingPartner(SP-ApI)DSN')

   

2. When you run the code it will make the API call and read the data:
   

3. Here is Python program's code in text format:

   
       import pyodbc
       conn = pyodbc.connect('DSN=AmazonSellingPartner(SP-ApI)DSN')
   
       cursor = conn.cursor()
   
       #execute query to fetch data from API service
       cursor.execute("SELECT id,title FROM products")
   
       row = cursor.fetchone()
       while row:
           print(row)
           row = cursor.fetchone()
   
       ##For loop example
       #for row in cursor:
       #    print(row)
   

Using a full ODBC connection string

If you want to avoid being dependent on a DSN and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String:

1. Open ODBC data source configuration and click Copy settings:
   

   ZappySys API Driver - Amazon Selling Partner (SP-API)

   Amazon Selling Partner Connector (SP-API) can be used to integrated SP-API that helps Amazon sellers to programmatically exchange data on listings, orders, payments, reports, and more.

   AmazonSellingPartner(SP-ApI)DSN

   
2. The window opens, telling us the connection string was successfully copied to the clipboard:

3. Then in your Python code use Connection String when initializing OdbcConnection object, for example:

   conn = pyodbc.connect('DRIVER={ZappySys API Driver};ServiceUrl=https://yourservices.provider.com/api/xxxx....;AuthName=Http;')

How to install `pyodbc` in the Python?

Advanced topics

Create Custom Stored Procedure in ZappySys Driver

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

1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
   

2. Enter the desired Procedure name and click on OK:
   

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

   
   

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

   
   

5. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
   As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
   

   SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')

   
   

6. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
   

Create Custom Virtual Table in ZappySys Driver

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.

1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
   

2. Enter the desired Table name and click on OK:
   

3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

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

   
   

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

   
   

6. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
   As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
   

   SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

   
   

7. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
   

Actions supported by Amazon Selling Partner (SP-API) Connector

Amazon Selling Partner (SP-API) Connector Examples for Python Connection

This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

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

SELECT * FROM Orders 
Where AmazonOrderId='902-1845936-5435065'
--CONNECTION(
--	ServiceUrl='https://sellingpartnerapi-na.amazon.com'
--)

SELECT * FROM get_order_items 
WITH(
	AmazonOrderId ='902-1845936-5435065'
)
--CONNECTION(
--	ServiceUrl='https://sellingpartnerapi-na.amazon.com'
--)

SELECT * FROM OrderItems
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'
--)

SELECT *
FROM Orders
--DONOT try WHERE AmazonOrderId='TEST_CASE_200' (WHERE clause) for sandbox endpoint, it will return empty row. If you try in Live API then should work. 
WITH(
	  CreatedAfter='TEST_CASE_200' 
	  --CreatedAfter='TEST_CASE_200_NEXT_TOKEN'
	, MarketplaceIds='ATVPDKIKX0DER'
)
CONNECTION(
	ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)

SELECT *
FROM get_order
--DONOT try WHERE AmazonOrderId='TEST_CASE_200' (WHERE clause) for sandbox endpoint, it will return empty row. If you try in Live API then should work. 
WITH(
	AmazonOrderId='TEST_CASE_200'
--  AmazonOrderId='TEST_CASE_IBA_200'	
)
CONNECTION(
	ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)

SELECT *
FROM get_order_items
--DONOT try WHERE AmazonOrderId='TEST_CASE_200' (WHERE clause) for sandbox endpoint, it will return empty row. If you try in Live API then should work. 
WITH(
	AmazonOrderId='TEST_CASE_200'
--  AmazonOrderId='TEST_CASE_IBA_200'	
)
CONNECTION(
	ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)

SELECT *
FROM generic_request
WITH(
	  URL='/orders/v0/orders/TEST_CASE_200/orderItems' 
	, Filter='$.payload.OrderItems[*]'
	, IncludeParentColumns=1
--	, RequestMethod='GET'
--	, Body=''
--	, IsMultiPart=0
--	, RequestContentTypeCode"='Default'
--	, ResponseFormat='Default' --Json, Csv, Xml
--	, Headers='Accept: */* || Cache-Control: no-cache'
--	, PagingMode"=''
--	, PagingByUrlAttributeName=''
--	, PagingIncrementBy='1'
--	, NextUrlAttributeOrExpr=''
--	, NextUrlWaitInMs='0'
--	, ColumnDelimiter=','
--	, HasColumnHeaderRow='True'
--	, ElementsToTreatAsArray=''	
	
)
CONNECTION(
	ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)

SELECT * FROM ReportTypes)

SELECT * FROM download_report
WITH(
	  ReportType='GET_XML_BROWSE_TREE_DATA'
	, TargetFilePath='c:\temp\GET_XML_BROWSE_TREE_DATA.gz'
	, MarketplaceIds='ATVPDKIKX0DER'
  --, FileOverwriteMode='FailIfExists' (Default is 'AlwaysOverwrite')
  --, StartDate='2012-12-31'	
  --, EndDate='today-1d'  
)

SELECT *
FROM get_report_tsv
WITH(
	  ReportType='GET_MERCHANT_LISTINGS_ALL_DATA'
	, MarketplaceIds='ATVPDKIKX0DER'
)

Conclusion

In this article we discussed how to connect to Amazon Selling Partner (SP-API) in Python and integrate data without any coding. Click here to Download Amazon Selling Partner (SP-API) Connector for Python and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download Amazon Selling Partner (SP-API) Connector for Python Documentation 

More integrations

Other application integration scenarios for Amazon Selling Partner (SP-API)

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

C#

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC

Other connectors for Python

Amazon Ads

Amazon MWS

Amazon Selling Partner (SP-API)

Asana

Azure DevOps

Cosmos DB

DropBox

ElasticSearch

FastSpring

Google BigQuery

Google Calendar

Google Drive

Google Sheets

Hubspot

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

Nativo

OData

OneDrive

Outlook Mail (Office 365)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Stripe

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

Download Amazon Selling Partner (SP-API) Connector for Python Documentation

Common Searches: