How to Make Generic API Request (Bulk Write) — Amazon Selling Partner (SP-API) Connector for 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!).

Make Generic API Request (Bulk Write) 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.
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)

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, then select Insert, Update as operation, and hit Preview Data:

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.

Amazon Selling Partner (SP-API)

Generic Table (Bulk Read / Write)

Insert, Update

Required Parameters
Url	Fill-in the parameter...
Request Method	Fill-in the parameter...
Optional Parameters
IsMultiPart
Filter
Request Format (Content-Type)	Default
Body	{$rows$}
JsonOutputFormat	Multicontent
DoNotOutputNullProperty
Batch Size (Default=1)	1
Meta Detection Order	StaticDynamicVirtual
Input Columns - For Mapping (e.g. MyCol1:string(10); MyCol2:int32 ...) - Use bool, int32, int64, datetime, decimal, double
Output Columns (e.g. MyCol1:string(10); MyCol2:int32 ...) - Use bool, int32, int64, datetime, decimal, double
Request Format
Response Format	Default
Headers	Accept: / \|\| Cache-Control: no-cache
Csv - Column Delimiter	,
Csv - Row Delimiter	{NEWLINE}
Csv - Quote Around Value	True
Csv - Always Quote regardless type
Encoding
CharacterSet
Writer DateTime Format
Csv - Has Header Row	True
Xml - ElementsToTreatAsArray
Layout Map	<?xml version="1.0" encoding="utf-8"?> <!-- Example#1: Output all columns --> <settings> <dataset id="root" main="True" readfrominput="True" /> <map src="*" /> </settings> <!-- Example#2: Records under array <?xml version="1.0" encoding="utf-8"?> <settings singledataset="True"> <dataset id="root" main="True" readfrominput="True" /> <map name="MyArray" dataset="root" maptype="DocArray"> <map src="OrderID" name="OrderID" /> <map src="OrderDate" name="OrderDate" /> </map> </settings> --> <!-- Example#3: Records under nested section <?xml version="1.0" encoding="utf-8"?> <settings> <dataset id="dsRoot" main="True" readfrominput="True" /> <map name="NestedSection"> <map src="OrderID" name="OrderID_MyLabel" /> <map src="OrderDate" name="OrderDate_MyLabel" /> </map> </settings> -->

SSIS API Destination - Access table operation

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