Amazon Selling Partner (SP-API) ODBC Driver

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.

In this article you will learn how to quickly and efficiently integrate Amazon Selling Partner (SP-API) data in ODBC without coding. We will use high-performance Amazon Selling Partner (SP-API) Connector to easily connect to Amazon Selling Partner (SP-API) and then access the data inside ODBC.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

Amazon Selling Partner (SP-API) ODBC Driver 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.

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

Step-by-step instructions

To get data from Amazon Selling Partner (SP-API) using ODBC 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 ODBC. 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.
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)

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:

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 API as 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:

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

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)

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.

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

Configure table/endpoint parameters in ODBC data source based on API Driver

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.

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

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).
Click OK to finish creating the data source.

Video Tutorial

Centralized data access via 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

If you need any of these requirements, you will have to create a data source in Data Gateway to connect to Amazon Selling Partner (SP-API), and to create an ODBC data source to connect to Data Gateway in ODBC.

Let's not wait and get going!

Creating Amazon Selling Partner (SP-API) data source in Gateway

In this section we will create a data source for Amazon Selling Partner (SP-API) in Data Gateway. Let's follow these steps to accomplish that:

Search for gateway in Windows Start Menu and open ZappySys Data Gateway Configuration:
Go to Users tab and follow these steps to add a Data Gateway user:
- Click Add button
- In Login field enter username, e.g., john
- Then enter a Password
- Check Is Administrator checkbox
- Click OK to save
Now we are ready to add a data source:
- Click Add button
- Give Datasource a name (have it handy for later)
- Then select Native - ZappySys API Driver
- Finally, click OK
AmazonSellingPartnerSpApiDSN

ZappySys API Driver
When the ZappySys API Driver configuration window opens, configure the Data Source the same way you configured it in ODBC Data Sources (64-bit), in the beginning of this article.
Very important step. Now, after creating or modifying the data source make sure you:
- Click the Save button to persist your changes.
- Hit Yes, once asked if you want to restart the Data Gateway service.
This will ensure all changes are properly applied:

Skipping this step may result in the new settings not taking effect and, therefore you will not be able to connect to the data source.

Creating ODBC data source for Data Gateway

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

Open ODBC Data Sources (x64):
Create a User data source (User DSN) based on ODBC Driver 17 for SQL Server:

ODBC Driver 17 for SQL Server

If you don't see ODBC Driver 17 for SQL Server driver in the list, choose a similar version driver.
Then set a Name of the data source (e.g. Gateway) and the address of the Data Gateway:

GatewayDSN

localhost,5000

Make sure you separate the hostname and port with a comma, e.g. localhost,5000.
Proceed with authentication part:
- Select SQL Server authentication
- In Login ID field enter the user name you used in Data Gateway, e.g., john
- Set Password to the one you configured in Data Gateway
Then set the default database property to AmazonSellingPartnerSpApiDSN (the one we used in Data Gateway):

AmazonSellingPartnerSpApiDSN
Continue by checking Trust server certificate option:
Once you do that, test the connection:
If connection is successful, everything is good:
Done!

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

Accessing data in ODBC via Data Gateway

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

Go back to ODBC.
Open your ODBC client application and use GatewayDSN to connect to Amazon Selling Partner (SP-API).
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 ODBC via the Data Gateway.

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

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

Learn how to perform common Amazon Selling Partner (SP-API) actions directly in ODBC with these how-to guides:

Conclusion

In this article we showed you how to connect to Amazon Selling Partner (SP-API) in ODBC and integrate data without any coding, saving you time and effort.

We encourage you to download Amazon Selling Partner (SP-API) Connector for ODBC 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 Amazon Selling Partner (SP-API) Connector for ODBC Documentation