Amazon Selling Partner (SP-API) Connector
Documentation
Version: 1
Documentation

How to 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.

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

    1. SSIS ToolBox on left side bar
    2. Solution Explorer and Property Window on right bar
    3. Control flow, data flow, event Handlers, Package Explorer in tab windows
    4. 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.

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

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

  6. Select New Connection to create a new connection:
    API Source - New Connection

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

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

    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
    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...
    ZappySys OAuth Connection

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

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