Amazon Selling Partner (SP-API) Connector for C# 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 C#. 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 C#. Let's follow the steps below to see how we can accomplish that! Download Documentation Amazon Selling Partner (SP-API) Connector for C# 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.

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 Python 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 C# 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 C#. Perform these steps:

1. Download and install ODBC PowerPack.

2. Open ODBC Data Sources (x64):

   

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

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 [OAuth]

   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]

   Steps how to get and use Amazon Selling Partner (SP-API) credentials : Private app [OAuth]
   

   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!

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

   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)

   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

   

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 C# 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 C#:

   

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

9. Click OK to finish creating the data source.

Video Tutorial

Read data in C#

Using ODBC DSN

1. Create a new Console project and use this code to read the data:
   

   "AmazonSellingPartnerSpApiDSN";

   

2. Press F5 to run the code and read the data:
   

3. Here is the code in text format:

   using System;
   using System.Data.Odbc;
   
   namespace ConsoleApp {
       class Program {
           static void Main() {
               var dsn = "AmazonSellingPartnerSpApiDSN";
               using (var conn = new OdbcConnection(String.Format("DSN={0}", dsn)))
               {
                   conn.Open();
                   var cmd = new OdbcCommand("SELECT * FROM Products", conn);
                   
                   //Increase the timeout duration from the default 30 seconds, which may be insufficient in certain scenarios
                   cmd.CommandTimeout=600; // 600-Seconds
                   
                   var rdr = cmd.ExecuteReader();
                   while (rdr.Read())
                   {
                       for (int i = 0; i < rdr.FieldCount; i++)
                       {
                               Console.Write("{0}\t", rdr[i]);
                       }
                       Console.WriteLine();
                   }
               }
               Console.ReadKey();
           }
       }
   }
   

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 - Configuration [Version: 2.0.1.10418]

   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

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

3. Then in your C# code, pass the connection string as an argument when calling the OdbcConnection object's constructor, for example:

   var connectionString = @"DRIVER={ZappySys API Driver};ServiceUrl=https://sellingpartnerapi-na.amazon.com;ScopeSeparator={space};UseCustomApp=True;CustomAuthHeader=x-amz-access-token;AccessToken=fake";
   
   using (var conn = new OdbcConnection(connectionString))
   {
       // your code goes here
   }

Limitations of using a full connection string

Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:

"Connection string exceeds maximum allowed length of 1024"

But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:

1. Open your ODBC data source.
2. Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
3. Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
4. Continue by pasting the copied connection string into a newly created file and save it.
5. Finally, the last step! Just construct a shorter ODBC connection string using this format:

   DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt

6. Our troubles are over! Now you should be able to use this connection string in C# with no problems.

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

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

• 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
• Generic Request
• Generic Request (Bulk Write)

Conclusion

In this article we showed you how to connect to Amazon Selling Partner (SP-API) in C# and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Amazon Selling Partner (SP-API), but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).

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

More integrations

Other connectors for C#

Amazon Ads

Amazon Athena

Apache Derby

Apache Hive

Apache Spark

Asana

Azure DevOps

Cosmos DB

DropBox

ElasticSearch

FastSpring

Google Ads

Google BigQuery

Google Calendar

Google Drive

Google Sheets

Hubspot

Infor Data Lake

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

MariaDB

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

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

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC

Common Searches: