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

How to read Amazon Selling Partner (SP-API) data in MS SQL/SSRS/Java using ZappySys Data Gateway?


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

Create Data Source in ZappySys Data Gateway based on API Driver

  1. Download and install ZappySys 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.

    AmazonSellingPartner(SP-ApI)DSN

    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:

    AmazonSellingPartner(SP-ApI)DSN
    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.

    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

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

    AmazonSellingPartner(SP-ApI)DSN
    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...
    ODBC DSN Oauth Connection Configuration

  7. Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
    ODBC ZappySys Data Source Preview

  8. Click OK to finish creating the data source.

Reading data from client application

  1. Firstly, to get data from ODBC data source based on ZappySys ODBC driver, in your client application, you would need to connect to ODBC source and then from the list select the data source.
  2. Finally, to read the data just read tables/views in your app or enter a SQL statement to extract data, e.g.:

    SELECT * FROM Orders

Amazon Selling Partner (SP-API) Connector Examples

The ZappySys API Driver is a user-friendly interface designed to facilitate the seamless integration of various applications with the Amazon Selling Partner (SP-API) API. With its intuitive design and robust functionality, the ZappySys API Driver simplifies the process of configuring specific API endpoints to efficiently read or write data from Amazon Selling Partner (SP-API).

Click here to find more Amazon Selling Partner (SP-API) Connector examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

Consume Data inside your App / Programming Language

Once you know how to load data from Amazon Selling Partner (SP-API) Connector, you can click on one of the below links to learn the steps how to consume data inside your App / Programming Language from Amazon Selling Partner (SP-API) Connector.

ODBC inside ETL / Reporting / BI Tools

ODBC inside Programming Languages

Key features of the ZappySys API Driver include:

The API ODBC driver facilitates the reading and writing of data from numerous popular online services (refer to the complete list here) using familiar SQL language without learning complexity of REST API calls. The driver allows querying nested structure and output as a flat table. You can also create your own ODBC / Data Gateway API connector file and use it with this driver.

  1. Intuitive Configuration: The interface is designed to be user-friendly, enabling users to easily set up the specific API endpoints within Amazon Selling Partner (SP-API) without requiring extensive technical expertise or programming knowledge.

  2. Customizable Endpoint Setup: Users can conveniently configure the API endpoint settings, including the HTTP request method, endpoint URL, and any necessary parameters, to precisely target the desired data within Amazon Selling Partner (SP-API).

  3. Data Manipulation Capabilities: The ZappySys API Driver allows for seamless data retrieval and writing, enabling users to fetch data from Amazon Selling Partner (SP-API) and perform various data manipulation operations as needed, all through an intuitive and straightforward interface.

  4. Secure Authentication Integration: The driver provides secure authentication integration, allowing users to securely connect to the Amazon Selling Partner (SP-API) API by inputting the necessary authentication credentials, such as API tokens or other authentication keys.

  5. Error Handling Support: The interface is equipped with comprehensive error handling support, ensuring that any errors or exceptions encountered during the data retrieval or writing process are efficiently managed and appropriately communicated to users for prompt resolution.

  6. Data Visualization and Reporting: The ZappySys API Driver facilitates the seamless processing and presentation of the retrieved data from Amazon Selling Partner (SP-API), enabling users to generate comprehensive reports and visualizations for further analysis and decision-making purposes.

Overall, the ZappySys API Driver serves as a powerful tool for streamlining the integration of applications with Amazon Selling Partner (SP-API), providing users with a convenient and efficient way to access and manage data, all through a user-friendly and intuitive interface.