Amazon Selling Partner (SP-API) Connector for SSISIn this article you will learn how to quickly and efficiently integrate Amazon Selling Partner (SP-API) data in SSIS 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 SSIS. 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. Let's follow the steps below to see how we can accomplish that! Amazon Selling Partner (SP-API) Connector for SSIS is based on ZappySys API Connector Framework which is a part of SSIS PowerPack. It is a collection of high-performance SSIS connectors that enable you to integrate data with virtually any data provider supported by SSIS, including SQL Server. SSIS PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few (if you are new to SSIS and SSIS PowerPack, find out more on how to use them). |
Connect to Amazon Selling Partner (SP-API) in other apps
|
Video Tutorial - Integrate Amazon Selling Partner (SP-API) data in SSIS
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 SSIS - How to configure connection for
Amazon Selling Partner (SP-API) - Features about
API Source (Authentication / Query Language / Examples / Driver UI) - Using
Amazon Selling Partner (SP-API) Connection in SSIS
Prerequisites
Before we begin, make sure the following prerequisites are met:
- SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
- Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
- SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).
Read data from Amazon Selling Partner (SP-API) in SSIS (Export data)
In this section we will learn how to configure and use Amazon Selling Partner (SP-API) Connector in API Source to extract data from Amazon Selling Partner (SP-API).
-
Begin with opening Visual Studio and Create a New Project.
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.
-
In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link. -
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
-
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
-
Select New Connection to create a new connection:
-
Use a preinstalled Amazon Selling Partner (SP-API) Connector from Popular Connector List or press Search Online radio button to download Amazon Selling Partner (SP-API) Connector. Once downloaded simply use it in the configuration:
Amazon Selling Partner (SP-API) -
Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.
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!
Configuring authentication parameters
Amazon 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 -
Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.
API Source - Amazon Selling Partner (SP-API)Amazon Selling Partner Connector (SP-API) can be used to integrated SP-API that helps Amazon sellers to programmatically exchange data on listings, orders, payments, reports, and more. -
That's it! We are done! Just in a few clicks we configured the call to Amazon Selling Partner (SP-API) using Amazon Selling Partner (SP-API) Connector.
You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)
Write data to Amazon Selling Partner (SP-API) using SSIS (Import data)
In this section we will learn how to configure and use Amazon Selling Partner (SP-API) Connector in the API Destination to write data to Amazon Selling Partner (SP-API).
Video tutorial
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download SSIS PowerPack for
Amazon Selling Partner (SP-API) integration in SSIS - How to configure connection for
Amazon Selling Partner (SP-API) - How to write or lookup data to
Amazon Selling Partner (SP-API) - Features about SSIS API Destination
- Using
Amazon Selling Partner (SP-API) Connector in SSIS
Step-by-step instructions
In upper section we learned how to read data, now in this section we will learn how to configure Amazon Selling Partner (SP-API) in the API Source to POST data to the Amazon Selling Partner (SP-API).
-
Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.
-
From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
-
Select New Connection to create a new connection:
API Destination - 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. -
Use a preinstalled Amazon Selling Partner (SP-API) Connector from Popular Connector List or press Search Online radio button to download Amazon Selling Partner (SP-API) Connector. Once downloaded simply use it in the configuration:
Amazon Selling Partner (SP-API) -
Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.
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!
Configuring authentication parameters
Amazon 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 -
Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.
API Destination - 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. -
Finally, map the desired columns:
API Destination - 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. -
That's it; we successfully configured the POST API Call. In a few clicks we configured the Amazon Selling Partner (SP-API) API call using ZappySys Amazon Selling Partner (SP-API) Connector
Load Amazon Selling Partner (SP-API) data into SQL Server using Upsert Destination (Insert or Update)
Once you configured the data source, you can load Amazon Selling Partner (SP-API) data into SQL Server using Upsert Destination.
Upsert Destination can merge or synchronize source data with the target table.
It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets.
Upsert Destination also supports very fast bulk upsert
operation along with bulk delete
.
Upsert operation
- a database operation which performs INSERT
or UPDATE
SQL commands
based on record's existence condition in the target table.
It
Upsert Destination supports INSERT
, UPDATE
, and DELETE
operations,
so it is similar to SQL Server's MERGE
command, except it can be used directly in SSIS package.
-
From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.
-
Connect your SSIS source component to Upsert Destination.
-
Double-click on Upsert Destination component to open configuration window.
-
Start by selecting the Action from the list.
-
Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.
-
Then select a table from the Target Table list or click New button to create a new table based on the source columns.
-
Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).
-
Finally, click Map All button to map all columns and then select the Key columns to match the columns on:
-
Click OK to save the configuration.
-
Run the package and Amazon Selling Partner (SP-API) data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:
-
Done!
Deploy and schedule SSIS package
After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in this article:
Running SSIS package in Azure Data Factory (ADF)
To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:
Advanced topics
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.Parameter | Description |
---|---|
ReportType |
|
Parameter | Description |
---|---|
ReportType |
|
Parameter | Description |
---|---|
ReportType |
|
Parameter | Description | ||||||
---|---|---|---|---|---|---|---|
ReportType |
|
||||||
Filter for XML File |
|
Parameter | Description |
---|---|
ReportType |
|
Filter for JSON File |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
MarketplaceIds |
|
||||||||||||||||||||||||||||||||||||||||||||||
Include details |
|
||||||||||||||||||||||||||||||||||||||||||||||
Granularity Type |
|
||||||||||||||||||||||||||||||||||||||||||||||
Granularity Id |
|
||||||||||||||||||||||||||||||||||||||||||||||
Start Date |
|
||||||||||||||||||||||||||||||||||||||||||||||
SellerSku (Single) |
|
||||||||||||||||||||||||||||||||||||||||||||||
SellerSkus (Multiple) |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
MarketplaceIds |
|
||||||||||||||||||||||||||||||||||||||||||||||
Identifiers (comma-delimited list) |
|
||||||||||||||||||||||||||||||||||||||||||||||
IdentifiersType |
|
||||||||||||||||||||||||||||||||||||||||||||||
IncludedData |
|
||||||||||||||||||||||||||||||||||||||||||||||
Filter |
|
||||||||||||||||||||||||||||||||||||||||||||||
Locale |
|
||||||||||||||||||||||||||||||||||||||||||||||
SellerId |
|
||||||||||||||||||||||||||||||||||||||||||||||
Keywords (comma-delimited list) |
|
||||||||||||||||||||||||||||||||||||||||||||||
BrandNames (comma-delimited list) |
|
||||||||||||||||||||||||||||||||||||||||||||||
Classification Ids (comma-delimited list) |
|
||||||||||||||||||||||||||||||||||||||||||||||
KeywordsLocale |
|
Parameter | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filter |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CreatedAfter |
|
||||||||||||||||||||||||||||||||||||||
CreatedBefore |
|
||||||||||||||||||||||||||||||||||||||
ChangedAfter |
|
||||||||||||||||||||||||||||||||||||||
ChangedBefore |
|
||||||||||||||||||||||||||||||||||||||
IncludeDetails |
|
||||||||||||||||||||||||||||||||||||||
SortOrder |
|
||||||||||||||||||||||||||||||||||||||
PoItemState |
|
||||||||||||||||||||||||||||||||||||||
IsPOChanged |
|
||||||||||||||||||||||||||||||||||||||
PurchaseOrderState |
|
||||||||||||||||||||||||||||||||||||||
OrderingVendorCode |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CreatedAfter |
|
||||||||||||||||||||||||||||||||||||||
CreatedBefore |
|
||||||||||||||||||||||||||||||||||||||
ChangedAfter |
|
||||||||||||||||||||||||||||||||||||||
ChangedBefore |
|
||||||||||||||||||||||||||||||||||||||
IncludeDetails |
|
||||||||||||||||||||||||||||||||||||||
SortOrder |
|
||||||||||||||||||||||||||||||||||||||
PoItemState |
|
||||||||||||||||||||||||||||||||||||||
IsPOChanged |
|
||||||||||||||||||||||||||||||||||||||
PurchaseOrderState |
|
||||||||||||||||||||||||||||||||||||||
OrderingVendorCode |
|
Parameter | Description |
---|---|
AmazonOrderId |
|
Parameter | Description |
---|---|
AmazonOrderId |
|
Parameter | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Url |
|
||||||||||||||||||||||||||
Body |
|
||||||||||||||||||||||||||
IsMultiPart |
|
||||||||||||||||||||||||||
Filter |
|
||||||||||||||||||||||||||
Headers |
|
Parameter | Description |
---|---|
Url |
|
IsMultiPart |
|
Filter |
|
Headers |
|
Conclusion
In this article we showed you how to connect to Amazon Selling Partner (SP-API) in SSIS and integrate data without any coding, saving you time and effort. We encourage you to download Amazon Selling Partner (SP-API) Connector for SSIS 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 SSIS Documentation
More integrations
Other connectors for SSIS
Other application integration scenarios for Amazon Selling Partner (SP-API)
How to connect Amazon Selling Partner (SP-API) in SSIS?
How to get Amazon Selling Partner (SP-API) data in SSIS?
How to read Amazon Selling Partner (SP-API) data in SSIS?
How to load Amazon Selling Partner (SP-API) data in SSIS?
How to import Amazon Selling Partner (SP-API) data in SSIS?
How to pull Amazon Selling Partner (SP-API) data in SSIS?
How to push data to Amazon Selling Partner (SP-API) in SSIS?
How to write data to Amazon Selling Partner (SP-API) in SSIS?
How to POST data to Amazon Selling Partner (SP-API) in SSIS?
Call Amazon Selling Partner (SP-API) API in SSIS
Consume Amazon Selling Partner (SP-API) API in SSIS
Amazon Selling Partner (SP-API) SSIS Automate
Amazon Selling Partner (SP-API) SSIS Integration
Integration Amazon Selling Partner (SP-API) in SSIS
Consume real-time Amazon Selling Partner (SP-API) data in SSIS
Consume real-time Amazon Selling Partner (SP-API) API data in SSIS
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 SSIS
Load Amazon Selling Partner (SP-API) in SSIS
Load Amazon Selling Partner (SP-API) data in SSIS
Read Amazon Selling Partner (SP-API) data in SSIS
Amazon Selling Partner (SP-API) API Call in SSIS