Amazon MWS Connector for SQL Server
In this article you will learn how to integrate Amazon MWS data in SQL Server
without coding in just a few clicks (live / bi-directional connection to Amazon MWS).
Amazon MWS (Marketplace Web Service) Connector can be used to integrated web service API that helps Amazon sellers to programmatically exchange data on listings, orders, payments, reports, and more..
Using Amazon MWS Connector you will be able to connect, read, and write data from within SQL Server. Follow the steps below to see how we would accomplish that.
Download
Documentation
Amazon's MWS (Marketplace Web Service) is being deprecated and replaced by the newer AWS Selling Partner API (SP-API). For a more robust and secure integration, we recommend using our AWS Selling Partner (SP-API) Connector. As Amazon is phasing out MWS functionality and eventually plans to fully deprecate it.
The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc.
If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started.
|
Connect to Amazon MWS in other apps
|
Video Tutorial - Integrate Amazon MWS data in SQL Server
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 MWS integration in SQL Server
- How to configure connection for Amazon MWS
- Features about API Driver (Authentication / Query Language / Examples / Driver UI)
- Using Amazon MWS Connection in SQL Server
Create Data Source in ZappySys Data Gateway based on API Driver
-
Download and install ZappySys ODBC PowerPack.
-
Search for gateway in start menu and Open ZappySys Data Gateway:
-
Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
-
Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.
AmazonmwsDSN
-
When the Configuration window appears give your data source a name if you haven't done that already,
then select "Amazon MWS" from the list of Popular Connectors. If "Amazon MWS" is not present
in the list, then click "Search Online" and download it. Then set the path to the location where you
downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
AmazonmwsDSN
Amazon MWS
-
Now it's time to configure the Connection Manager. Select Authentication Type,
e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one).
More info is available in the Authentication section.
-
Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
-
Click OK to finish creating the data source.
Read data in SQL Server from the ZappySys Data Gateway
-
To read the data in SQL Server the first thing you have to do is create a Linked Server. Go to SQL Server Management Studio and configure it in a similar way:
-
Then click on Security option and configure username we created in ZappySys Data Gateway in one of the previous steps:
-
Optional: Under the Server Options, Enable RPC and RPC Out and Disable Promotion of Distributed Transactions(MSDTC).
You need to enable RPC Out if you plan to use EXEC(...) AT [MY_LINKED_SERVER_NAME]
rather than OPENQUERY.
If don't enabled it, you will encounter the Server 'MY_LINKED_SERVER_NAME' is not configured for RPC
error.
Query Example:
EXEC('Select * from Products') AT [MY_LINKED_SERVER_NAME]
If you plan to use 'INSERT INTO...EXEC(....) AT [MY_LINKED_SERVER_NAME]'
in that case you need to Disable Promotion of Distributed Transactions(MSDTC).
If don't disabled it, you will encounter the The operation could not be performed because OLE DB provider "SQLNCLI11" for linked server "MY_LINKED_SERVER_NAME" was unable to begin a distributed transaction.
error.
Query Example:
Insert Into dbo.Products
EXEC('Select * from Products') AT [MY_LINKED_SERVER_NAME]
-
Finally, open a new query and execute a query we saved in one of the previous steps:
SELECT * FROM OPENQUERY([MY_LINKED_SERVER_NAME], 'SELECT * FROM Products');
Create Linked Server using Code
In previous section you saw how to create a Linked Server from UI. You can do similar action by code too (see below). Run below script after changing necessary parameters. Assuming your Data Source name on ZappySys Data Gateway UI is 'AmazonmwsDSN'
USE [master]
GO
--///////////////////////////////////////////////////////////////////////////////////////
--Run below code in SSMS to create Linked Server and use ZappySys Drivers in SQL Server
--///////////////////////////////////////////////////////////////////////////////////////
//Replace YOUR_GATEWAY_USER, YOUR_GATEWAY_PASSWORD
//Replace localhost with IP/Machine name if ZappySys Gateway Running on different machine other than SQL Server
//Replace Port 5000 if you configured gateway on a different port
--1. Configure your gateway service as per this article https://zappysys.com/links?id=10036
--2. Make sure you have SQL Server Installed. You can download FREE SQL Server Express Edition from here if you dont want to buy Paid version https://www.microsoft.com/en-us/sql-server/sql-server-editions-express
--Uncomment below if you like to drop linked server if it already exists
--EXEC master.dbo.sp_dropserver @server=N'LS_AmazonmwsDSN', @droplogins='droplogins'
--3. Create new linked server
EXEC master.dbo.sp_addlinkedserver
@server = N'LS_AmazonmwsDSN' --Linked server name (this will be used in OPENQUERY sql
, @srvproduct=N''
---- For MSSQL 2012,2014,2016 and 2019 use below (SQL Server Native Client 11.0)---
, @provider=N'SQLNCLI11'
---- For MSSQL 2022 or higher use below (Microsoft OLE DB Driver for SQL Server)---
--, @provider=N'MSOLEDBSQL'
, @datasrc=N'localhost,5000' --//Machine / Port where Gateway service is running
, @provstr=N'Network Library=DBMSSOCN;'
, @catalog=N'AmazonmwsDSN' --Data source name you gave on Gateway service settings
--4. Attach gateway login with linked server
EXEC master.dbo.sp_addlinkedsrvlogin
@rmtsrvname=N'LS_AmazonmwsDSN' --linked server name
, @useself=N'False'
, @locallogin=NULL
, @rmtuser=N'YOUR_GATEWAY_USER' --enter your Gateway user name
, @rmtpassword='YOUR_GATEWAY_PASSWORD' --enter your Gateway user's password
GO
--5. Enable RPC OUT (This is Optional - Only needed if you plan to use EXEC(...) AT YourLinkedServerName rather than OPENQUERY
EXEC sp_serveroption 'LS_AmazonmwsDSN', 'rpc', true;
EXEC sp_serveroption 'LS_AmazonmwsDSN', 'rpc out', true;
--Disable MSDTC - Below needed to support INSERT INTO from EXEC AT statement
EXEC sp_serveroption 'LS_AmazonmwsDSN', 'remote proc transaction promotion', false;
--Increase query timeout if query is going to take longer than 10 mins (Default timeout is 600 seconds)
--EXEC sp_serveroption 'LS_AmazonmwsDSN', 'query timeout', 1200;
GO
Firewall settings
So far we have assumed that Gateway is running on the same machine as SQL Server. However there will be a case when ZappySys ODBC PowerPack is installed on a different machine than SQL Server. In such case you may have to perform additional Firewall configurations. On most computers firewall settings wont allow outside traffic to ZappySys Data Gateway. In such case perform following steps to allow other machines to connect to Gateway.
Method-1 (Preferred)
If you are using newer version of ZappySys Data Gateway then adding firewall rule is just a single click.
- Search for gateway in start menu and open ZappySys Data Gateway.
- Go to Firewall Tab and click Add Firewall Rule button like below. This will create Firewall rule to all Inbound Traffic on Port 5000 (Unless you changed it).
Method-2
Here is another way to add / edit Inbound Traffic rule in windows firewall. Use below method if you choose to customize your rule (for advanced users).
- Search for Windows Firewall Advanced Security in start menu.
- Under Inbound Rules > Right click and click [New Rule] >> Click Next
- Select Port on Rule Type >> Click Next
- Click on TCP and enter port number under specified local port as 5000 (use different one if you changed Default port) >> Click Next
- Select Profile (i.e. Private, Public) >> Click Next
- Enter Rule name [i.e. ZappySys Data Gateway – Allow Inbound ] >> Click Next
- Click OK to save the rule
OPENQUERY vs EXEC (handling larger SQL text)
So far we have seen examples of using OPENQUERY. It allows us to send pass-through query at remote server. The biggest limitation of OPENQUERY is it doesn't allow you to use variables inside SQL so often we have to use unpleasant looking dynamic SQL (Lots of tick, tick …. and escape hell). Well there is good news. With SQL 2005 and later you can use EXEC(your_sql) AT your_linked_server
syntax .
Disadvantage of EXEC AT is you cannot do SELECT INTO like OPENQUERY. Also you cannot perform JOIN like below in EXEC AT
SELECT a.* FROM OPENQUERY([ls_AmazonmwsDSN],'select * from Customers') a
JOIN OPENQUERY([ls_AmazonmwsDSN],'select * from Orders') b ON a.CustomerId=b.CustomerId;
However you can always do
INSERT INTO SomeTable EXEC(…) AT your_linked_server
. So table must exists when you do that way.
Here is how to use it. To use
EXEC(..) AT {linked-server}
you must turn on
RPC OUT
option. Notice how we used variable in SQL to make it dynamic. This is much cleaner than previous approach we saw.
USE [master]
GO
--Replace YOUR_GATEWAY_USER, YOUR_GATEWAY_PASSWORD
--Replace localhost with IP/Machine name if ZappySys Gateway Running on different machine other than SQL Server
--Create new linked server
EXEC master.dbo.sp_addlinkedserver
@server = N'LS_AmazonmwsDSN' --Linked server name (this will be used in OPENQUERY sql)
, @srvproduct=N''
---- For MSSQL 2012,2014,2016 and 2019 use below (SQL Server Native Client 11.0)---
, @provider=N'SQLNCLI11'
---- For MSSQL 2022 or higher use below (Microsoft OLE DB Driver for SQL Server)---
--, @provider=N'MSOLEDBSQL'
, @datasrc=N'localhost,5000' --//Machine / Port where Gateway service is running
, @provstr=N'Network Library=DBMSSOCN;'
, @catalog=N'AmazonmwsDSN' --Data source name you gave on Gateway service settings
--Attach gateway login with linked server
EXEC master.dbo.sp_addlinkedsrvlogin
@rmtsrvname=N'LS_AmazonmwsDSN' --linked server name
, @useself=N'False'
, @locallogin=NULL
, @rmtuser=N'YOUR_GATEWAY_USER' --enter your Gateway user name
, @rmtpassword='YOUR_GATEWAY_PASSWORD' --enter your Gateway user's password
GO
--5. Enable RPC OUT (This is Optional - Only needed if you plan to use EXEC(...) AT YourLinkedServerName rather than OPENQUERY
EXEC sp_serveroption 'LS_AmazonmwsDSN', 'rpc', true;
EXEC sp_serveroption 'LS_AmazonmwsDSN', 'rpc out', true;
--Disable MSDTC - Below needed to support INSERT INTO from EXEC AT statement
EXEC sp_serveroption 'LS_AmazonmwsDSN', 'remote proc transaction promotion', false;
--Increase query timeout if query is going to take longer than 10 mins (Default timeout is 600 seconds)
--EXEC sp_serveroption 'LS_AmazonmwsDSN', 'query timeout', 1200;
GO
Here is the difference between OPENQUERY vs EXEC approaches:
Fetching Tables / Columns using metadata stored procs
ZappySys Data Gateway emulates certains system procs you might find in real SQL Server. You can call using below syntax using 4-Parts syntax
exec [linked-server-name].[gateway-datasource-name].[DATA].sp_tables
exec [linked-server-name].[gateway-datasource-name].[DATA].sp_columns_90 N'your-table-name'
Example:
//List all tables
exec [ls_AmazonmwsDSN].[AmazonmwsDSN].[DATA].sp_tables
//List all columns and its type for specified table
exec [ls_AmazonmwsDSN].[AmazonmwsDSN].[DATA].sp_columns_90 N'Account'
Known Issues
Let's explore some common problems that can occur when using OPENQUERY or Data Gateway connectivity.
SQL Native Client 11.0 not visible in the Providers dropdown (Linked Server Creation)
If you are following some screenshots / steps from our article it might say use SQL Native Client to create Linked Server to ZappySys Gateway but for some users they dont see that driver entry in the dropdown. This is due to the fact that Microsoft has deprecated SQL Native Client OLEDB Driver (SQLNCLI and SQLNCLI11) going forward after SQL 2022. So you need to use [Microsoft OLE DB Driver for SQL Server] instead (MSOLEDBSQL). Please follow all other instructions except the driver type selection, use new suggested driver instead if you dont see SQL Native Client.
Error: The data is invalid
There will be a time when, you may encounter unexpected errors like the ones listed below. These can include:
OLE DB provider "SQLNCLI11" for linked server "Zs_Csv" returned message "Deferred prepare could not be completed.".
OLE DB provider "SQLNCLI11" for linked server "Zs_Csv" returned message "Communication link failure".
Msg 13, Level 16, State 1, Line 0
Session Provider: The data is invalid.
Possible Cause:
There are few reasons for such error but below are two main reasons
-
If the query length exceeds 2000 characters, as shown below, you might encounter this error.
SELECT * FROM OPENQUERY(LS, '--some really long text more than 2000 chars--')
-
If a query contains multiple OPENQUERY statements for JOINs or UNIONs, as shown below, it might fail due to a MARS compatibility issue where the gateway doesn't support parallel queries on a single connection.
SELECT a.id, b.name from OPENQUERY(LS, 'select * from tbl1') a join OPENQUERY(LS, 'select * from tbl2') b on a.id=b.id
Possible Fix:
There are few ways to fix above error based on reason why you getting this error (i.e. Query Length issue OR JOIN/UNION in the same statement)
-
If your query has long SQL (more than 2000 chars ) then reduce SQL length using different techniques
-
If your query uses JOIN / UNION with multiple OPENQUERY in same SQL then use multiple Linked servers (one for each OPENQUERY clause) as below.
select a.id, b.name from OPENQUERY(LS_1, 'select * from tbl1') a join OPENQUERY(LS_2, 'select * from tbl2') b on a.id=b.id
Error: Unable to begin a distributed transaction (When INSERT + EXEC used)
If you try to use the EXEC statement to insert data into a table, as shown below, you might encounter the following error unless the MSDTC option is turned off.
INSERT INTO MyTable EXEC('select * from tbl') AT MyLinkedServer
"Protocol error in TDS stream"
The operation could not be performed because OLE DB provider "SQLNCLI11" for linked server "ls_Json2" was unable to begin a distributed transaction.
--OR--
The operation could not be performed because OLE DB provider "MSOLEDBSQL" for linked server "ls_Json" was unable to begin a distributed transaction.
Solution:
Method-1: Go to linked server properties | Server Options | Enable Promotion of Distributed Transaction | Change to false (Default is true)
Now your try your INSERT with EXEC AT and it should work
Method-2: Run the below command if you dont want to use UI
EXEC master.dbo.sp_serveroption @server=N'My_Linked_Server', @optname=N'remote proc transaction promotion', @optvalue=N'false'
Error: Cannot use OPENQUERY with JOIN / UNION
When you perform a JOIN or UNION ALL on the same Linked Server, it may fail to process sometimes because the Data Gateway doesn't support parallel query requests on the same connection. A workaround for that would be to create multiple linked servers for the same data source. Refer to the section above for the same workaround.
Error: Truncation errors due to data length mismatch
Many times, you may encounter truncation errors if a table column's length is less than the actual column size from the query column. To solve this issue, use the new version of Data Gateway and check the 'Use nvarchar(max) for string options' option found on the General Tab.
Performance Tips
Now, let's look at a few performance tips in this section.
Use INSERT INTO rather than SELECT INTO to avoid extra META request
We discussed some Pros and Cons of OPENQUERY vs EXEC (…) AT in previous section. One obvious advantage of EXEC (….) AT is it reduces number of requests to driver (It sends pass through query). With EXEC you cannot load data dynamically like SELECT INTO tmp FROM OPENQUERY. Table must exist before hand if you use EXEC.
INSERT INTO tmp_API_Report_Load(col1,col2)
EXEC('select col1,col2 from some_api_table') AT [API-LINKED-SERVER]
--OR--
INSERT INTO tmp_API_Report_Load(col1,col2)
select col1,col2 from OPENQUERY([API-LINKED-SERVER], 'select col1,col2 from some_api_table')
The advantage of this method is that your query speed will increase because the system only calls the API once when you use EXEC AT. In contrast, with OPENROWSET, the query needs to be called twice: once to obtain metadata and once to retrieve the data.
Use Cached Metadata if possible
By default, most SQL queries sent to the Data Gateway need to invoke two phases: first, to get metadata, and second, to fetch data. However, you can bypass the metadata API call by supplying static metadata. Use the META property in the WITH clause, as explained in
this article, to speed up your SQL queries.
Advanced topics
Create Custom Stored Procedure in ZappySys Driver
You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.
Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
CREATE PROCEDURE [usp_get_orders]
@fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
AS
SELECT * FROM Orders where OrderDate >= '<@fromdate>';
-
That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
Exec usp_get_orders '1996-01-01';
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Create Custom Virtual Table in ZappySys Driver
ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.
If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.
Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
SELECT
"ShipCountry",
"OrderID",
"CustomerID",
"EmployeeID",
"OrderDate",
"RequiredDate",
"ShippedDate",
"ShipVia",
"Freight",
"ShipName",
"ShipAddress",
"ShipCity",
"ShipRegion",
"ShipPostalCode"
FROM "Orders"
Where "ShipCountry"='USA'
-
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
SELECT * FROM "vt__usa_orders_only"
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Actions supported by Amazon MWS Connector
Amazon MWS 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.
The ListOrders operation returns a list of orders created or updated during a time frame that you specify. You define that time frame using the CreatedAfter parameter or the LastUpdatedAfter parameter. You must use one of these parameters, but not both. You can also apply a range of filtering criteria to narrow the list of orders that is returned. The ListOrders operation includes order information for each order returned, including AmazonOrderId, OrderStatus, FulfillmentChannel, and LastUpdateDate. [
Read more...]
Parameter |
Description |
CreatedAfter |
A UTC date used for selecting orders created after (or at) a specified time. Date format must be UTC - ISO 8601 format (e.g. 2017-02-10T12:10:02Z). If LastUpdatedAfter is not specified. Specifying both CreatedAfter and LastUpdatedAfter returns an error.
|
CreatedBefore |
A UTC date used for selecting orders created before (or at) a specified time. Date format must be UTC - ISO 8601 format (e.g. 2017-02-10T12:10:02Z)
|
LastUpdatedAfter |
A UTC date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. Date format must be UTC - ISO 8601 format (e.g. 2017-02-10T12:10:02Z). If CreatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.If LastUpdatedAfter is specified, then BuyerEmail and SellerOrderId cannot be specified.
|
LastUpdatedBefore |
A UTC date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. Date format must be UTC - ISO 8601 format (e.g. 2017-02-10T12:10:02Z)
|
OrderStatus |
A list of OrderStatus values. Used to select orders with a current status that matches one of the status values that you specify.
Option |
Value |
Pending |
Pending |
Unshipped |
Unshipped |
PartiallyShipped |
PartiallyShipped |
PendingAvailability |
PendingAvailability |
Shipped |
Shipped |
Canceled |
Canceled |
Unfulfillable |
Unfulfillable |
|
FulfillmentChannel |
A list that indicates how an order was fulfilled.
Option |
Value |
Fulfilled by Amazon |
AFN |
Fulfilled by the seller |
MFN |
|
PaymentMethod |
A list of PaymentMethod values. Used to select orders paid for with the payment methods that you specify.
Option |
Value |
Cash on delivery |
COD |
Convenience store payment |
CVS |
Any payment method other than COD or CVS |
Other |
|
BuyerEmail |
The e-mail address of a buyer. Used to select only the orders that contain the specified e-mail address. If BuyerEmail is specified, then FulfillmentChannel, OrderStatus, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and SellerOrderId cannot be specified.
|
SellerOrderId |
An order identifier that is specified by the seller. Not an Amazon order identifier. Used to select only the orders that match a seller-specified order identifier. If SellerOrderId is specified, then FulfillmentChannel, OrderStatus, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.
|
EasyShipShipmentStatus |
A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with current statuses that match the status values that you specify. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.This parameter is valid only in the India marketplace.
Option |
Value |
PendingPickUp# Amazon has not yet picked up the package from the seller |
PendingPickUp |
LabelCanceled# The seller canceled the pickup |
LabelCanceled |
PickedUp# Amazon has picked up the package from the seller |
PickedUp |
OutForDelivery# The package is out for delivery |
OutForDelivery |
Damaged# The package was damaged by the carrier |
Damaged |
Delivered# Package has been delivered to the buyer. |
Delivered |
RejectedByBuyer# Package has been rejected by the buyer. |
RejectedByBuyer |
Undeliverable# The package cannot be delivered. |
Undeliverable |
ReturnedToSeller# The package was not delivered to the customer and was returned to the seller. |
ReturnedToSeller |
ReturningToSeller# The package was not delivered to the customer and is being returned to the seller. |
ReturningToSeller |
Lost# Package was lost by the carrier. |
Lost |
|
Version |
|
The ListOrderItems operation returns order item information for an AmazonOrderId that you specify. The order item information includes Title, ASIN, SellerSKU, ItemPrice, ShippingPrice, as well as tax and promotion information. [
Read more...]
Parameter |
Description |
AmazonOrderId |
An Amazon-defined order identifier, in 3-7-7 format (Example: 058-1233752-8214740).
|
Version |
|
Orders: Get Single Order Information
The GetOrder operation returns an order for each AmazonOrderId that you specify, up to a maximum of 50. The GetOrder operation includes order information for each order returned, including PurchaseDate, OrderStatus, FulfillmentChannel, and LastUpdateDate. [
Read more...]
Parameter |
Description |
AmazonOrderIdList |
A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format. (Example: 058-1233752-8214740).
|
Version |
|
Get FlatFile Report (Live)
Returns data from FlatFile Reports (TSV - Tab Seperated Values) listed here http://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html. Depending which Report you choose, it can take upto 30 minutes to generate report. To get data from previously generated report, you can use [Get CSV Report By ID - Cached Copy] endpoint to fetch data by GeneratedReportId [
Read more...]
Parameter |
Description |
ReportType |
Option |
Value |
Inventory: Inventory Report |
_GET_FLAT_FILE_OPEN_LISTINGS_DATA_ |
Inventory: Inventory ReportAll Listings Report |
_GET_MERCHANT_LISTINGS_ALL_DATA_ |
Inventory: Active Listings Report |
_GET_MERCHANT_LISTINGS_DATA_ |
Inventory: Inactive Listings Report |
_GET_MERCHANT_LISTINGS_INACTIVE_DATA_ |
Inventory: Open Listings Report |
_GET_MERCHANT_LISTINGS_DATA_BACK_COMPAT_ |
Inventory: Open Listings Report Lite |
_GET_MERCHANT_LISTINGS_DATA_LITE_ |
Inventory: Open Listings Report Liter |
_GET_MERCHANT_LISTINGS_DATA_LITER_ |
Inventory: Canceled Listings Report |
_GET_MERCHANT_CANCELLED_LISTINGS_DATA_ |
Inventory: Sold Listings Report |
_GET_CONVERGED_FLAT_FILE_SOLD_LISTINGS_DATA_ |
Inventory: Listing Quality and Suppressed Listing Report |
_GET_MERCHANT_LISTINGS_DEFECT_DATA_ |
Inventory: Pan-European Eligibility: FBA ASINs |
_GET_PAN_EU_OFFER_STATUS_ |
Inventory: Pan-European Eligibility: Self-fulfilled ASINs |
_GET_MFN_PAN_EU_OFFER_STATUS_ |
Inventory: Global Expansion Opportunities Report |
_GET_FLAT_FILE_GEO_OPPORTUNITIES_ |
Inventory: Referral Fee Preview Report |
_GET_REFERRAL_FEE_PREVIEW_REPORT_ |
Order: Unshipped Orders Report |
_GET_FLAT_FILE_ACTIONABLE_ORDER_DATA_ |
Order: Requested or Scheduled Flat File Order Report |
_GET_FLAT_FILE_ORDERS_DATA_ |
Order: Flat File Order Report |
_GET_CONVERGED_FLAT_FILE_ORDER_REPORT_DATA_ |
Order Tracking: Flat File Orders By Last Update Report |
_GET_FLAT_FILE_ALL_ORDERS_DATA_BY_LAST_UPDATE_ |
Order Tracking: Flat File Orders By Order Date Report |
_GET_FLAT_FILE_ALL_ORDERS_DATA_BY_ORDER_DATE_ |
Order Tracking: Flat File Archived Orders Report |
_GET_FLAT_FILE_ARCHIVED_ORDERS_DATA_BY_ORDER_DATE_ |
Pending Order: Flat File Pending Orders Report |
_GET_FLAT_FILE_PENDING_ORDERS_DATA_ |
Pending Order: Converged Flat File Pending Orders Report |
_GET_CONVERGED_FLAT_FILE_PENDING_ORDERS_DATA_ |
Returns: Flat File Returns Report by Return Date |
_GET_FLAT_FILE_RETURNS_DATA_BY_RETURN_DATE_ |
Returns: CSV Prime Returns Report by Return Date |
_GET_CSV_MFN_PRIME_RETURNS_REPORT_ |
Returns: Flat File Return Attributes Report by Return Date |
_GET_FLAT_FILE_MFN_SKU_RETURN_ATTRIBUTES_REPORT_ |
Performance: Flat File Feedback Report |
_GET_SELLER_FEEDBACK_DATA_ |
Settlement: Flat File Settlement Report |
_GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_ |
Settlement: Flat File V2 Settlement Report |
_GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2_ |
FBA Sales: FBA Amazon Fulfilled Shipments Report |
_GET_AMAZON_FULFILLED_SHIPMENTS_DATA_ |
FBA Sales: Flat File All Orders Report by Last Update |
_GET_FLAT_FILE_ALL_ORDERS_DATA_BY_LAST_UPDATE_ |
FBA Sales: Flat File All Orders Report by Order Date |
_GET_FLAT_FILE_ALL_ORDERS_DATA_BY_ORDER_DATE_ |
FBA Sales: XML All Orders Report by Last Update |
_GET_XML_ALL_ORDERS_DATA_BY_LAST_UPDATE_ |
FBA Sales: XML All Orders Report by Order Date |
_GET_XML_ALL_ORDERS_DATA_BY_ORDER_DATE_ |
FBA Sales: FBA Customer Shipment Sales Report |
_GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_SALES_DATA_ |
FBA Sales: FBA Promotions Report |
_GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_PROMOTION_DATA_ |
FBA Sales: FBA Customer Taxes |
_GET_FBA_FULFILLMENT_CUSTOMER_TAXES_DATA_ |
FBA Sales: Remote Fulfillment Eligibility |
_GET_REMOTE_FULFILLMENT_ELIGIBILITY_ |
FBA Inventory: FBA Amazon Fulfilled Inventory Report |
_GET_AFN_INVENTORY_DATA_ |
FBA Inventory: FBA Multi-Country Inventory Report |
_GET_AFN_INVENTORY_DATA_BY_COUNTRY_ |
FBA Inventory: FBA Daily Inventory History Report |
_GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA_ |
FBA Inventory: FBA Monthly Inventory History Report |
_GET_FBA_FULFILLMENT_MONTHLY_INVENTORY_DATA_ |
FBA Inventory: FBA Received Inventory Report |
_GET_FBA_FULFILLMENT_INVENTORY_RECEIPTS_DATA_ |
FBA Inventory: FBA Reserved Inventory Report |
_GET_RESERVED_INVENTORY_DATA_ |
FBA Inventory: FBA Inventory Event Detail Report |
_GET_FBA_FULFILLMENT_INVENTORY_SUMMARY_DATA_ |
FBA Inventory: FBA Inventory Adjustments Report |
_GET_FBA_FULFILLMENT_INVENTORY_ADJUSTMENTS_DATA_ |
FBA Inventory: FBA Inventory Health Report |
_GET_FBA_FULFILLMENT_INVENTORY_HEALTH_DATA_ |
FBA Inventory: FBA Manage Inventory |
_GET_FBA_MYI_UNSUPPRESSED_INVENTORY_DATA_ |
FBA Inventory: FBA Manage Inventory - Archived |
_GET_FBA_MYI_ALL_INVENTORY_DATA_ |
FBA Inventory: Restock Inventory Report |
_GET_RESTOCK_INVENTORY_RECOMMENDATIONS_REPORT_ |
FBA Inventory: FBA Inbound Performance Report |
_GET_FBA_FULFILLMENT_INBOUND_NONCOMPLIANCE_DATA_ |
FBA Inventory: FBA Stranded Inventory Report |
_GET_STRANDED_INVENTORY_UI_DATA_ |
FBA Inventory: FBA Bulk Fix Stranded Inventory Report |
_GET_STRANDED_INVENTORY_LOADER_DATA_ |
FBA Inventory: FBA Inventory Age Report |
_GET_FBA_INVENTORY_AGED_DATA_ |
FBA Inventory: FBA Manage Excess Inventory Report |
_GET_EXCESS_INVENTORY_DATA_ |
FBA Inventory: FBA Storage Fees Report |
_GET_FBA_STORAGE_FEE_CHARGES_DATA_ |
FBA Inventory: Get Report Exchange Data |
_GET_PRODUCT_EXCHANGE_DATA_ |
FBA Inventory: FBA Fee Preview Report |
_GET_FBA_ESTIMATED_FBA_FEES_TXT_DATA_ |
FBA Inventory: FBA Reimbursements Report |
_GET_FBA_REIMBURSEMENTS_DATA_ |
FBA Inventory: FBA Long Term Storage Fee Charges Report |
_GET_FBA_FULFILLMENT_LONGTERM_STORAGE_FEE_CHARGES_DATA_ |
FBA Inventory: FBA Returns Report |
_GET_FBA_FULFILLMENT_CUSTOMER_RETURNS_DATA_ |
FBA Inventory: FBA Replacements Report |
_GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_REPLACEMENT_DATA_ |
FBA Inventory: FBA Recommended Removal Report |
_GET_FBA_RECOMMENDED_REMOVAL_DATA_ |
FBA Inventory: FBA Removal Order Detail Report |
_GET_FBA_FULFILLMENT_REMOVAL_ORDER_DETAIL_DATA_ |
FBA Inventory: FBA Removal Shipment Detail Report |
_GET_FBA_FULFILLMENT_REMOVAL_SHIPMENT_DETAIL_DATA_ |
FBA Inventory: Small and Light Inventory Report |
_GET_FBA_UNO_INVENTORY_DATA_ |
Tax: Sales Tax Report |
_GET_FLAT_FILE_SALES_TAX_DATA_ |
Tax: Amazon VAT Calculation Report |
_SC_VAT_TAX_REPORT_ |
Tax: Amazon VAT Transactions Report |
_GET_VAT_TRANSACTION_DATA_ |
Tax: On Demand GST Merchant Tax Report B2B |
_GET_GST_MTR_B2B_CUSTOM_ |
Tax: On Demand GST Merchant Tax Report B2C |
_GET_GST_MTR_B2C_CUSTOM_ |
|
StartDate |
Report Start date if applicable - Must be UTC date in ISO format e.g. (2020-01-31T00:00:00Z).
|
EndDate |
Report End date if applicable - Must be UTC date in ISO format e.g. (2020-01-31T00:00:00Z).
|
ReportOptions |
Option |
Value |
Return Custom Report |
custom=true |
|
Version |
|
Returns data from XML Reports listed here http://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html [
Read more...]
Parameter |
Description |
ReportType |
Option |
Value |
Order: Scheduled XML Order Report |
_GET_ORDERS_DATA_ |
Order Tracking: XML Orders By Last Update Report |
_GET_XML_ALL_ORDERS_DATA_BY_LAST_UPDATE_ |
Order Tracking: XML Orders By Order Date Report |
_GET_XML_ALL_ORDERS_DATA_BY_ORDER_DATE_ |
Pending Order: XML Pending Orders Report |
_GET_PENDING_ORDERS_DATA_ |
Returns: XML Returns Report by Return Date |
_GET_XML_RETURNS_DATA_BY_RETURN_DATE_ |
Returns: XML Prime Returns Report by Return Date |
_GET_XML_MFN_PRIME_RETURNS_REPORT_ |
Returns: XML Return Attributes Report by Return Date |
_GET_XML_MFN_SKU_RETURN_ATTRIBUTES_REPORT_ |
Performance: XML Customer Metrics Report |
_GET_V1_SELLER_PERFORMANCE_REPORT_ |
Settlement: XML Settlement Report |
_GET_V2_SETTLEMENT_REPORT_DATA_XML_ |
Browse Tree: Browse Tree Report |
_GET_XML_BROWSE_TREE_DATA_ |
|
StartDate |
Report Start date if applicable - Must be UTC date in ISO format e.g. (2020-01-31T00:00:00Z).
|
EndDate |
Report End date if applicable - Must be UTC date in ISO format e.g. (2020-01-31T00:00:00Z).
|
ReportOptions |
Option |
Value |
Return Custom Report |
custom=true |
|
Version |
|
Get CSV Report By ID - Cached Copy (Previously Generated)
[
Read more...]
Parameter |
Description |
ReportId |
Enter Report ID returned by GetReportRequestList (With status of _DONE_ or _DONE_NO_DATA_) or GetReportList (only done reports)
|
Version |
|
Get XML Report By ID - Cached Copy (Previously Generated)
[
Read more...]
Parameter |
Description |
ReportId |
Enter Report ID returned by GetReportRequestList (With status of _DONE_ or _DONE_NO_DATA_) or GetReportList (only done reports)
|
Version |
|
Returns a count of the reports, created in the previous 90 days, with a status of _DONE_ and that are available for download. [
Read more...]
Parameter |
Description |
AmazonOrderId |
A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format. (Example: 058-1233752-8214740).
|
ReportTypeList |
Option |
Value |
Inventory: Inventory Report |
_GET_FLAT_FILE_OPEN_LISTINGS_DATA_ |
Inventory: Inventory ReportAll Listings Report |
_GET_MERCHANT_LISTINGS_ALL_DATA_ |
Inventory: Active Listings Report |
_GET_MERCHANT_LISTINGS_DATA_ |
Inventory: Inactive Listings Report |
_GET_MERCHANT_LISTINGS_INACTIVE_DATA_ |
Inventory: Open Listings Report |
_GET_MERCHANT_LISTINGS_DATA_BACK_COMPAT_ |
Inventory: Open Listings Report Lite |
_GET_MERCHANT_LISTINGS_DATA_LITE_ |
Inventory: Open Listings Report Liter |
_GET_MERCHANT_LISTINGS_DATA_LITER_ |
Inventory: Canceled Listings Report |
_GET_MERCHANT_CANCELLED_LISTINGS_DATA_ |
Inventory: Sold Listings Report |
_GET_CONVERGED_FLAT_FILE_SOLD_LISTINGS_DATA_ |
Inventory: Listing Quality and Suppressed Listing Report |
_GET_MERCHANT_LISTINGS_DEFECT_DATA_ |
Inventory: Pan-European Eligibility: FBA ASINs |
_GET_PAN_EU_OFFER_STATUS_ |
Inventory: Pan-European Eligibility: Self-fulfilled ASINs |
_GET_MFN_PAN_EU_OFFER_STATUS_ |
Inventory: Global Expansion Opportunities Report |
_GET_FLAT_FILE_GEO_OPPORTUNITIES_ |
Inventory: Referral Fee Preview Report |
_GET_REFERRAL_FEE_PREVIEW_REPORT_ |
Order: Unshipped Orders Report |
_GET_FLAT_FILE_ACTIONABLE_ORDER_DATA_ |
Order: Scheduled XML Order Report |
_GET_ORDERS_DATA_ |
Order: Requested or Scheduled Flat File Order Report |
_GET_FLAT_FILE_ORDERS_DATA_ |
Order: Flat File Order Report |
_GET_CONVERGED_FLAT_FILE_ORDER_REPORT_DATA_ |
Order Tracking: Flat File Orders By Last Update Report |
_GET_FLAT_FILE_ALL_ORDERS_DATA_BY_LAST_UPDATE_ |
Order Tracking: Flat File Orders By Order Date Report |
_GET_FLAT_FILE_ALL_ORDERS_DATA_BY_ORDER_DATE_ |
Order Tracking: Flat File Archived Orders Report |
_GET_FLAT_FILE_ARCHIVED_ORDERS_DATA_BY_ORDER_DATE_ |
Order Tracking: XML Orders By Last Update Report |
_GET_XML_ALL_ORDERS_DATA_BY_LAST_UPDATE_ |
Order Tracking: XML Orders By Order Date Report |
_GET_XML_ALL_ORDERS_DATA_BY_ORDER_DATE_ |
Pending Order: Flat File Pending Orders Report |
_GET_FLAT_FILE_PENDING_ORDERS_DATA_ |
Pending Order: XML Pending Orders Report |
_GET_PENDING_ORDERS_DATA_ |
Pending Order: Converged Flat File Pending Orders Report |
_GET_CONVERGED_FLAT_FILE_PENDING_ORDERS_DATA_ |
Returns: XML Returns Report by Return Date |
_GET_XML_RETURNS_DATA_BY_RETURN_DATE_ |
Returns: Flat File Returns Report by Return Date |
_GET_FLAT_FILE_RETURNS_DATA_BY_RETURN_DATE_ |
Returns: XML Prime Returns Report by Return Date |
_GET_XML_MFN_PRIME_RETURNS_REPORT_ |
Returns: CSV Prime Returns Report by Return Date |
_GET_CSV_MFN_PRIME_RETURNS_REPORT_ |
Returns: XML Return Attributes Report by Return Date |
_GET_XML_MFN_SKU_RETURN_ATTRIBUTES_REPORT_ |
Returns: Flat File Return Attributes Report by Return Date |
_GET_FLAT_FILE_MFN_SKU_RETURN_ATTRIBUTES_REPORT_ |
Performance: Flat File Feedback Report |
_GET_SELLER_FEEDBACK_DATA_ |
Performance: XML Customer Metrics Report |
_GET_V1_SELLER_PERFORMANCE_REPORT_ |
Settlement: Flat File Settlement Report |
_GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_ |
Settlement: XML Settlement Report |
_GET_V2_SETTLEMENT_REPORT_DATA_XML_ |
Settlement: Flat File V2 Settlement Report |
_GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2_ |
FBA Sales: FBA Amazon Fulfilled Shipments Report |
_GET_AMAZON_FULFILLED_SHIPMENTS_DATA_ |
FBA Sales: Flat File All Orders Report by Last Update |
_GET_FLAT_FILE_ALL_ORDERS_DATA_BY_LAST_UPDATE_ |
FBA Sales: Flat File All Orders Report by Order Date |
_GET_FLAT_FILE_ALL_ORDERS_DATA_BY_ORDER_DATE_ |
FBA Sales: XML All Orders Report by Last Update |
_GET_XML_ALL_ORDERS_DATA_BY_LAST_UPDATE_ |
FBA Sales: XML All Orders Report by Order Date |
_GET_XML_ALL_ORDERS_DATA_BY_ORDER_DATE_ |
FBA Sales: FBA Customer Shipment Sales Report |
_GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_SALES_DATA_ |
FBA Sales: FBA Promotions Report |
_GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_PROMOTION_DATA_ |
FBA Sales: FBA Customer Taxes |
_GET_FBA_FULFILLMENT_CUSTOMER_TAXES_DATA_ |
FBA Sales: Remote Fulfillment Eligibility |
_GET_REMOTE_FULFILLMENT_ELIGIBILITY_ |
FBA Inventory: FBA Amazon Fulfilled Inventory Report |
_GET_AFN_INVENTORY_DATA_ |
FBA Inventory: FBA Multi-Country Inventory Report |
_GET_AFN_INVENTORY_DATA_BY_COUNTRY_ |
FBA Inventory: FBA Daily Inventory History Report |
_GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA_ |
FBA Inventory: FBA Monthly Inventory History Report |
_GET_FBA_FULFILLMENT_MONTHLY_INVENTORY_DATA_ |
FBA Inventory: FBA Received Inventory Report |
_GET_FBA_FULFILLMENT_INVENTORY_RECEIPTS_DATA_ |
FBA Inventory: FBA Reserved Inventory Report |
_GET_RESERVED_INVENTORY_DATA_ |
FBA Inventory: FBA Inventory Event Detail Report |
_GET_FBA_FULFILLMENT_INVENTORY_SUMMARY_DATA_ |
FBA Inventory: FBA Inventory Adjustments Report |
_GET_FBA_FULFILLMENT_INVENTORY_ADJUSTMENTS_DATA_ |
FBA Inventory: FBA Inventory Health Report |
_GET_FBA_FULFILLMENT_INVENTORY_HEALTH_DATA_ |
FBA Inventory: FBA Manage Inventory |
_GET_FBA_MYI_UNSUPPRESSED_INVENTORY_DATA_ |
FBA Inventory: FBA Manage Inventory - Archived |
_GET_FBA_MYI_ALL_INVENTORY_DATA_ |
FBA Inventory: Restock Inventory Report |
_GET_RESTOCK_INVENTORY_RECOMMENDATIONS_REPORT_ |
FBA Inventory: FBA Inbound Performance Report |
_GET_FBA_FULFILLMENT_INBOUND_NONCOMPLIANCE_DATA_ |
FBA Inventory: FBA Stranded Inventory Report |
_GET_STRANDED_INVENTORY_UI_DATA_ |
FBA Inventory: FBA Bulk Fix Stranded Inventory Report |
_GET_STRANDED_INVENTORY_LOADER_DATA_ |
FBA Inventory: FBA Inventory Age Report |
_GET_FBA_INVENTORY_AGED_DATA_ |
FBA Inventory: FBA Manage Excess Inventory Report |
_GET_EXCESS_INVENTORY_DATA_ |
FBA Inventory: FBA Storage Fees Report |
_GET_FBA_STORAGE_FEE_CHARGES_DATA_ |
FBA Inventory: Get Report Exchange Data |
_GET_PRODUCT_EXCHANGE_DATA_ |
FBA Inventory: FBA Fee Preview Report |
_GET_FBA_ESTIMATED_FBA_FEES_TXT_DATA_ |
FBA Inventory: FBA Reimbursements Report |
_GET_FBA_REIMBURSEMENTS_DATA_ |
FBA Inventory: FBA Long Term Storage Fee Charges Report |
_GET_FBA_FULFILLMENT_LONGTERM_STORAGE_FEE_CHARGES_DATA_ |
FBA Inventory: FBA Returns Report |
_GET_FBA_FULFILLMENT_CUSTOMER_RETURNS_DATA_ |
FBA Inventory: FBA Replacements Report |
_GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_REPLACEMENT_DATA_ |
FBA Inventory: FBA Recommended Removal Report |
_GET_FBA_RECOMMENDED_REMOVAL_DATA_ |
FBA Inventory: FBA Removal Order Detail Report |
_GET_FBA_FULFILLMENT_REMOVAL_ORDER_DETAIL_DATA_ |
FBA Inventory: FBA Removal Shipment Detail Report |
_GET_FBA_FULFILLMENT_REMOVAL_SHIPMENT_DETAIL_DATA_ |
FBA Inventory: Small and Light Inventory Report |
_GET_FBA_UNO_INVENTORY_DATA_ |
Tax: Sales Tax Report |
_GET_FLAT_FILE_SALES_TAX_DATA_ |
Tax: Amazon VAT Calculation Report |
_SC_VAT_TAX_REPORT_ |
Tax: Amazon VAT Transactions Report |
_GET_VAT_TRANSACTION_DATA_ |
Tax: On Demand GST Merchant Tax Report B2B |
_GET_GST_MTR_B2B_CUSTOM_ |
Tax: On Demand GST Merchant Tax Report B2C |
_GET_GST_MTR_B2C_CUSTOM_ |
Browse Tree: Browse Tree Report |
_GET_XML_BROWSE_TREE_DATA_ |
|
Acknowledged |
A Boolean value that indicates if an order report has been acknowledged by a prior call to UpdateReportAcknowledgements. Set to true to list order reports that have been acknowledged; set to false to list order reports that have not been acknowledged. This filter is valid only with order reports; it does not work with listing reports.
Option |
Value |
true |
true |
false |
false |
|
AvailableFromDate |
The earliest date you are looking for. Date format must be UTC - ISO 8601 format (e.g. 2017-02-10T12:10:02Z)
|
AvailableToDate |
The most recent date you are looking for. Date format must be UTC - ISO 8601 format (e.g. 2017-02-10T12:10:02Z)
|
Version |
|
Get Report List (Successful Only)
Returns a list of reports that were created in the previous 90 days. [
Read more...]
Parameter |
Description |
ReportTypeList |
Option |
Value |
Inventory: Inventory Report |
_GET_FLAT_FILE_OPEN_LISTINGS_DATA_ |
Inventory: Inventory ReportAll Listings Report |
_GET_MERCHANT_LISTINGS_ALL_DATA_ |
Inventory: Active Listings Report |
_GET_MERCHANT_LISTINGS_DATA_ |
Inventory: Inactive Listings Report |
_GET_MERCHANT_LISTINGS_INACTIVE_DATA_ |
Inventory: Open Listings Report |
_GET_MERCHANT_LISTINGS_DATA_BACK_COMPAT_ |
Inventory: Open Listings Report Lite |
_GET_MERCHANT_LISTINGS_DATA_LITE_ |
Inventory: Open Listings Report Liter |
_GET_MERCHANT_LISTINGS_DATA_LITER_ |
Inventory: Canceled Listings Report |
_GET_MERCHANT_CANCELLED_LISTINGS_DATA_ |
Inventory: Sold Listings Report |
_GET_CONVERGED_FLAT_FILE_SOLD_LISTINGS_DATA_ |
Inventory: Listing Quality and Suppressed Listing Report |
_GET_MERCHANT_LISTINGS_DEFECT_DATA_ |
Inventory: Pan-European Eligibility: FBA ASINs |
_GET_PAN_EU_OFFER_STATUS_ |
Inventory: Pan-European Eligibility: Self-fulfilled ASINs |
_GET_MFN_PAN_EU_OFFER_STATUS_ |
Inventory: Global Expansion Opportunities Report |
_GET_FLAT_FILE_GEO_OPPORTUNITIES_ |
Inventory: Referral Fee Preview Report |
_GET_REFERRAL_FEE_PREVIEW_REPORT_ |
Order: Unshipped Orders Report |
_GET_FLAT_FILE_ACTIONABLE_ORDER_DATA_ |
Order: Scheduled XML Order Report |
_GET_ORDERS_DATA_ |
Order: Requested or Scheduled Flat File Order Report |
_GET_FLAT_FILE_ORDERS_DATA_ |
Order: Flat File Order Report |
_GET_CONVERGED_FLAT_FILE_ORDER_REPORT_DATA_ |
Order Tracking: Flat File Orders By Last Update Report |
_GET_FLAT_FILE_ALL_ORDERS_DATA_BY_LAST_UPDATE_ |
Order Tracking: Flat File Orders By Order Date Report |
_GET_FLAT_FILE_ALL_ORDERS_DATA_BY_ORDER_DATE_ |
Order Tracking: Flat File Archived Orders Report |
_GET_FLAT_FILE_ARCHIVED_ORDERS_DATA_BY_ORDER_DATE_ |
Order Tracking: XML Orders By Last Update Report |
_GET_XML_ALL_ORDERS_DATA_BY_LAST_UPDATE_ |
Order Tracking: XML Orders By Order Date Report |
_GET_XML_ALL_ORDERS_DATA_BY_ORDER_DATE_ |
Pending Order: Flat File Pending Orders Report |
_GET_FLAT_FILE_PENDING_ORDERS_DATA_ |
Pending Order: XML Pending Orders Report |
_GET_PENDING_ORDERS_DATA_ |
Pending Order: Converged Flat File Pending Orders Report |
_GET_CONVERGED_FLAT_FILE_PENDING_ORDERS_DATA_ |
Returns: XML Returns Report by Return Date |
_GET_XML_RETURNS_DATA_BY_RETURN_DATE_ |
Returns: Flat File Returns Report by Return Date |
_GET_FLAT_FILE_RETURNS_DATA_BY_RETURN_DATE_ |
Returns: XML Prime Returns Report by Return Date |
_GET_XML_MFN_PRIME_RETURNS_REPORT_ |
Returns: CSV Prime Returns Report by Return Date |
_GET_CSV_MFN_PRIME_RETURNS_REPORT_ |
Returns: XML Return Attributes Report by Return Date |
_GET_XML_MFN_SKU_RETURN_ATTRIBUTES_REPORT_ |
Returns: Flat File Return Attributes Report by Return Date |
_GET_FLAT_FILE_MFN_SKU_RETURN_ATTRIBUTES_REPORT_ |
Performance: Flat File Feedback Report |
_GET_SELLER_FEEDBACK_DATA_ |
Performance: XML Customer Metrics Report |
_GET_V1_SELLER_PERFORMANCE_REPORT_ |
Settlement: Flat File Settlement Report |
_GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_ |
Settlement: XML Settlement Report |
_GET_V2_SETTLEMENT_REPORT_DATA_XML_ |
Settlement: Flat File V2 Settlement Report |
_GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2_ |
FBA Sales: FBA Amazon Fulfilled Shipments Report |
_GET_AMAZON_FULFILLED_SHIPMENTS_DATA_ |
FBA Sales: Flat File All Orders Report by Last Update |
_GET_FLAT_FILE_ALL_ORDERS_DATA_BY_LAST_UPDATE_ |
FBA Sales: Flat File All Orders Report by Order Date |
_GET_FLAT_FILE_ALL_ORDERS_DATA_BY_ORDER_DATE_ |
FBA Sales: XML All Orders Report by Last Update |
_GET_XML_ALL_ORDERS_DATA_BY_LAST_UPDATE_ |
FBA Sales: XML All Orders Report by Order Date |
_GET_XML_ALL_ORDERS_DATA_BY_ORDER_DATE_ |
FBA Sales: FBA Customer Shipment Sales Report |
_GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_SALES_DATA_ |
FBA Sales: FBA Promotions Report |
_GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_PROMOTION_DATA_ |
FBA Sales: FBA Customer Taxes |
_GET_FBA_FULFILLMENT_CUSTOMER_TAXES_DATA_ |
FBA Sales: Remote Fulfillment Eligibility |
_GET_REMOTE_FULFILLMENT_ELIGIBILITY_ |
FBA Inventory: FBA Amazon Fulfilled Inventory Report |
_GET_AFN_INVENTORY_DATA_ |
FBA Inventory: FBA Multi-Country Inventory Report |
_GET_AFN_INVENTORY_DATA_BY_COUNTRY_ |
FBA Inventory: FBA Daily Inventory History Report |
_GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA_ |
FBA Inventory: FBA Monthly Inventory History Report |
_GET_FBA_FULFILLMENT_MONTHLY_INVENTORY_DATA_ |
FBA Inventory: FBA Received Inventory Report |
_GET_FBA_FULFILLMENT_INVENTORY_RECEIPTS_DATA_ |
FBA Inventory: FBA Reserved Inventory Report |
_GET_RESERVED_INVENTORY_DATA_ |
FBA Inventory: FBA Inventory Event Detail Report |
_GET_FBA_FULFILLMENT_INVENTORY_SUMMARY_DATA_ |
FBA Inventory: FBA Inventory Adjustments Report |
_GET_FBA_FULFILLMENT_INVENTORY_ADJUSTMENTS_DATA_ |
FBA Inventory: FBA Inventory Health Report |
_GET_FBA_FULFILLMENT_INVENTORY_HEALTH_DATA_ |
FBA Inventory: FBA Manage Inventory |
_GET_FBA_MYI_UNSUPPRESSED_INVENTORY_DATA_ |
FBA Inventory: FBA Manage Inventory - Archived |
_GET_FBA_MYI_ALL_INVENTORY_DATA_ |
FBA Inventory: Restock Inventory Report |
_GET_RESTOCK_INVENTORY_RECOMMENDATIONS_REPORT_ |
FBA Inventory: FBA Inbound Performance Report |
_GET_FBA_FULFILLMENT_INBOUND_NONCOMPLIANCE_DATA_ |
FBA Inventory: FBA Stranded Inventory Report |
_GET_STRANDED_INVENTORY_UI_DATA_ |
FBA Inventory: FBA Bulk Fix Stranded Inventory Report |
_GET_STRANDED_INVENTORY_LOADER_DATA_ |
FBA Inventory: FBA Inventory Age Report |
_GET_FBA_INVENTORY_AGED_DATA_ |
FBA Inventory: FBA Manage Excess Inventory Report |
_GET_EXCESS_INVENTORY_DATA_ |
FBA Inventory: FBA Storage Fees Report |
_GET_FBA_STORAGE_FEE_CHARGES_DATA_ |
FBA Inventory: Get Report Exchange Data |
_GET_PRODUCT_EXCHANGE_DATA_ |
FBA Inventory: FBA Fee Preview Report |
_GET_FBA_ESTIMATED_FBA_FEES_TXT_DATA_ |
FBA Inventory: FBA Reimbursements Report |
_GET_FBA_REIMBURSEMENTS_DATA_ |
FBA Inventory: FBA Long Term Storage Fee Charges Report |
_GET_FBA_FULFILLMENT_LONGTERM_STORAGE_FEE_CHARGES_DATA_ |
FBA Inventory: FBA Returns Report |
_GET_FBA_FULFILLMENT_CUSTOMER_RETURNS_DATA_ |
FBA Inventory: FBA Replacements Report |
_GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_REPLACEMENT_DATA_ |
FBA Inventory: FBA Recommended Removal Report |
_GET_FBA_RECOMMENDED_REMOVAL_DATA_ |
FBA Inventory: FBA Removal Order Detail Report |
_GET_FBA_FULFILLMENT_REMOVAL_ORDER_DETAIL_DATA_ |
FBA Inventory: FBA Removal Shipment Detail Report |
_GET_FBA_FULFILLMENT_REMOVAL_SHIPMENT_DETAIL_DATA_ |
FBA Inventory: Small and Light Inventory Report |
_GET_FBA_UNO_INVENTORY_DATA_ |
Tax: Sales Tax Report |
_GET_FLAT_FILE_SALES_TAX_DATA_ |
Tax: Amazon VAT Calculation Report |
_SC_VAT_TAX_REPORT_ |
Tax: Amazon VAT Transactions Report |
_GET_VAT_TRANSACTION_DATA_ |
Tax: On Demand GST Merchant Tax Report B2B |
_GET_GST_MTR_B2B_CUSTOM_ |
Tax: On Demand GST Merchant Tax Report B2C |
_GET_GST_MTR_B2C_CUSTOM_ |
Browse Tree: Browse Tree Report |
_GET_XML_BROWSE_TREE_DATA_ |
|
Acknowledged |
A Boolean value that indicates if an order report has been acknowledged by a prior call to UpdateReportAcknowledgements. Set to true to list order reports that have been acknowledged; set to false to list order reports that have not been acknowledged. This filter is valid only with order reports; it does not work with listing reports.
Option |
Value |
true |
true |
false |
false |
|
AvailableFromDate |
The earliest date you are looking for. Date format must be UTC - ISO 8601 format (e.g. 2017-02-10T12:10:02Z)
|
AvailableToDate |
The most recent date you are looking for. Date format must be UTC - ISO 8601 format (e.g. 2017-02-10T12:10:02Z)
|
Returns a list of report requests that you can use to get the ReportRequestId for a report. [
Read more...]
Parameter |
Description |
Version |
|
ReportTypeList |
Option |
Value |
Inventory: Inventory Report |
_GET_FLAT_FILE_OPEN_LISTINGS_DATA_ |
Inventory: Inventory ReportAll Listings Report |
_GET_MERCHANT_LISTINGS_ALL_DATA_ |
Inventory: Active Listings Report |
_GET_MERCHANT_LISTINGS_DATA_ |
Inventory: Inactive Listings Report |
_GET_MERCHANT_LISTINGS_INACTIVE_DATA_ |
Inventory: Open Listings Report |
_GET_MERCHANT_LISTINGS_DATA_BACK_COMPAT_ |
Inventory: Open Listings Report Lite |
_GET_MERCHANT_LISTINGS_DATA_LITE_ |
Inventory: Open Listings Report Liter |
_GET_MERCHANT_LISTINGS_DATA_LITER_ |
Inventory: Canceled Listings Report |
_GET_MERCHANT_CANCELLED_LISTINGS_DATA_ |
Inventory: Sold Listings Report |
_GET_CONVERGED_FLAT_FILE_SOLD_LISTINGS_DATA_ |
Inventory: Listing Quality and Suppressed Listing Report |
_GET_MERCHANT_LISTINGS_DEFECT_DATA_ |
Inventory: Pan-European Eligibility: FBA ASINs |
_GET_PAN_EU_OFFER_STATUS_ |
Inventory: Pan-European Eligibility: Self-fulfilled ASINs |
_GET_MFN_PAN_EU_OFFER_STATUS_ |
Inventory: Global Expansion Opportunities Report |
_GET_FLAT_FILE_GEO_OPPORTUNITIES_ |
Inventory: Referral Fee Preview Report |
_GET_REFERRAL_FEE_PREVIEW_REPORT_ |
Order: Unshipped Orders Report |
_GET_FLAT_FILE_ACTIONABLE_ORDER_DATA_ |
Order: Scheduled XML Order Report |
_GET_ORDERS_DATA_ |
Order: Requested or Scheduled Flat File Order Report |
_GET_FLAT_FILE_ORDERS_DATA_ |
Order: Flat File Order Report |
_GET_CONVERGED_FLAT_FILE_ORDER_REPORT_DATA_ |
Order Tracking: Flat File Orders By Last Update Report |
_GET_FLAT_FILE_ALL_ORDERS_DATA_BY_LAST_UPDATE_ |
Order Tracking: Flat File Orders By Order Date Report |
_GET_FLAT_FILE_ALL_ORDERS_DATA_BY_ORDER_DATE_ |
Order Tracking: Flat File Archived Orders Report |
_GET_FLAT_FILE_ARCHIVED_ORDERS_DATA_BY_ORDER_DATE_ |
Order Tracking: XML Orders By Last Update Report |
_GET_XML_ALL_ORDERS_DATA_BY_LAST_UPDATE_ |
Order Tracking: XML Orders By Order Date Report |
_GET_XML_ALL_ORDERS_DATA_BY_ORDER_DATE_ |
Pending Order: Flat File Pending Orders Report |
_GET_FLAT_FILE_PENDING_ORDERS_DATA_ |
Pending Order: XML Pending Orders Report |
_GET_PENDING_ORDERS_DATA_ |
Pending Order: Converged Flat File Pending Orders Report |
_GET_CONVERGED_FLAT_FILE_PENDING_ORDERS_DATA_ |
Returns: XML Returns Report by Return Date |
_GET_XML_RETURNS_DATA_BY_RETURN_DATE_ |
Returns: Flat File Returns Report by Return Date |
_GET_FLAT_FILE_RETURNS_DATA_BY_RETURN_DATE_ |
Returns: XML Prime Returns Report by Return Date |
_GET_XML_MFN_PRIME_RETURNS_REPORT_ |
Returns: CSV Prime Returns Report by Return Date |
_GET_CSV_MFN_PRIME_RETURNS_REPORT_ |
Returns: XML Return Attributes Report by Return Date |
_GET_XML_MFN_SKU_RETURN_ATTRIBUTES_REPORT_ |
Returns: Flat File Return Attributes Report by Return Date |
_GET_FLAT_FILE_MFN_SKU_RETURN_ATTRIBUTES_REPORT_ |
Performance: Flat File Feedback Report |
_GET_SELLER_FEEDBACK_DATA_ |
Performance: XML Customer Metrics Report |
_GET_V1_SELLER_PERFORMANCE_REPORT_ |
Settlement: Flat File Settlement Report |
_GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_ |
Settlement: XML Settlement Report |
_GET_V2_SETTLEMENT_REPORT_DATA_XML_ |
Settlement: Flat File V2 Settlement Report |
_GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2_ |
FBA Sales: FBA Amazon Fulfilled Shipments Report |
_GET_AMAZON_FULFILLED_SHIPMENTS_DATA_ |
FBA Sales: Flat File All Orders Report by Last Update |
_GET_FLAT_FILE_ALL_ORDERS_DATA_BY_LAST_UPDATE_ |
FBA Sales: Flat File All Orders Report by Order Date |
_GET_FLAT_FILE_ALL_ORDERS_DATA_BY_ORDER_DATE_ |
FBA Sales: XML All Orders Report by Last Update |
_GET_XML_ALL_ORDERS_DATA_BY_LAST_UPDATE_ |
FBA Sales: XML All Orders Report by Order Date |
_GET_XML_ALL_ORDERS_DATA_BY_ORDER_DATE_ |
FBA Sales: FBA Customer Shipment Sales Report |
_GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_SALES_DATA_ |
FBA Sales: FBA Promotions Report |
_GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_PROMOTION_DATA_ |
FBA Sales: FBA Customer Taxes |
_GET_FBA_FULFILLMENT_CUSTOMER_TAXES_DATA_ |
FBA Sales: Remote Fulfillment Eligibility |
_GET_REMOTE_FULFILLMENT_ELIGIBILITY_ |
FBA Inventory: FBA Amazon Fulfilled Inventory Report |
_GET_AFN_INVENTORY_DATA_ |
FBA Inventory: FBA Multi-Country Inventory Report |
_GET_AFN_INVENTORY_DATA_BY_COUNTRY_ |
FBA Inventory: FBA Daily Inventory History Report |
_GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA_ |
FBA Inventory: FBA Monthly Inventory History Report |
_GET_FBA_FULFILLMENT_MONTHLY_INVENTORY_DATA_ |
FBA Inventory: FBA Received Inventory Report |
_GET_FBA_FULFILLMENT_INVENTORY_RECEIPTS_DATA_ |
FBA Inventory: FBA Reserved Inventory Report |
_GET_RESERVED_INVENTORY_DATA_ |
FBA Inventory: FBA Inventory Event Detail Report |
_GET_FBA_FULFILLMENT_INVENTORY_SUMMARY_DATA_ |
FBA Inventory: FBA Inventory Adjustments Report |
_GET_FBA_FULFILLMENT_INVENTORY_ADJUSTMENTS_DATA_ |
FBA Inventory: FBA Inventory Health Report |
_GET_FBA_FULFILLMENT_INVENTORY_HEALTH_DATA_ |
FBA Inventory: FBA Manage Inventory |
_GET_FBA_MYI_UNSUPPRESSED_INVENTORY_DATA_ |
FBA Inventory: FBA Manage Inventory - Archived |
_GET_FBA_MYI_ALL_INVENTORY_DATA_ |
FBA Inventory: Restock Inventory Report |
_GET_RESTOCK_INVENTORY_RECOMMENDATIONS_REPORT_ |
FBA Inventory: FBA Inbound Performance Report |
_GET_FBA_FULFILLMENT_INBOUND_NONCOMPLIANCE_DATA_ |
FBA Inventory: FBA Stranded Inventory Report |
_GET_STRANDED_INVENTORY_UI_DATA_ |
FBA Inventory: FBA Bulk Fix Stranded Inventory Report |
_GET_STRANDED_INVENTORY_LOADER_DATA_ |
FBA Inventory: FBA Inventory Age Report |
_GET_FBA_INVENTORY_AGED_DATA_ |
FBA Inventory: FBA Manage Excess Inventory Report |
_GET_EXCESS_INVENTORY_DATA_ |
FBA Inventory: FBA Storage Fees Report |
_GET_FBA_STORAGE_FEE_CHARGES_DATA_ |
FBA Inventory: Get Report Exchange Data |
_GET_PRODUCT_EXCHANGE_DATA_ |
FBA Inventory: FBA Fee Preview Report |
_GET_FBA_ESTIMATED_FBA_FEES_TXT_DATA_ |
FBA Inventory: FBA Reimbursements Report |
_GET_FBA_REIMBURSEMENTS_DATA_ |
FBA Inventory: FBA Long Term Storage Fee Charges Report |
_GET_FBA_FULFILLMENT_LONGTERM_STORAGE_FEE_CHARGES_DATA_ |
FBA Inventory: FBA Returns Report |
_GET_FBA_FULFILLMENT_CUSTOMER_RETURNS_DATA_ |
FBA Inventory: FBA Replacements Report |
_GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_REPLACEMENT_DATA_ |
FBA Inventory: FBA Recommended Removal Report |
_GET_FBA_RECOMMENDED_REMOVAL_DATA_ |
FBA Inventory: FBA Removal Order Detail Report |
_GET_FBA_FULFILLMENT_REMOVAL_ORDER_DETAIL_DATA_ |
FBA Inventory: FBA Removal Shipment Detail Report |
_GET_FBA_FULFILLMENT_REMOVAL_SHIPMENT_DETAIL_DATA_ |
FBA Inventory: Small and Light Inventory Report |
_GET_FBA_UNO_INVENTORY_DATA_ |
Tax: Sales Tax Report |
_GET_FLAT_FILE_SALES_TAX_DATA_ |
Tax: Amazon VAT Calculation Report |
_SC_VAT_TAX_REPORT_ |
Tax: Amazon VAT Transactions Report |
_GET_VAT_TRANSACTION_DATA_ |
Tax: On Demand GST Merchant Tax Report B2B |
_GET_GST_MTR_B2B_CUSTOM_ |
Tax: On Demand GST Merchant Tax Report B2C |
_GET_GST_MTR_B2C_CUSTOM_ |
Browse Tree: Browse Tree Report |
_GET_XML_BROWSE_TREE_DATA_ |
|
MaxCount |
Maximum number of report requests to return. If you specify a number greater than 100, the request is rejected. Default is 100 if you do not enter.
|
ReportStatus |
A structured list of report processing statuses by which to filter report requests. Default is All
Option |
Value |
_SUBMITTED_ |
_SUBMITTED_ |
_IN_PROGRESS_ |
_IN_PROGRESS_ |
_CANCELLED_ |
_CANCELLED_ |
_DONE_ |
_DONE_ |
_DONE_NO_DATA_ |
_DONE_NO_DATA_ |
|
RequestedFromDate |
The earliest date you are looking for. Date format must be UTC - ISO 8601 format (e.g. 2017-02-10T12:10:02Z)
|
RequestedToDate |
The most recent date you are looking for. Date format must be UTC - ISO 8601 format (e.g. 2017-02-10T12:10:02Z)
|
ReportRequestId |
If you like to check status of specific ReportRequestId then enter here
|
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. [
Read more...]
Parameter |
Description |
Url |
API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
|
Body |
Request Body content goes here
|
IsMultiPart |
Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value)
==== Raw Upload (Content-Type: application/octet-stream) =====
To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip )
==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) =====
To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored.
If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type.
See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored).
file1=@c:\data\Myfile1.txt
file2=@c:\data\Myfile2.json
file2.Content-Type=application/json
SomeField1=aaaaaaa
SomeField1.Content-Type=text/plain
SomeField2=12345
SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab
SomeFieldStartingWithAtSign=\@MyTwitterHandle
|
Filter |
Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Option |
Value |
No filter |
|
Example1 |
$.store.books[*] |
Example2 (Sections Under Books) |
$.store.books[*].sections[*] |
Example3 (Equals) |
$.store.books[?(@author=='sam')] |
Example4 (Equals - Any Section) |
$..[?(@author=='sam')] |
Example5 (Not Equals - Any Section) |
$..[?(@author!='sam')] |
Example6 (Number less than) |
$.store.books[?(@.price<10)]
Example7 (Regular Expression - Contains Pattern)=$.store.books[?(@author=~ /sam|bob/ )] |
Example8 (Regular Expression - Does Not Contain Pattern) |
$.store.books[?(@author=~ /^((?!sam|bob).)*$/ )] |
Example9 (Regular Expression - Exact Pattern Match) |
$.store.books[?(@author=~ /^sam|bob$/ )] |
Example10 (Regular Expression - Starts With) |
$.store.books[?(@author=~ /^sam/ )] |
Example11 (Regular Expression - Ends With) |
$.store.books[?(@author=~ /sam$/ )] |
Example12 (Between) |
$.store.employees[?( @.hiredate>'2015-01-01' && @.hiredate<'2015-01-04' )] |
|
Headers |
Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair
|
Generic Request (Bulk Write)
This is a generic endpoint for bulk write purpose. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. [
Read more...]
Parameter |
Description |
Url |
API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
|
IsMultiPart |
Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value)
==== Raw Upload (Content-Type: application/octet-stream) =====
To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip )
==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) =====
To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored.
If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type.
See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored).
file1=@c:\data\Myfile1.txt
file2=@c:\data\Myfile2.json
file2.Content-Type=application/json
SomeField1=aaaaaaa
SomeField1.Content-Type=text/plain
SomeField2=12345
SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab
SomeFieldStartingWithAtSign=\@MyTwitterHandle
|
Filter |
Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
|
Headers |
Headers for Request. To enter multiple headers use double pipe (||) or new line after each {header-name}:{value} pair
|
Amazon MWS Connector Examples for SQL Server Connection
This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.
Conclusion
In this article we discussed how to connect to Amazon MWS in SQL Server and integrate data without any coding. Click here to Download Amazon MWS Connector for SQL Server and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Download Amazon MWS Connector for SQL Server
Documentation
More integrations
Other application integration scenarios for Amazon MWS
Other connectors for SQL Server
Download Amazon MWS Connector for SQL Server
Documentation
Common Searches:
How to connect Amazon MWS in SQL Server?
How to get Amazon MWS data in SQL Server?
How to read Amazon MWS data in SQL Server?
How to load Amazon MWS data in SQL Server?
How to import Amazon MWS data in SQL Server?
How to pull Amazon MWS data in SQL Server?
How to push data to Amazon MWS in SQL Server?
How to write data to Amazon MWS in SQL Server?
How to POST data to Amazon MWS in SQL Server?
Call Amazon MWS API in SQL Server
Consume Amazon MWS API in SQL Server
Amazon MWS SQL Server Automate
Amazon MWS SQL Server Integration
Integration Amazon MWS in SQL Server
Consume real-time Amazon MWS data in SQL Server
Consume real-time Amazon MWS API data in SQL Server
Amazon MWS ODBC Driver | ODBC Driver for Amazon MWS | ODBC Amazon MWS Driver | SSIS Amazon MWS Source | SSIS Amazon MWS Destination
Connect Amazon MWS in SQL Server
Load Amazon MWS in SQL Server
Load Amazon MWS data in SQL Server
Read Amazon MWS data in SQL Server
Amazon MWS API Call in SQL Server