Amazon Selling Partner (SP-API) ConnectorThe high-performance Amazon Selling Partner (SP-API) Connector provides read/write capabilities within your application, allowing you to perform numerous Amazon Selling Partner (SP-API) operations with minimal coding or even no-coding at all. Integrate Amazon Selling Partner (SP-API) data into applications such as SSIS, SQL Server, any ODBC-compatible application, or even directly within a programming language using this connector. Download for SSIS Download for SQL Server and ODBC Documentation |
Integrate Amazon Selling Partner (SP-API) with these applications
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 |
|
SQL examples for Amazon Selling Partner (SP-API) Connector
Use these example Amazon Selling Partner (SP-API) SQL queries within SQL Server or any other ODBC-compatible application:
Read Orders [ Read more... ]
Read orders with search criteria such as CreatedAfter, CreatedBefore, MarketPlaceIds, OrderStatuses, PaymentType and many more
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'
--)
Read Single Order [ Read more... ]
Read single order by orderid
SELECT * FROM Orders
Where AmazonOrderId='902-1845936-5435065'
--CONNECTION(
-- ServiceUrl='https://sellingpartnerapi-na.amazon.com'
--)
Read Order Items (For Single Order) [ Read more... ]
Read order items for a specified orderid
SELECT * FROM get_order_items
WITH(
AmazonOrderId ='902-1845936-5435065'
)
--CONNECTION(
-- ServiceUrl='https://sellingpartnerapi-na.amazon.com'
--)
Read Order Items (For All Orders - Slow) [ Read more... ]
Read order items with search criteria on orders such as CreatedAfter, CreatedBefore, MarketPlaceIds, OrderStatuses, PaymentType and many more. This is slow way of pulling all items for all orders without reading one by one order.
SELECT * FROM OrderItems
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'
--)
Sandbox - Read Orders (Fake data for testing) [ Read more... ]
Read orders which has fake values (sandbox data)
SELECT *
FROM Orders
--DONOT try WHERE AmazonOrderId='TEST_CASE_200' (WHERE clause) for sandbox endpoint, it will return empty row. If you try in Live API then should work.
WITH(
CreatedAfter='TEST_CASE_200'
--CreatedAfter='TEST_CASE_200_NEXT_TOKEN'
, MarketplaceIds='ATVPDKIKX0DER'
)
CONNECTION(
ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)
Sandbox - Read Single Order (Fake data for testing) [ Read more... ]
Read single order with orderid which has fake values (sandbox data)
SELECT *
FROM get_order
--DONOT try WHERE AmazonOrderId='TEST_CASE_200' (WHERE clause) for sandbox endpoint, it will return empty row. If you try in Live API then should work.
WITH(
AmazonOrderId='TEST_CASE_200'
-- AmazonOrderId='TEST_CASE_IBA_200'
)
CONNECTION(
ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)
Sandbox - Read Order Items (Fake data for testing) [ Read more... ]
Read order items with orderid which has fake values (sandbox data)
SELECT *
FROM get_order_items
--DONOT try WHERE AmazonOrderId='TEST_CASE_200' (WHERE clause) for sandbox endpoint, it will return empty row. If you try in Live API then should work.
WITH(
AmazonOrderId='TEST_CASE_200'
-- AmazonOrderId='TEST_CASE_IBA_200'
)
CONNECTION(
ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)
Generic Request - Read Any API Endpoint [ Read more... ]
Read any API endpoint using generic request endpoint
SELECT *
FROM generic_request
WITH(
URL='/orders/v0/orders/TEST_CASE_200/orderItems'
, Filter='$.payload.OrderItems[*]'
, IncludeParentColumns=1
-- , RequestMethod='GET'
-- , Body=''
-- , IsMultiPart=0
-- , RequestContentTypeCode"='Default'
-- , ResponseFormat='Default' --Json, Csv, Xml
-- , Headers='Accept: */* || Cache-Control: no-cache'
-- , PagingMode"=''
-- , PagingByUrlAttributeName=''
-- , PagingIncrementBy='1'
-- , NextUrlAttributeOrExpr=''
-- , NextUrlWaitInMs='0'
-- , ColumnDelimiter=','
-- , HasColumnHeaderRow='True'
-- , ElementsToTreatAsArray=''
)
CONNECTION(
ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)
Get Report Types [ Read more... ]
Lists report types which you can use for download_report / get_report_tsv / get_report_csv or get_report_xml endpoints
SELECT * FROM ReportTypes)
Download Report to Local Disk [ Read more... ]
This example shows how to run a report and download data to local disk file. You can save any file format report by calling this endpoint.
SELECT * FROM download_report
WITH(
ReportType='GET_XML_BROWSE_TREE_DATA'
, TargetFilePath='c:\temp\GET_XML_BROWSE_TREE_DATA.gz'
, MarketplaceIds='ATVPDKIKX0DER'
--, FileOverwriteMode='FailIfExists' (Default is 'AlwaysOverwrite')
--, StartDate='2012-12-31'
--, EndDate='today-1d'
)
Generate Report [ Read more... ]
This example shows how to get data from a specified report
SELECT *
FROM get_report_tsv
WITH(
ReportType='GET_MERCHANT_LISTINGS_ALL_DATA'
, MarketplaceIds='ATVPDKIKX0DER'
)