Amazon Selling Partner (SP-API) Connector for Alteryx : Get report data - XML file via SQL

Integrate Alteryx and Amazon Selling Partner (SP-API)

Learn how to get report data - XML file using the Amazon Selling Partner (SP-API) Connector for Alteryx. This connector enables you to read and write Amazon Selling Partner (SP-API) data effortlessly. Integrate, manage, and automate listings, orders, payments, and reports — almost no coding required. We'll walk you through the exact setup.

Let's dive in!

Amazon Selling Partner (SP-API) ODBC Driver Powering this integration

High performance
Bidirectional
Low-code / No-code
Easy to use

Built on the ZappySys API Driver, the Amazon Selling Partner (SP-API) ODBC Driver is a high-performance, low-code / no-code solution. It enables you to connect to Amazon Selling Partner (SP-API) data without any coding right in your SQL Server, or any ODBC/JDBC application. Part of the ODBC PowerPack.

Documentation

Create data source using Amazon Selling Partner (SP-API) ODBC Driver

Download and install ODBC PowerPack (if you haven't already).
Search for odbc and open the ODBC Data Sources (64-bit):
Create a User data source (User DSN) based on the ZappySys API Driver driver:

ZappySys API Driver
- Create and use a User DSN if the client application runs under a User Account. This is the ideal option at design time (e.g., when developing in Visual Studio). Use it for both types of applications (64-bit and 32-bit).
- Create and use a System DSN if the client application runs under a System Account (e.g., as a Windows Service). This is usually the required option in a production environment. If your Windows Service is a 32-bit application, you must use the 32-bit ODBC Data Source Administrator to configure this
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)

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.

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:

Register as an Amazon Private SP-API Developer. You may need to wait for a day or two to get approved (check approval status).
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:
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):
Once you do that, click View link in LWA credentials column to copy Client identifier and Client secret (we will use them later):
Now it's time to Authorize your app:
Finish authorizing it by presing Authorize app button:
Finally, copy the Refresh Token (we will use it in the next step):
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.
Click Test Connection to confirm the connection is working.
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:

Set Authentication Type to Private app [OAuth]
Optional step. Modify API Base URL if needed (in most cases default will work).
Fill in all the required parameters and set optional parameters if needed.
Press Generate Token button to generate the tokens.
Finally, hit OK button:

AmazonSellingPartnerSpApiDSN

Amazon Selling Partner (SP-API)

Private app [OAuth]

https://sellingpartnerapi-na.amazon.com

Required Parameters
ClientId	Fill-in the parameter...
ClientSecret	Fill-in the parameter...
TokenUrl	Fill-in the parameter...
Optional Parameters
TokenUIMode	OnlyRefreshToken
AuthUrl (Do not Use for Private app - Self Authorization)	https://sellercentral.amazon.com/apps/authorize/consent?application_id=[YOUR-APPLICATION-ID]&version=beta
OrdersApiVersion	v0
SellerApiVersion	v1
ShippingApiVersion	v1
ServicesApiVersion	v1
FbaApiVersion	v1
SalesApiVersion	v1
ReportsApiVersion	2021-06-30
ProductsFeesApiVersion	v0
ProductPricingApiVersion	v0
CatalogItemsApiVersion	2022-04-01
VendorOrdersApiVersion	v1
RetryMode	RetryWhenStatusCodeMatch
RetryStatusCodeList	429
RetryCountMax	5
RetryMultiplyWaitTime	True

Then go to Preview tab to start building a SQL query.
Once you do that, proceed by opening Query Builder:

ZappySys API Driver - Amazon Selling Partner (SP-API)

Read and write Amazon Selling Partner (SP-API) data effortlessly. Integrate, manage, and automate listings, orders, payments, and reports — almost no coding required.

AmazonSellingPartnerSpApiDSN
Then simply select the Get Report Data - XML File endpoint (action).
Continue by configuring the Required parameters. You can also set optional parameters too.
Move on by hitting Preview Data button to preview the results.

If you see the results you need, simply copy the generated query:

Get Report Data - XML File

Required Parameters
ReportType	Select the value from the dropdown
MarketplaceIds	Select the value from the dropdown
Optional Parameters
Filter for XML File	$.Result.Node[*]
StartDate
EndDate
ReportOptions
Advanced Properties
DateParseHandling	DateTime
FileCompressionType

SELECT * FROM get_report_xml
WITH
(
    "ReportType" = 'abcd-1234-reporttype',
    "Filter" = '$.Result.Node[*]'
)

Click OK to use built SQL query and close the Query Builder.
Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in Alteryx:
ZappySys API Driver - Amazon Selling Partner (SP-API)

Read and write Amazon Selling Partner (SP-API) data effortlessly. Integrate, manage, and automate listings, orders, payments, and reports — almost no coding required.

AmazonSellingPartnerSpApiDSN
```
SELECT * FROM get_report_xml
WITH
(
    "ReportType" = 'abcd-1234-reporttype',
    "Filter" = '$.Result.Node[*]'
)
```
You can also access data quickly from the tables dropdown by selecting <Select table>.

A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Amazon Selling Partner (SP-API) API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Amazon Selling Partner (SP-API) servers).

Let's not stop here and explore SQL query examples, including how to use them in Stored Procedures and Views (virtual tables) in the next steps.

Amazon Selling Partner (SP-API) SQL query examples

Use these SQL queries in your Alteryx data source:

Get report data - xml file

SELECT * FROM get_report_xml
WITH
(
    "ReportType" = 'abcd-1234-reporttype',
    "Filter" = '$.Result.Node[*]'
)

Create SQL view in ODBC data source

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.

Go to Custom Objects Tab and Click on Add button and Select Add Table:
Enter the desired Table name and click on OK:
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
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'
```
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"
```

Get report data - XML file in Alteryx via SQL view

Open Alteryx Designer.
First, verify your DCM Settings to ensure you can access ODBC drivers. Go to Options > User Settings > Edit User Settings.

If DCM Mode is set to DCM Only, change it to DCM Optional if you would like to access the legacy Generic ODBC Connection.

After changing this setting, you may need to click Save and restart the connection window for the "Generic ODBC" icon to appear.
Drag an Input Data tool onto your Alteryx canvas.
In the Configuration pane, click Set Up a Connection.
Note for DCM Users: If your environment has DCM (Data Connection Manager) enabled, the classic "Generic ODBC" icon may be hidden. To find it, select Data sources on the left and type "ODBC" in the search bar.
Once the ODBC window opens, click Connect Asset and select your AmazonSellingPartnerSpApiDSN DSN from the list.

Ensure you have configured a 64-bit System DSN in the Windows ODBC Data Source Administrator before this step.
After selecting your DSN, configure your SQL Query in the Input Data tool configuration:
To save your data, drag an Output Data tool and connect it to the Input Data tool.
Configure the Output Data tool to write to a CSV file:
Press Run (Ctrl+R) to execute the workflow. Verify the results in the Results Window at the bottom.

Advanced topics

Creating SQL stored procedures

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

Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
Enter the desired Procedure name and click on OK:
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>';
```
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';
```

Conclusion

And there you have it — a complete guide on how to get report data - XML file in Alteryx without writing complex code. All of this was powered by Amazon Selling Partner (SP-API) ODBC Driver, which handled the REST API pagination and authentication for us automatically.

Download the trial now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):

Download Chat

More actions supported by Amazon Selling Partner (SP-API) Connector

Got another use case in mind? We've documented the exact setups for a variety of essential Amazon Selling Partner (SP-API) operations directly in Alteryx, so you can skip the trial and error. Find your next step-by-step guide below: