Amazon Selling Partner (SP-API) Connector for Power BI

In this article you will learn how to integrate Amazon Selling Partner (SP-API) data in Power BI without coding in just a few clicks (live / bi-directional connection to 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..

Using Amazon Selling Partner (SP-API) Connector you will be able to connect, read, and write data from within Power BI. Follow the steps below to see how we would accomplish that.

Download Documentation

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

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

  • How to download / install required driver for Amazon Selling Partner (SP-API) integration in Power BI
  • How to configure connection for Amazon Selling Partner (SP-API)
  • Features about API Driver (Authentication / Query Language / Examples / Driver UI)
  • Using Amazon Selling Partner (SP-API) Connection in Power BI

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from Amazon Selling Partner (SP-API) using Power BI 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 Power BI. Perform these steps:

  1. Install ZappySys ODBC PowerPack.

  2. Open ODBC Data Sources (x64):
    Open ODBC Data Source

  3. Create a User Data Source (User DSN) based on ZappySys API Driver

    ZappySys API Driver
    Create new User DSN for ZappySys API Driver
    You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version.
  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)
    ODBC DSN Template Selection

  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.

    Steps how to get and use 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:

    AmazonSellingPartnerSpApiDSN
    Amazon Selling Partner (SP-API)
    OAuth (Self Authorize - Private App) [OAuth]
    https://sellingpartnerapi-na.amazon.com
    Optional Parameters
    ClientId
    ClientSecret
    TokenUrl https://api.amazon.com/auth/o2/token
    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

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

  7. Click OK to finish creating the data source.

Video instructions

Read Amazon Selling Partner (SP-API) data in Power BI using ODBC

Importing Amazon Selling Partner (SP-API) data into Power BI from table or view

  1. Once you open Power BI Desktop click Get Data to get data from ODBC:
    Power Bi Get Data

  2. A window opens, and then search for "odbc" to get data from ODBC data source:
    Power Bi ODBC Get Data

  3. Another window opens and asks to select a Data Source we already created. Choose AmazonSellingPartnerSpApiDSN and continue:

    AmazonSellingPartnerSpApiDSN
    Power Bi Select ZappySys Driver DSN

  4. Most likely, you will be asked to authenticate to a newly created DSN. Just select Windows authentication option together with Use my current credentials option:

    AmazonSellingPartnerSpApiDSN
    Power Bi DSN Authenticaation

  5. Finally, you will be asked to select a table or view to get data from. Select one and load the data!
    Power Bi Load DSN Table Data

  6. Finally, finally, use extracted data from Amazon Selling Partner (SP-API) in a Power BI report:
    Power Bi Extracted DSN Table Data

Importing Amazon Selling Partner (SP-API) data into Power BI using SQL query

If you wish to import Amazon Selling Partner (SP-API) data from SQL query rather than a table then you can use advanced options during import steps (as below). After selecting DSN you can click on advanced options to see SQL Query editor.

AmazonSellingPartnerSpApiDSN
                SELECT
                    ProductID,
                    ProductName,
                    SupplierID,
                    CategoryID,
                    QuantityPerUnit,
                    UnitPrice
                FROM Products
                WHERE UnitPrice > 20
            
Get REST API data in Power BI Desktop using SQL query and ODBC
Consider using Custom Objects feature in ODBC data source to encapsulate SQL query in a Virtual Table. This way, you can see a virtual table in Power BI table list where you can import multiple objects using the same connection rather than creating a new connection for each custom SQL query.

Using a full ODBC connection string

In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:

  1. Open ODBC data source configuration and click Copy settings:
    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
    Copy connection string for ODBC application
  2. The window opens, telling us the connection string was successfully copied to the clipboard: Successful connection string copying for ODBC application
  3. Then just paste the connection string into your script:
    AmazonSellingPartnerSpApiDSN
    DRIVER={ZappySys API Driver};ServiceUrl=https://sellingpartnerapi-na.amazon.com;ScopeSeparator={space};UseCustomApp=True;CustomAuthHeader=x-amz-access-token;AccessToken=fake
    Use full connection string in Power BI Desktop to read API data
  4. You are good to go! The script will execute the same way as using a DSN.
The DSN defined in the Data source name (DSN) field will be ignored.

Have in mind that a full connection string has length limitations.

Proceed to the next step to find out the details.

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 Power BI with no problems.
This feature requires ODBC PowerPack v1.9.0 or later.

Editing query for table in Power BI

There will be a time you need to change the initial query after importing data into Power BI. Don't worry, just right-click on your table and click Edit query menu item:

Edit query in Power BI to get REST API data
Refer to Power Query M reference for more information on how to use its advanced features in your queries.

Using parameters in Power BI (dynamic query)

In the real world, many values of your REST / SOAP API call may be coming from parameters. If that's the case for you can try to edit script manually as below. In below example its calling SQL Query with POST method and passing some parameters. Notice below where paraAPIKey is Power BI Parameter (string type). You can use parameters anywhere in your script just like the normal variable.

To use a parameter in Power BI report, follow these simple steps:

  1. Firstly, you need to Edit query of your table (see previous section)

  2. Then just create a new parameter by clicking Manage Parameters dropdown, click New Parameter option, and use it in the query:

    						
                                = Odbc.Query("dsn=AmazonSellingPartnerSpApiDSN",
                                             "SELECT ProductID, ProductName, UnitPrice, UnitsInStock
                                              FROM Products
                                              WHERE UnitPrice > " & Text.From(MyParameter) & "
                                              ORDER BY UnitPrice")
                            
                    
    Use parameter in Power BI to get REST API data
    Refer to Power Query M reference for more information on how to use its advanced features in your queries.

Using DirectQuery Option rather than Import

So far we have seen how to Import Amazon Selling Partner (SP-API) data into Power BI but what if you have too much data and you dont want to import but link it. Power BI Offers very useful feature for this scenario. Its called DirectQuery Option. In this section we will explore how to use DirectQuery along with ZappySys Drivers.

Out of the box ZappySys Drivers wont work in ODBC Connection Mode so you have to use SQL Server Connection rather than ODBC if you wish to use Live data using DirectQuery option. See below step by step instructions to enable DirectQuery mode in Power BI for Amazon Selling Partner (SP-API) data.

Basically we will use ZappySys Data Gateway its part of ODBC PowerPack. We will then use Linked Server in SQL Server to Link API Service and then we will issue OPENROWSET queries from Power BI to SQL Server and it will then call Amazon Selling Partner (SP-API) via ZappySys Data Gateway.

  1. First read this article carefully, How to query Amazon Selling Partner (SP-API) API in SQL Server.
  2. Once linked server is configured we are ready to issue API query in Power BI.
  3. Click Get Data in Power BI, select SQL Server Database
  4. Enter your server name and any database name
  5. Select Mode as DirectQuery
  6. Click on Advanced and enter query like below (we are assuming you have created Amazon Selling Partner (SP-API) Data Source in Data Gateway and defined linked server (Change name below).
    SELECT * FROM OPENQUERY([AMAZON_SELLING_PARTNER_(SP-API)_LINKED_SERVER], 'SELECT * FROM Customers')
    SELECT * FROM OPENQUERY([AMAZON_SELLING_PARTNER_(SP-API)_LINKED_SERVER], 'SELECT * FROM Customers')
    DirectQuery option for Power BI (Read Amazon Selling Partner (SP-API) Data Example using SQL Server Linked Server and ZappySys Data Gateway)


    DirectQuery option for Power BI (Read Amazon Selling Partner (SP-API) Data Example using SQL Server Linked Server and ZappySys Data Gateway)

  7. Click OK and Load data ... That's it. Now your Amazon Selling Partner (SP-API) API data is linked rather than imported.

Publishing Power BI report to Power BI service

Here are the instructions on how to publish a Power BI report to Power BI service from Power BI Desktop application:

  1. First of all, go to Power BI Desktop, open a Power BI report, and click Publish button:

    Publish Power BI report to Power BI service
  2. Then select the Workspace you want to publish report to and hit Select button:

    Publish Power BI report to workspace
  3. Finally, if everything went right, you will see a window indicating success:

    Successful Power BI report publishing

    If you need to periodically refresh Power BI semantic model (dataset) to ensure data accuracy and up-to-dateness, you can accomplish that by using Microsoft On-premises data gateway. Proceed to the next section - Refreshing Power BI semantic model (dataset) using On-premises data gateway - and learn how to do that.

Refreshing Power BI semantic model (dataset) using On-premises data gateway

Power BI allows to refresh semantic models which are based on data sources that reside on-premises. This can be achieved using Microsoft On-premises data gateway. There are two types of On-premises gateways:

  • Standard Mode
  • Personal Mode

Standard Mode supports Power BI and other Microsoft Data Fabric services. It fits perfectly for Enterprise solutions as it installs as a Windows Service and also supports Direct Query feature.

Personal Mode, on the other hand, can be configured faster, but is designed more for home users (you cannot install it as a Windows Service and it does not support DirectQuery). You will find a detailed comparison in the link above.

We recommend to go with Personal Mode for a quick POC solution, but use Standard Mode in production environment.

Below you will find instructions on how to refresh semantic model using both types of gateways.

Refresh using On-premises data gateway (standard mode)

Here are the instructions on how to refresh a Power BI semantic model using On-premises data gateway (standard mode):

  1. Go to Power BI My workspace, hover your mouse cursor on your semantic model and click Settings:

    Configure Power BI semantic model settings
  2. If you see this view, it means you have to install On-premises data gateway (standard mode):

    On-premises data gateway is not installed
  3. Install On-premises data gateway (standard mode) and sign-in:

    signing in into on-premises data gateway standard
    Use the same email address you use when logging in into Power BI account.
  4. Register a new gateway (or migrate an existing one):

    registering or migrating on-premises data gateway standard
  5. If you are creating a new gateway, name your gateway, enter a Recovery key, and click Configure button:

    naming on-premises data gateway standard
  6. Now, let's get back to your semantic model settings in Power BI portal. Refresh the page and you should see your newly created gateway. Click arrow icon and then click on Add to gateway link:

    ODBC{"connectionstring":"dsn=AmazonSellingPartnerSpApiDSN"}
    Using On-premises Data Gateway Standard for Power BI Semantic Model
  7. Once you do that, you will create a new gateway connection. Give it a name, set Authentication method, Privacy level, and click Create button:

    dsn=AmazonSellingPartnerSpApiDSN
    Create new connection in Power BI On-premises data gateway
    In this example, we used the least restrictive Privacy level.

    If your connection uses a full connection string you may hit a length limitation when entering it into the field. To create the connection, you will need to shorten it manually. Check the section about the limitation of a full connection string on how to accomplish it.

    On-premises data gateway (personal mode) does not have this limitation.

  8. Proceed by choosing the newly created connection:

    ODBC{"connectionstring":"dsn=AmazonSellingPartnerSpApiDSN"}
    Selecting gateway connection in Power BI semantic model
  9. Finally, you are at the final step where you can refresh the semantic model:

    Refreshing Power BI semantic model using On-premises Data Gateway

Refresh using On-premises data gateway (personal mode)

Here are the instructions on how to refresh a Power BI semantic model using On-premises data gateway (personal mode):

  1. Go to Power BI My workspace, hover your mouse cursor on your semantic model and click Settings:

    Configure Power BI semantic model settings
  2. If you see this view, it means you have to install On-premises data gateway (personal mode):

    On-premises data gateway is not installed
  3. Install On-premises data gateway (personal mode) and sign-in:

    Sign-in to On-premises data gateway personal
    Use the same email address you use when logging in into Power BI account.
  4. Again, go to your semantic model Settings, expand Data source credentials, click Edit credentials, select Authentication method together with Privacy level, and then click Sign in button:

    dsn=AmazonSellingPartnerSpApiDSN
    Use On-premises data gateway personal for Power BI semantic model
  5. Finally, you are ready to refresh your semantic model:

    Refreshing Power BI semantic model using On-premises Data Gateway

Advanced topics

Create Custom Stored Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Stored Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Stored Procedure Name

  3. Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
    Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

    CREATE PROCEDURE [usp_get_orders]
        @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
     AS
        SELECT * FROM Orders where OrderDate >= '<@fromdate>';
    

    ZappySys Driver - Create Custom Stored Procedure

  4. That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

    Exec usp_get_orders '1996-01-01';

    ZappySys Driver - Execute Custom Stored Procedure

  5. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')

    ZappySys Driver - Generate SQL Server Query

  6. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here

    SELECT
      "ShipCountry",
      "OrderID",
      "CustomerID",
      "EmployeeID",
      "OrderDate",
      "RequiredDate",
      "ShippedDate",
      "ShipVia",
      "Freight",
      "ShipName",
      "ShipAddress",
      "ShipCity",
      "ShipRegion",
      "ShipPostalCode"
    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table

  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

    SELECT * FROM "vt__usa_orders_only"

    ZappySys Driver - Execute Custom Virtual Table Query

  6. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

    ZappySys Driver - Generate SQL Server Query

  7. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

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

Amazon Selling Partner (SP-API) Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 Download Report File to Local Disk
   [Read more...]
Parameter Description
ReportType
 Get Report Data - Tab Separated File (TSV)
   [Read more...]
Parameter Description
ReportType
 Get Report Data - Comma Separated File (CSV)
   [Read more...]
Parameter Description
ReportType
 Get Report Data - XML File
   [Read more...]
Parameter Description
ReportType
Filter for XML File
Option Value
Example1 $.Result.Node[*]
Example2 $.SomeNode.SomeArray[?(@SomeProperty='ABCD')]
 Get Report Data - JSON File
   [Read more...]
Parameter Description
ReportType
Filter for JSON File
 Get Report Options
   [Read more...]
 Get Report Filters
   [Read more...]
 Get FBA Inventory Summaries (Fulfilled By Amazon)
Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters.    [Read more...]
Parameter Description
MarketplaceIds
Option Value
United States of America ATVPDKIKX0DER
Brazil A2Q3Y263D00KWC
Canada A2EUQ1WTGCTBG2
Mexico A1AM78C64UM0Y8
Spain A1RKKUPIHCS9HS
United Kingdom A1F83G8C2ARO7P
France A13V1IB3VIYZZH
Belgium AMEN7PMS3EDWL
Netherlands A1805IZSGTT6HS
Germany A1PA6795UKMFR9
Italy APJ6JRA9NG5V4
Sweden A2NODRKZP88ZB9
South Africa AE08WJ6YKNBMC
Poland A1C3SOZRARQ6R3
Egypt ARBP9OOSHTCHU
Turkey A33AVAJ2PDY3EV
Saudi Arabia A17E79C6D8DWNP
United Arab Emirates (U.A.E.) A2VIGQ35RCS4UG
India A21TJRUUN4KGV
Singapore A19VAU5U5O7RUS
Australia A39IBJ37TRP1C6
Japan A1VC38T7YXB528
Include details true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value false).
Option Value
true true
false false
Granularity Type The granularity type for the inventory aggregation level.
Option Value
Marketplace Marketplace
Granularity Id The granularity ID for the inventory aggregation level (e.g. MarketPlaceId if granularityType is MarketPlace ID).
Option Value
United States of America ATVPDKIKX0DER
Brazil A2Q3Y263D00KWC
Canada A2EUQ1WTGCTBG2
Mexico A1AM78C64UM0Y8
Spain A1RKKUPIHCS9HS
United Kingdom A1F83G8C2ARO7P
France A13V1IB3VIYZZH
Belgium AMEN7PMS3EDWL
Netherlands A1805IZSGTT6HS
Germany A1PA6795UKMFR9
Italy APJ6JRA9NG5V4
Sweden A2NODRKZP88ZB9
South Africa AE08WJ6YKNBMC
Poland A1C3SOZRARQ6R3
Egypt ARBP9OOSHTCHU
Turkey A33AVAJ2PDY3EV
Saudi Arabia A17E79C6D8DWNP
United Arab Emirates (U.A.E.) A2VIGQ35RCS4UG
India A21TJRUUN4KGV
Singapore A19VAU5U5O7RUS
Australia A39IBJ37TRP1C6
Japan A1VC38T7YXB528
Start Date A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected. You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
SellerSku (Single) A single seller SKU used for querying the specified seller SKU inventory summaries.
SellerSkus (Multiple) A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
 Search Catalog Items
Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.    [Read more...]
Parameter Description
MarketplaceIds
Option Value
United States of America ATVPDKIKX0DER
Brazil A2Q3Y263D00KWC
Canada A2EUQ1WTGCTBG2
Mexico A1AM78C64UM0Y8
Spain A1RKKUPIHCS9HS
United Kingdom A1F83G8C2ARO7P
France A13V1IB3VIYZZH
Belgium AMEN7PMS3EDWL
Netherlands A1805IZSGTT6HS
Germany A1PA6795UKMFR9
Italy APJ6JRA9NG5V4
Sweden A2NODRKZP88ZB9
South Africa AE08WJ6YKNBMC
Poland A1C3SOZRARQ6R3
Egypt ARBP9OOSHTCHU
Turkey A33AVAJ2PDY3EV
Saudi Arabia A17E79C6D8DWNP
United Arab Emirates (U.A.E.) A2VIGQ35RCS4UG
India A21TJRUUN4KGV
Singapore A19VAU5U5O7RUS
Australia A39IBJ37TRP1C6
Japan A1VC38T7YXB528
Identifiers (comma-delimited list) A comma-delimited list of product identifiers to search the Amazon catalog for. Note: Cannot be used with keywords.
IdentifiersType Type of product identifiers to search the Amazon catalog for. Note: Required when identifiers are provided.
Option Value
ASIN (Amazon Standard Identification Number) ASIN
EAN (European Article Number) EAN
GTIN (Global Trade Item Number) GTIN
ISBN (International Standard Book Number) ISBN
JAN (Japanese Article Number) JAN
MINSAN (Minsan Code) MINSAN
SKU (Stock Keeping Unit - must be used with sellerId) SKU
UPC (Universal Product Code) UPC
IncludedData A comma-delimited list of data sets to include in the response. Default: summaries.
Option Value
attributes attributes
classifications classifications
dimensions dimensions
identifiers identifiers
images images
productTypes productTypes
relationships relationships
salesRanks salesRanks
summaries summaries
Filter
Option Value
$.items[*] $.items[*]
$.items[*].summaries[*] $.items[*].summaries[*]
$.items[*].images[*].images[*] $.items[*].images[*].images[*]
$.items[*].attributes[*] $.items[*].attributes[*]
$.items[*].classifications[*].classifications[*] $.items[*].classifications[*].classifications[*]
$.items[*].identifiers[*].identifiers[*] $.items[*].identifiers[*].identifiers[*]
$.items[*].productTypes[*] $.items[*].productTypes[*]
$.items[*].salesRanks[*] $.items[*].salesRanks[*]
$.items[*].relationships[*].relationships[*] $.items[*].relationships[*].relationships[*]
$.items[*].dimensions[*] $.items[*].dimensions[*]
$.refinements[*].brands[*] $.refinements[*].brands[*]
$.refinements[*].classifications[*] $.refinements[*].classifications[*]
Locale Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
SellerId A selling partner identifier, such as a seller account or vendor code. Note: Required when identifiersType is SKU.
Keywords (comma-delimited list) A comma-delimited list of words to search the Amazon catalog for. Note: Cannot be used with identifiers.
BrandNames (comma-delimited list) A comma-delimited list of brand names to limit the search for keywords-based queries. Note: Cannot be used with identifiers
Classification Ids (comma-delimited list) A comma-delimited list of classification identifiers to limit the search for keywords-based queries. Note: Cannot be used with identifiers.
KeywordsLocale The language of the keywords provided for keywords-based queries. Defaults to the primary locale of the marketplace. Note: Cannot be used with identifiers.
 Get Report Types
   [Read more...]
Parameter Description
Filter
Option Value
All Reports $.data[*]
Tab-delimited / Flat File Reports $.data[?(@format=='TSV')]
Comma-delimited Reports $.data[?(@format=='CSV')]
XML Reports $.data[?(@format=='XML')]
PDF Reports $.data[?(@format=='PDF')]
Excel (XLSX) Reports $.data[?(@format=='XLSX')]
 Get Market Place Participations
   [Read more...]
 Get Vendor PurchaseOrders
Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the createdAfter, createdBefore, changedAfter and changedBefore parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting includeDetails to false. You can then use the getPurchaseOrder operation to receive details for a specific purchase order.    [Read more...]
Parameter Description
CreatedAfter Purchase orders that became available after this time will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02). If LastUpdatedAfter is not specified. Specifying both CreatedAfter and LastUpdatedAfter returns an error. You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
CreatedBefore Purchase orders that became available before this time will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02) You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
ChangedAfter Purchase orders that changed after this timestamp will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02). If CreatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.If LastUpdatedAfter is specified, then BuyerEmail and SellerOrderId cannot be specified. You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
ChangedBefore Purchase orders that changed before this timestamp will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02) You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
IncludeDetails When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.
Option Value
true true
false false
SortOrder Sort in ascending or descending order by purchase order creation date.
Option Value
ASC ASC
DESC DESC
PoItemState Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.
Option Value
ACCEPTED ACCEPTED
PARTIALLY_ACCEPTED PARTIALLY_ACCEPTED
REJECTED REJECTED
UNCONFIRMED UNCONFIRMED
IsPOChanged When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false.
Option Value
true true
false false
PurchaseOrderState Filters purchase orders based on the purchase order state.
Option Value
New New
Acknowledged Acknowledged
Closed Closed
OrderingVendorCode Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned.
 Get Vendor PurchaseOrder Items
Returns a list of purchase order items created or changed during the time frame that you specify. You define the time frame using the createdAfter, createdBefore, changedAfter and changedBefore parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting includeDetails to false. You can then use the getPurchaseOrder operation to receive details for a specific purchase order.    [Read more...]
Parameter Description
CreatedAfter Purchase orders that became available after this time will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02). If LastUpdatedAfter is not specified. Specifying both CreatedAfter and LastUpdatedAfter returns an error. You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
CreatedBefore Purchase orders that became available before this time will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02) You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
ChangedAfter Purchase orders that changed after this timestamp will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02). If CreatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.If LastUpdatedAfter is specified, then BuyerEmail and SellerOrderId cannot be specified. You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
ChangedBefore Purchase orders that changed before this timestamp will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02) You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
IncludeDetails When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.
Option Value
true true
false false
SortOrder Sort in ascending or descending order by purchase order creation date.
Option Value
ASC ASC
DESC DESC
PoItemState Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.
Option Value
ACCEPTED ACCEPTED
PARTIALLY_ACCEPTED PARTIALLY_ACCEPTED
REJECTED REJECTED
UNCONFIRMED UNCONFIRMED
IsPOChanged When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false.
Option Value
true true
false false
PurchaseOrderState Filters purchase orders based on the purchase order state.
Option Value
New New
Acknowledged Acknowledged
Closed Closed
OrderingVendorCode Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned.
 Get Orders
Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria.    [Read more...]
 Get Order (Single)
Returns the order information for a specified OrderId    [Read more...]
Parameter Description
AmazonOrderId Filters purchase orders based on the specified orderid.
 Get Order Items (For Single Order)
Returns the order items information for a specified OrderId    [Read more...]
Parameter Description
AmazonOrderId Filters purchase orders based on the specified orderid.
 Get Orders Items (For All Orders **Slow**)
Returns the order items information for a specified order search criterial (All orders by Create/Update date, status etc)    [Read more...]
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Option Value
No filter
Example1 $.store.books[*]
Example2 (Sections Under Books) $.store.books[*].sections[*]
Example3 (Equals) $.store.books[?(@author=='sam')]
Example4 (Equals - Any Section) $..[?(@author=='sam')]
Example5 (Not Equals - Any Section) $..[?(@author!='sam')]
Example6 (Number less than) $.store.books[?(@.price<10)] Example7 (Regular Expression - Contains Pattern)=$.store.books[?(@author=~ /sam|bob/ )]
Example8 (Regular Expression - Does Not Contain Pattern) $.store.books[?(@author=~ /^((?!sam|bob).)*$/ )]
Example9 (Regular Expression - Exact Pattern Match) $.store.books[?(@author=~ /^sam|bob$/ )]
Example10 (Regular Expression - Starts With) $.store.books[?(@author=~ /^sam/ )]
Example11 (Regular Expression - Ends With) $.store.books[?(@author=~ /sam$/ )]
Example12 (Between) $.store.employees[?( @.hiredate>'2015-01-01' && @.hiredate<'2015-01-04' )]
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair
 Generic Request (Bulk Write)
This is a generic endpoint for bulk write purpose. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
IsMultiPart Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe (||) or new line after each {header-name}:{value} pair

Amazon Selling Partner (SP-API) Connector Examples for Power BI Connection

This page offers a collection of SQL 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.

Read Orders    [Read more...]

Read orders with search criteria such as CreatedAfter, CreatedBefore, MarketPlaceIds, OrderStatuses, PaymentType and many more

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

Read Single Order    [Read more...]

Read single order by orderid

SELECT * FROM Orders 
Where AmazonOrderId='902-1845936-5435065'
--CONNECTION(
--	ServiceUrl='https://sellingpartnerapi-na.amazon.com'
--)

Read Order Items (For Single Order)    [Read more...]

Read order items for a specified orderid

SELECT * FROM get_order_items 
WITH(
	AmazonOrderId ='902-1845936-5435065'
)
--CONNECTION(
--	ServiceUrl='https://sellingpartnerapi-na.amazon.com'
--)

Read Order Items (For All Orders - Slow)    [Read more...]

Read order items with search criteria on orders such as CreatedAfter, CreatedBefore, MarketPlaceIds, OrderStatuses, PaymentType and many more. This is slow way of pulling all items for all orders without reading one by one order.

SELECT * FROM OrderItems
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'
--)

Sandbox - Read Orders (Fake data for testing)    [Read more...]

Read orders which has fake values (sandbox data)

SELECT *
FROM Orders
--DONOT try WHERE AmazonOrderId='TEST_CASE_200' (WHERE clause) for sandbox endpoint, it will return empty row. If you try in Live API then should work. 
WITH(
	  CreatedAfter='TEST_CASE_200' 
	  --CreatedAfter='TEST_CASE_200_NEXT_TOKEN'
	, MarketplaceIds='ATVPDKIKX0DER'
)
CONNECTION(
	ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)

Sandbox - Read Single Order (Fake data for testing)    [Read more...]

Read single order with orderid which has fake values (sandbox data)

SELECT *
FROM get_order
--DONOT try WHERE AmazonOrderId='TEST_CASE_200' (WHERE clause) for sandbox endpoint, it will return empty row. If you try in Live API then should work. 
WITH(
	AmazonOrderId='TEST_CASE_200'
--  AmazonOrderId='TEST_CASE_IBA_200'	
)
CONNECTION(
	ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)

Sandbox - Read Order Items (Fake data for testing)    [Read more...]

Read order items with orderid which has fake values (sandbox data)

SELECT *
FROM get_order_items
--DONOT try WHERE AmazonOrderId='TEST_CASE_200' (WHERE clause) for sandbox endpoint, it will return empty row. If you try in Live API then should work. 
WITH(
	AmazonOrderId='TEST_CASE_200'
--  AmazonOrderId='TEST_CASE_IBA_200'	
)
CONNECTION(
	ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)

Generic Request - Read Any API Endpoint    [Read more...]

Read any API endpoint using generic request endpoint

SELECT *
FROM generic_request
WITH(
	  URL='/orders/v0/orders/TEST_CASE_200/orderItems' 
	, Filter='$.payload.OrderItems[*]'
	, IncludeParentColumns=1
--	, RequestMethod='GET'
--	, Body=''
--	, IsMultiPart=0
--	, RequestContentTypeCode"='Default'
--	, ResponseFormat='Default' --Json, Csv, Xml
--	, Headers='Accept: */* || Cache-Control: no-cache'
--	, PagingMode"=''
--	, PagingByUrlAttributeName=''
--	, PagingIncrementBy='1'
--	, NextUrlAttributeOrExpr=''
--	, NextUrlWaitInMs='0'
--	, ColumnDelimiter=','
--	, HasColumnHeaderRow='True'
--	, ElementsToTreatAsArray=''	
	
)
CONNECTION(
	ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)

Get Report Types    [Read more...]

Lists report types which you can use for download_report / get_report_tsv / get_report_csv or get_report_xml endpoints

SELECT * FROM ReportTypes)

Download Report to Local Disk    [Read more...]

This example shows how to run a report and download data to local disk file. You can save any file format report by calling this endpoint.

SELECT * FROM download_report
WITH(
	  ReportType='GET_XML_BROWSE_TREE_DATA'
	, TargetFilePath='c:\temp\GET_XML_BROWSE_TREE_DATA.gz'
	, MarketplaceIds='ATVPDKIKX0DER'
  --, FileOverwriteMode='FailIfExists' (Default is 'AlwaysOverwrite')
  --, StartDate='2012-12-31'	
  --, EndDate='today-1d'  
)

Generate Report    [Read more...]

This example shows how to get data from a specified report

SELECT *
FROM get_report_tsv
WITH(
	  ReportType='GET_MERCHANT_LISTINGS_ALL_DATA'
	, MarketplaceIds='ATVPDKIKX0DER'
)

Conclusion

In this article we discussed how to connect to Amazon Selling Partner (SP-API) in Power BI and integrate data without any coding. Click here to Download Amazon Selling Partner (SP-API) Connector for Power BI and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download Amazon Selling Partner (SP-API) Connector for Power BI Documentation 

More integrations

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

Other connectors for Power BI


Download Amazon Selling Partner (SP-API) Connector for Power BI Documentation

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

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

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

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

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

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

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

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

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

  • Call Amazon Selling Partner (SP-API) API in Power BI

  • Consume Amazon Selling Partner (SP-API) API in Power BI

  • Amazon Selling Partner (SP-API) Power BI Automate

  • Amazon Selling Partner (SP-API) Power BI Integration

  • Integration Amazon Selling Partner (SP-API) in Power BI

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

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

  • 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 Power BI

  • Load Amazon Selling Partner (SP-API) in Power BI

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

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

  • Amazon Selling Partner (SP-API) API Call in Power BI