Amazon Selling Partner (SP-API) Connector for Azure Data Factory (Pipeline)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 Azure Data Factory (Pipeline) 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 Azure Data Factory (Pipeline). Let's follow the steps below to see how we can accomplish that! Amazon Selling Partner (SP-API) Connector for Azure Data Factory (Pipeline) is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few. |
Connect to Amazon Selling Partner (SP-API) in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from Amazon Selling Partner (SP-API) using Azure Data Factory (Pipeline) 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 Azure Data Factory (Pipeline). Perform these steps:
-
Download and install ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User data source (User DSN) based on ZappySys API Driver
ZappySys API Driver-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
in design-time , when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit. -
Create and use System DSN
if the client application is launched under a System Account, e.g. as a Windows Service.
Usually, this is an ideal option to use
in a production environment . Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
Azure Data Factory (Pipeline) uses a Service Account, when a solution is deployed to production environment, therefore for production environment you have to create and use a System DSN. -
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
-
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:
AmazonSellingPartnerSpApiDSNAmazon 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.
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]
Steps how to get and use Amazon Selling Partner (SP-API) credentials : Private app [OAuth]
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!
Fill in all required parameters and set optional parameters if needed:
AmazonSellingPartnerSpApiDSNAmazon Selling Partner (SP-API)Private app [OAuth]https://sellingpartnerapi-na.amazon.comRequired 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 -
Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:
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 -
Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in Azure Data Factory (Pipeline) to retrieve data from Amazon Selling Partner (SP-API). Hit OK button to use this query in the next step.
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' --)
Some parameters configured in this window will be passed to the Amazon Selling Partner (SP-API) API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful datamuch faster . -
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 Azure Data Factory (Pipeline):
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.AmazonSellingPartnerSpApiDSNSELECT * 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' --)
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHERE
clause,LIMIT
keyword will be performed on the client side, meaning that thewhole 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). -
Click OK to finish creating the data source.
Video Tutorial
Read data in Azure Data Factory (ADF) from ODBC datasource (Amazon Selling Partner (SP-API))
-
To start press New button:
-
Select "Azure, Self-Hosted" option:
-
Select "Self-Hosted" option:
-
Set a name, we will use "OnPremisesRuntime":
-
Download and install Microsoft Integration Runtime.
-
Launch Integration Runtime and copy/paste Authentication Key from Integration Runtime configuration in Azure Portal:
-
After finishing registering the Integration Runtime node, you should see a similar view:
-
Go back to Azure Portal and finish adding new Integration Runtime. You should see it was successfully added:
-
Go to Linked services section and create a new Linked service based on ODBC:
-
Select "ODBC" service:
-
Configure new ODBC service. Use the same DSN name we used in the previous step and copy it to Connection string box:
AmazonSellingPartnerSpApiDSNDSN=AmazonSellingPartnerSpApiDSN -
For created ODBC service create ODBC-based dataset:
-
Go to your pipeline and add Copy data connector into the flow. In Source section use OdbcDataset we created as a source dataset:
-
Then go to Sink section and select a destination/sink dataset. In this example we use precreated AzureBlobStorageDataset which saves data into an Azure Blob:
-
Finally, run the pipeline and see data being transferred from OdbcDataset to your destination dataset:
Actions supported by Amazon Selling Partner (SP-API) Connector
Learn how to perform common Amazon Selling Partner (SP-API) actions directly in Azure Data Factory (Pipeline) with these how-to guides:
- Download Report File to Local Disk
- Get FBA Inventory Summaries (Fulfilled By Amazon)
- Get Market Place Participations
- Get Order (Single)
- Get Order Items (For Single Order)
- Get Orders
- Get Orders Items (For All Orders **Slow**)
- Get Report Data - Comma Separated File (CSV)
- Get Report Data - JSON File
- Get Report Data - Tab Separated File (TSV)
- Get Report Data - XML File
- Get Report Filters
- Get Report Options
- Get Report Types
- Get Vendor PurchaseOrder Items
- Get Vendor PurchaseOrders
- Search Catalog Items
- Generic Request
- Generic Request (Bulk Write)
Conclusion
In this article we showed you how to connect to Amazon Selling Partner (SP-API) in Azure Data Factory (Pipeline) and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Amazon Selling Partner (SP-API), but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).
We encourage you to download Amazon Selling Partner (SP-API) Connector for Azure Data Factory (Pipeline) 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 Azure Data Factory (Pipeline) Documentation
More integrations
Other connectors for Azure Data Factory (Pipeline)
Other application integration scenarios for Amazon Selling Partner (SP-API)
How to connect Amazon Selling Partner (SP-API) in Azure Data Factory (Pipeline)?
How to get Amazon Selling Partner (SP-API) data in Azure Data Factory (Pipeline)?
How to read Amazon Selling Partner (SP-API) data in Azure Data Factory (Pipeline)?
How to load Amazon Selling Partner (SP-API) data in Azure Data Factory (Pipeline)?
How to import Amazon Selling Partner (SP-API) data in Azure Data Factory (Pipeline)?
How to pull Amazon Selling Partner (SP-API) data in Azure Data Factory (Pipeline)?
How to push data to Amazon Selling Partner (SP-API) in Azure Data Factory (Pipeline)?
How to write data to Amazon Selling Partner (SP-API) in Azure Data Factory (Pipeline)?
How to POST data to Amazon Selling Partner (SP-API) in Azure Data Factory (Pipeline)?
Call Amazon Selling Partner (SP-API) API in Azure Data Factory (Pipeline)
Consume Amazon Selling Partner (SP-API) API in Azure Data Factory (Pipeline)
Amazon Selling Partner (SP-API) Azure Data Factory (Pipeline) Automate
Amazon Selling Partner (SP-API) Azure Data Factory (Pipeline) Integration
Integration Amazon Selling Partner (SP-API) in Azure Data Factory (Pipeline)
Consume real-time Amazon Selling Partner (SP-API) data in Azure Data Factory (Pipeline)
Consume real-time Amazon Selling Partner (SP-API) API data in Azure Data Factory (Pipeline)
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 Azure Data Factory (Pipeline)
Load Amazon Selling Partner (SP-API) in Azure Data Factory (Pipeline)
Load Amazon Selling Partner (SP-API) data in Azure Data Factory (Pipeline)
Read Amazon Selling Partner (SP-API) data in Azure Data Factory (Pipeline)
Amazon Selling Partner (SP-API) API Call in Azure Data Factory (Pipeline)