Amazon Selling Partner (SP-API) Connector Examples
The ZappySys API Driver is a user-friendly interface designed to facilitate the seamless integration of various applications with the Amazon Selling Partner (SP-API) API. With its intuitive design and robust functionality, the ZappySys API Driver simplifies the process of configuring specific API endpoints to efficiently read or write data from Amazon Selling Partner (SP-API).
On this page you will find some SQL examples which can be used for API ODBC Driver or Data Gateway API Connector.
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'
)Getting Started with Examples
ZappySys API Driver is a powerful software solution designed to facilitate the extraction and integration of data from a wide range of sources through APIs. Its intuitive design and extensive feature set make it an essential asset for any organization dealing with complex data integration tasks.
To get started with examples using ZappySys API Driver, please click on the following applications:
Key features of the ZappySys API Driver include:
The API ODBC driver facilitates the reading and writing of data from numerous popular online services (refer to the complete list here) using familiar SQL language without learning complexity of REST API calls. The driver allows querying nested structure and output as a flat table. You can also create your own ODBC / Data Gateway API connector file and use it with this driver.
Intuitive Configuration: The interface is designed to be user-friendly, enabling users to easily set up the specific API endpoints within Amazon Selling Partner (SP-API) without requiring extensive technical expertise or programming knowledge.
Customizable Endpoint Setup: Users can conveniently configure the API endpoint settings, including the HTTP request method, endpoint URL, and any necessary parameters, to precisely target the desired data within Amazon Selling Partner (SP-API).
Data Manipulation Capabilities: The ZappySys API Driver allows for seamless data retrieval and writing, enabling users to fetch data from Amazon Selling Partner (SP-API) and perform various data manipulation operations as needed, all through an intuitive and straightforward interface.
Secure Authentication Integration: The driver provides secure authentication integration, allowing users to securely connect to the Amazon Selling Partner (SP-API) API by inputting the necessary authentication credentials, such as API tokens or other authentication keys.
Error Handling Support: The interface is equipped with comprehensive error handling support, ensuring that any errors or exceptions encountered during the data retrieval or writing process are efficiently managed and appropriately communicated to users for prompt resolution.
Data Visualization and Reporting: The ZappySys API Driver facilitates the seamless processing and presentation of the retrieved data from Amazon Selling Partner (SP-API), enabling users to generate comprehensive reports and visualizations for further analysis and decision-making purposes.
Overall, the ZappySys API Driver serves as a powerful tool for streamlining the integration of applications with Amazon Selling Partner (SP-API), providing users with a convenient and efficient way to access and manage data, all through a user-friendly and intuitive interface.