Amazon Selling Partner (SP-API) Connector for SSRS

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

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

Download Documentation

Video Tutorial - Integrate Amazon Selling Partner (SP-API) data in SSRS

This video covers the following topics and more, so please watch carefully. After watching the video, follow the steps outlined in this article:

  • How to download and install the required PowerPack for Amazon Selling Partner (SP-API) integration in SSRS
  • How to configure the connection for Amazon Selling Partner (SP-API)
  • Features of the ZappySys API Driver (Authentication / Query Language / Examples / Driver UI)
  • How to use the Amazon Selling Partner (SP-API) in SSRS

Create Data Source in ZappySys Data Gateway based on API Driver

  1. Download and install ODBC PowerPack.

  2. Search for gateway in start menu and Open ZappySys Data Gateway:
    Open ZappySys Data Gateway

  3. Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
    ZappySys Data Gateway - Add User

  4. Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.

    AmazonSellingPartnerSpApiDSN

    ZappySys Data Gateway - Add Data Source

  5. 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)
    ODBC DSN Template Selection
  6. 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.

    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: Add new app client as Amazon private developer
    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): Register Amazon SP API app
    4. Once you do that, click View link in LWA credentials column to copy Client identifier and Client secret (we will use them later): Copy client id and client secret of Private app in Amazon
    5. Now it's time to Authorize your app: Start authorizing Private app in Amazon developer area
    6. Finish authorizing it by presing Authorize app button: Authorize Private app in Amazon developer area
    7. Finally, copy the Refresh Token (we will use it in the next step): Use refresh token to get Amazon Selling Partner data via REST API
    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
    ODBC DSN Oauth Connection Configuration

  7. 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
    Open Query Builder in API ODBC Driver to read and write data to REST API
  8. 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 SSRS 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.
  9. 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 SSRS:

    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'
    --)
    API ODBC Driver-based data source data preview
    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).
  10. Click OK to finish creating the data source.

Read data in SSRS from ZappySys Data Gateway

  1. Open Visual Studio and create a new SSRS project
  2. Then add a new Shared Data Source (you can create a non-shared data source inside report too):

    Adding a Data Source in SSRS project
  3. Continue with creating the Shared Data Source. Select Microsoft SQL Server as Type and hit Build button to proceed further:

    Configuring a Data Source to access API data in SSRS project
  4. Once a window opens, configure it similarly. Configure "AmazonSellingPartnerSpApiDSN" as database name. Finally, hit Test Connection and OK:

    AmazonSellingPartnerSpApiDSN
    Configuring thoroughly a Data Source to access API data in SSRS project
  5. Another window opens, and it should look similarly to this one below which ends the creation of a Data Source:

    DataSource=localhost,5000;Initial Catalog=AmazonSellingPartnerSpApiDSN
    How Data Source in SSRS project looks like
  6. Now it's time to create a Dataset. If you don't have a report created, in one of the wizard's steps it will look like this:

    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' --)
    Specifying a query in SSRS Dataset to access API data #1
  7. Finally, once you complete the report, similar results will show up:

    ZappySys Data Gateway API data source results

Passing Parameters to SSRS Report / Filter data

If you want to parameterize your report, then refer to this article

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

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

Conclusion

In this article we showed you how to connect to Amazon Selling Partner (SP-API) in SSRS 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 SSRS 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 SSRS Documentation

More integrations

Other connectors for SSRS

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

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

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications

  • How to connect Amazon Selling Partner (SP-API) in SSRS?

  • How to get Amazon Selling Partner (SP-API) data in SSRS?

  • How to read Amazon Selling Partner (SP-API) data in SSRS?

  • How to load Amazon Selling Partner (SP-API) data in SSRS?

  • How to import Amazon Selling Partner (SP-API) data in SSRS?

  • How to pull Amazon Selling Partner (SP-API) data in SSRS?

  • How to push data to Amazon Selling Partner (SP-API) in SSRS?

  • How to write data to Amazon Selling Partner (SP-API) in SSRS?

  • How to POST data to Amazon Selling Partner (SP-API) in SSRS?

  • Call Amazon Selling Partner (SP-API) API in SSRS

  • Consume Amazon Selling Partner (SP-API) API in SSRS

  • Amazon Selling Partner (SP-API) SSRS Automate

  • Amazon Selling Partner (SP-API) SSRS Integration

  • Integration Amazon Selling Partner (SP-API) in SSRS

  • Consume real-time Amazon Selling Partner (SP-API) data in SSRS

  • Consume real-time Amazon Selling Partner (SP-API) API data in SSRS

  • Amazon Selling Partner (SP-API) ODBC Driver | ODBC Driver for Amazon Selling Partner (SP-API) | ODBC Amazon Selling Partner (SP-API) Driver | SSIS Amazon Selling Partner (SP-API) Source | SSIS Amazon Selling Partner (SP-API) Destination

  • Connect Amazon Selling Partner (SP-API) in SSRS

  • Load Amazon Selling Partner (SP-API) in SSRS

  • Load Amazon Selling Partner (SP-API) data in SSRS

  • Read Amazon Selling Partner (SP-API) data in SSRS

  • Amazon Selling Partner (SP-API) API Call in SSRS