Amazon Selling Partner (SP-API) Connector for SSIS

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

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

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

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 SSIS
  • How to configure the connection for Amazon Selling Partner (SP-API)
  • Features of the ZappySys API Source (Authentication / Query Language / Examples / Driver UI)
  • How to use the Amazon Selling Partner (SP-API) in SSIS

Prerequisites

Before we begin, make sure the following prerequisites are met:

  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

Read data from Amazon Selling Partner (SP-API) in SSIS (Export data)

In this section we will learn how to configure and use Amazon Selling Partner (SP-API) Connector in API Source to extract data from Amazon Selling Partner (SP-API).

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

    In the new SSIS project screen you will find the following:

    • SSIS ToolBox on left side bar
    • Solution Explorer and Property Window on right bar
    • Control flow, data flow, event Handlers, Package Explorer in tab windows
    • Connection Manager Window in the bottom
    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.

  3. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.

    SSIS Data Flow Task - Drag and Drop

  4. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:

    SSIS API Source (Predefined Templates) - Drag and Drop

  5. Select New Connection to create a new connection:

    API Source - New Connection

  6. Use a preinstalled Amazon Selling Partner (SP-API) Connector from Popular Connector List or press Search Online radio button to download Amazon Selling Partner (SP-API) Connector. Once downloaded simply use it in the configuration:

    Amazon Selling Partner (SP-API)
    Amazon Selling Partner (SP-API) Connector Selection

  7. Now it's time to configure authentication. Firstly, configure authentication settings in Amazon Selling Partner (SP-API) service and then proceed by configuring API Connection Manager. Start by expanding an authentication type:

    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: 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!
    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:
    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
    ZappySys OAuth Connection

  8. Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

    API Source - 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.
    API Source - Select Endpoint

  9. That's it! We are done! Just in a few clicks we configured the call to Amazon Selling Partner (SP-API) using Amazon Selling Partner (SP-API) Connector.

    You can load the source data into your desired destination using the Upsert Destination , which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV , Excel , Azure Table , Salesforce , and more . You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)

    Execute Package - Reading data from Amazon Selling Partner (SP-API) and load into target

Write data to Amazon Selling Partner (SP-API) using SSIS (Import data)

In this section we will learn how to configure and use Amazon Selling Partner (SP-API) Connector in the API Destination to write data to Amazon Selling Partner (SP-API).

Video tutorial

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download SSIS PowerPack for Amazon Selling Partner (SP-API) integration in SSIS
  • How to configure connection for Amazon Selling Partner (SP-API)
  • How to write or lookup data to Amazon Selling Partner (SP-API)
  • Features about SSIS API Destination
  • Using Amazon Selling Partner (SP-API) Connector in SSIS

Step-by-step instructions

In upper section we learned how to read data, now in this section we will learn how to configure Amazon Selling Partner (SP-API) in the API Source to POST data to the Amazon Selling Partner (SP-API).

  1. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

  2. From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
    SSIS API Destination (Predefined Templates) - Drag and Drop

  3. Select New Connection to create a new connection:

    API Destination - 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.
    API Destination - New Connection

  4. Use a preinstalled Amazon Selling Partner (SP-API) Connector from Popular Connector List or press Search Online radio button to download Amazon Selling Partner (SP-API) Connector. Once downloaded simply use it in the configuration:

    Amazon Selling Partner (SP-API)
    Amazon Selling Partner (SP-API) Connector Selection

  5. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in 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: 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!
    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:
    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
    ZappySys OAuth Connection

  6. Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.

    API Destination - 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.
    API Destination - Select Endpoint

  7. Finally, map the desired columns:

    API Destination - 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.
    API Destination - Columns Mapping

  8. That's it; we successfully configured the POST API Call. In a few clicks we configured the Amazon Selling Partner (SP-API) API call using ZappySys Amazon Selling Partner (SP-API) Connector

    Execute Package - Reading data from API Source and load into target

Load Amazon Selling Partner (SP-API) data into SQL Server using Upsert Destination (Insert or Update)

Once you configured the data source, you can load Amazon Selling Partner (SP-API) data into SQL Server using Upsert Destination.

Upsert Destination can merge or synchronize source data with the target table. It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets. Upsert Destination also supports very fast bulk upsert operation along with bulk delete.

Upsert operation - a database operation which performs INSERT or UPDATE SQL commands based on record's existence condition in the target table. It inserts records that don't have matching records in the target table or updates them, if they do, by matching them by key columns.

Upsert Destination supports INSERT, UPDATE, and DELETE operations, so it is similar to SQL Server's MERGE command, except it can be used directly in SSIS package.

  1. From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.

  2. Connect your SSIS source component to Upsert Destination.

  3. Double-click on Upsert Destination component to open configuration window.

  4. Start by selecting the Action from the list.

  5. Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.

  6. Then select a table from the Target Table list or click New button to create a new table based on the source columns.

  7. Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).

  8. Finally, click Map All button to map all columns and then select the Key columns to match the columns on:

    Configure SSIS Upsert Destination component to merge data with SQL Server, PostgreSQL, or Redshift table

  9. Click OK to save the configuration.

  10. Run the package and Amazon Selling Partner (SP-API) data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:

    Execute Package - Reading data from API Source and load into target

  11. Done!

Deploy and schedule SSIS package

After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in this article:

Running SSIS package in Azure Data Factory (ADF)

To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:

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

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

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

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:

  1. Download and install ODBC PowerPack.

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

    Opening Data Gateway

  3. 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
    Data Gateway - Adding User

  4. 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
    Data Gateway - Adding data source

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

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

    ZappySys Data Gateway - Save Changes
    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 SSIS. To achieve that, let's perform these steps:

  1. Open ODBC Data Sources (x64):

    Open ODBC Data Source

  2. Create a User data source (User DSN) based on ODBC Driver 17 for SQL Server:

    ODBC Driver 17 for SQL Server
    Create new User DSN for 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.

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

    GatewayDSN
    localhost,5000
    ODBC driver for SQL Server - Setting hostname and port
    Make sure you separate the hostname and port with a comma, e.g. localhost,5000.

  4. 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
    ODBC driver for SQL Server - Selecting SQL Authentication

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

    AmazonSellingPartnerSpApiDSN
    ODBC driver for SQL Server - Selecting database

  6. Continue by checking Trust server certificate option:

    ODBC driver for SQL Server - Trusting certificate

  7. Once you do that, test the connection:

    ODBC driver for SQL Server - Testing connection

  8. If connection is successful, everything is good:

    ODBC driver for SQL Server - Testing connection succeeded

  9. Done!

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

Accessing data in SSIS via Data Gateway

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

  1. Go back to SSIS.

  2. From the SSIS toolbox drag and drop ODBC Source on the dataflow designer surface:

    Drag-and-drop ODBC Source onto Control Flow in SSIS

  3. Double-click on ODBC Source component to configure it.

  4. Click on New... button, it will open Configure ODBC Connection Manager window. Once it opens, click on New... button to create a new ODBC connection to Amazon Selling Partner (SP-API) ODBC data source:

    Create ODBC Connection Manager in SSIS

  5. Then choose the data source from the list and click Test Connection button. If the connection test is successful, close the window, and then click OK button to finish the configuration:

    GatewayDSN
    Create ODBC Connection Manager in SSIS

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

Conclusion

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

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

More integrations

Other connectors for SSIS

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
Download Amazon Selling Partner (SP-API) Connector for SSIS Documentation