Amazon Selling Partner (SP-API) Connector for Azure Data Factory (SSIS) How to Make Generic API Request

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.
ODBC PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

Make Generic API Request in SSIS

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)

Now it's time to configure authentication. Firstly, configure authentication settings in Amazon Selling Partner (SP-API) service and then proceed by configuring API Connection Manager. Start by expanding an authentication type:

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:

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

Select Generic Table (Bulk Read / Write) table from the dropdown and hit Preview Data:

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.

Amazon Selling Partner (SP-API)

Generic Table (Bulk Read / Write)

Required Parameters
HTTP - Url or File Path	Fill-in the parameter...
HTTP - Request Method	Fill-in the parameter...
Optional Parameters
HTTP - Request Body
HTTP - Is MultiPart Body (Pass File data/Mixed Key/value)
HTTP - Request Format (Content-Type)	ApplicationJson
HTTP - Headers (e.g. hdr1:aaa \|\| hdr2:bbb)	Accept: / \|\| Cache-Control: no-cache
Parser - Response Format (Default=Json)	Default
Parser - Filter (e.g. $.rows[*] )
Parser - Encoding
Parser - CharacterSet
Download - Enable reading binary data	False
Download - File overwrite mode	AlwaysOverwrite
Download - Save file path
Download - Enable raw output mode as single row	False
Download - Raw output data RowTemplate	{Status:'Downloaded'}
Download - Request Timeout (Milliseconds)
General - Enable Custom Search/Replace
General - SearchFor (e.g. (\d)-(\d)--regex)
General - ReplaceWith (e.g. $1-***)
General - File Compression Type
General - Date Format
General - Enable Big Number Handling	False
General - Wait time (Ms) - Helps to slow down pagination (Use for throttling)	0
JSON/XML - ExcludedProperties (e.g. meta,info)
JSON/XML - Flatten Small Array (Not preferred for more than 10 items)
JSON/XML - Max Array Items To Flatten	10
JSON/XML - Array Transform Type
JSON/XML - Array Transform Column Name Filter
JSON/XML - Array Transform Row Value Filter
JSON/XML - Array Transform Enable Custom Columns
JSON/XML - Enable Pivot Transform
JSON/XML - Array Transform Custom Columns
JSON/XML - Pivot Path Replace With
JSON/XML - Enable Pivot Path Search Replace	False
JSON/XML - Pivot Path Search For
JSON/XML - Include Pivot Path	False
JSON/XML - Throw Error When No Match for Filter	False
JSON/XML - Parent Column Prefix
JSON/XML - Include Parent When Child Null	False
Pagination - Mode
Pagination - Attribute Name (e.g. page)
Pagination - Increment By (e.g. 100)	1
Pagination - Expression for Next URL (e.g. $.nextUrl)
Pagination - Wait time after each request (milliseconds)	0
Pagination - Max Rows Expr
Pagination - Max Pages Expr
Pagination - Max Rows DataPath Expr
Pagination - Max Pages	0
Pagination - End Rules
Pagination - Next URL Suffix
Pagination - Next URL End Indicator
Pagination - Stop Indicator Expr
Pagination - Current Page
Pagination - End Strategy Type	DetectBasedOnRecordCount
Pagination - Stop based on this Response StatusCode
Pagination - When EndStrategy Condition Equals	True
Pagination - Max Response Bytes	0
Pagination - Min Response Bytes	0
Pagination - Error String Match
Pagination - Enable Page Token in Body	False
Pagination - Placeholders (e.g. {page})
Pagination - Has Different NextPage Info	False
Pagination - First Page Body Part
Pagination - Next Page Body Part
Csv - Column Delimiter	,
Csv - Has Header Row	True
Csv - Throw error when column count mismatch	False
Csv - Throw error when no record found	False
Csv - Allow comments (i.e. line starts with # treat as comment and skip line)	False
Csv - Comment Character	#
Csv - Skip rows	0
Csv - Ignore Blank Lines	True
Csv - Skip Empty Records	False
Csv - Skip Header Comment Rows	0
Csv - Trim Headers	False
Csv - Trim Fields	False
Csv - Ignore Quotes	False
Csv - Treat Any Blank Value As Null	False
Xml - ElementsToTreatAsArray

SSIS API Source - Read from table or endpoint

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)