Introduction
This API supported Amazon Marketplace Web Service(MWS)'s standard REST-style API that accepts/returns JSON requests and Here is the API reference, Click Here
You can testify API through without any installation.
India Marketplace : Amazon MWS Scratchpad - India
US Marketplace : Amazon MWS Scratchpad - US
Other Marketplaces : Amazon MWS endpoints and MarketplaceId values
It does supports EcmaScript 8, TypeScript, async-await, Promises, Callback !
It does also supports for AWS Lambda like serverless cloud function call.
It supports pure JSON response.
All methods support Promise and Callback both.
Please Feel free to create Issue for any help !
All developers/contributors are requested to open Pull Request/Merge Request on development branch. Please make sure Test Cases be passed.
Installation
npm install amazon-mws --save
Debugging
export DEBUG=MWS:*
Usage
export AWS_ACCESS_KEY_ID=KEY
export AWS_SECRET_ACCESS_KEY=SECRET
Configuration Using JavaScript
var amazonMws = require('amazon-mws')('AWS_ACCESS_KEY_ID','AWS_SECRET_ACCESS_KEY');
Configuration Using TypeScript
import * as MwsApi from 'amazon-mws';
const amazonMws = new MwsApi();
amazonMws.setApiKey(accessKey, accessSecret);
Success or Error StatusCode can be obtained directly using StatusCode property of response. It will give you same as what Amazon MWS provides.
It is also sample of the error responses.
{
Type:'Sender',
Code:'InvalidRequestException',
Message:'Invalid xxxxx: ',
Headers: {
'x-mws-quota-max': '',
'x-mws-quota-remaining': '',
'x-mws-quota-resetson': '',
'x-mws-timestamp': '2018-09-05T06:13:00.276Z',
'content-type': 'text/xml',
'content-charset': '',
'content-length': '',
'content-md5': '',
'date': ''
},
StatusCode:400,
RequestId: 'XXXXX-XXXXXX-XXXXX'
}
Additionally all api returns Throttling: Limits to how often you can submit requests
Reference : http://docs.developer.amazonservices.com/en_CA/dev_guide/DG_Throttling.html
{
"x-mws-quota-max": "60.0",
"x-mws-quota-remaining": "38.0",
"x-mws-quota-resetson": "2017-12-08T08:21:00.000Z",
"x-mws-timestamp": "2017-12-08T07:52:15.567Z"
}
Pull Request
- Contributors can send their Pull Request to
developmentbranch. - Kindly validate test cases & linting before opening new PR.
Are you looking for the Amazon MWS Expert Developer?
Are you finding a developer for your world-class product? If yes, please contact here. Submit your project request here. Originally by Full Stack Technology LLP Developers - Drop Mail here and talk with expert developer.
EasyShip
CreateScheduledPackage
const mwsRequestData = {
Version: '2018-09-01',
Action: 'CreateScheduledPackage',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
AmazonOrderId: 'AMAZON_ORDER_ID',
MarketplaceId: 'MARKET_PLACE_ID',
'PackageRequestDetails.PackageDimensions.Length': 'PACKAGE_DIMENSIONS_LENGTH',
'PackageRequestDetails.PackageDimensions.Width': 'PACKAGE_DIMENSIONS_WEIGHT',
'PackageRequestDetails.PackageDimensions.Height': 'PACKAGE_DIMENSIONS_HEIGHT',
'PackageRequestDetails.PackageDimensions.Unit': 'PACKAGE_DIMENSIONS_UNIT',
'PackageRequestDetails.PackageWeight.Unit': 'UNIT',
'PackageRequestDetails.PackageWeight.Value': 'VALUE',
'PackageRequestDetails.PackagePickupSlot.SlotId': 'SLOT_ID',
'PackageRequestDetails.PackagePickupSlot.PickupTimeStart': '2018-02-21',
'PackageRequestDetails.PackagePickupSlot.PickupTimeEnd': '2018-02-21',
'PackageRequestDetails.PackageIdentifier': 'Package_Identifier'
};
try {
const response = await amazonMws.easyShip.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2018-09-01',
Action: 'CreateScheduledPackage',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
AmazonOrderId: 'AMAZON_ORDER_ID',
MarketplaceId: 'MARKET_PLACE_ID',
'PackageRequestDetails.PackageDimensions.Length': 'PACKAGE_DIMENSIONS_LENGTH',
'PackageRequestDetails.PackageDimensions.Width': 'PACKAGE_DIMENSIONS_WEIGHT',
'PackageRequestDetails.PackageDimensions.Height': 'PACKAGE_DIMENSIONS_HEIGHT',
'PackageRequestDetails.PackageDimensions.Unit': 'PACKAGE_DIMENSIONS_UNIT',
'PackageRequestDetails.PackageWeight.Unit': 'UNIT',
'PackageRequestDetails.PackageWeight.Value': 'VALUE',
'PackageRequestDetails.PackagePickupSlot.SlotId': 'SLOT_ID',
'PackageRequestDetails.PackagePickupSlot.PickupTimeStart': '2018-02-21',
'PackageRequestDetails.PackagePickupSlot.PickupTimeEnd': '2018-02-21',
'PackageRequestDetails.PackageIdentifier': 'Package_Identifier'
};
amazonMws.easyShip.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2018-09-01',
Action: 'CreateScheduledPackage',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
AmazonOrderId: 'AMAZON_ORDER_ID',
MarketplaceId: 'MARKET_PLACE_ID',
'PackageRequestDetails.PackageDimensions.Length': 'PACKAGE_DIMENSIONS_LENGTH',
'PackageRequestDetails.PackageDimensions.Width': 'PACKAGE_DIMENSIONS_WEIGHT',
'PackageRequestDetails.PackageDimensions.Height': 'PACKAGE_DIMENSIONS_HEIGHT',
'PackageRequestDetails.PackageDimensions.Unit': 'PACKAGE_DIMENSIONS_UNIT',
'PackageRequestDetails.PackageWeight.Unit': 'UNIT',
'PackageRequestDetails.PackageWeight.Value': 'VALUE',
'PackageRequestDetails.PackagePickupSlot.SlotId': 'SLOT_ID',
'PackageRequestDetails.PackagePickupSlot.PickupTimeStart': '2018-02-21',
'PackageRequestDetails.PackagePickupSlot.PickupTimeEnd': '2018-02-21',
'PackageRequestDetails.PackageIdentifier': 'Package_Identifier'
};
amazonMws.easyShip.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "adb18f0d-2076-48d4-99ef-fb4b9f892a4e"
},
"Result": {
"ScheduledPackage": {
"ScheduledPackageId": {
"AmazonOrderId": "903-1713775-3598252",
"PackageId": "1ab0f06a-9149-87e0-aba9-7098117872d6"
},
"PackageDimensions": {
"Length": "12.00",
"Width": "12.00",
"Height": "12.00",
"Unit": "cm"
},
"PackageWeight": {
"Value": ",23.00",
"Unit": "g"
},
"PackagePickupSlot": {
"SlotId": "Xyt123bbdg=",
"PickupTimeStart": "2018-02-19T14:00:00.50+05:30",
"PickupTimeEnd": "2018-02-19T16:00:00.50+05:30"
},
"PackageStatus": "ReadyForPickup"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Description
Schedules an Amazon Easy Ship package pickup slot. This is a window of time when the seller can expect their package to be picked up for delivery to the buyer. Marks the Amazon Easy Ship order status as WaitingForPickup. You can check the status of Amazon Easy Ship orders by calling the ListOrders operation of the Orders API section and examining the EasyShipShipmentStatus response element. Generates a shipping label and an invoice. Calling CreateScheduledPackage also generates a warranty document if you specify a SerialNumber value.
GetScheduledPackage
const mwsRequestData = {
Version: '2018-09-01',
Action: 'GetScheduledPackage',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ScheduledPackageId.AmazonOrderId': 'AMAZON_ORDER_ID',
'ScheduledPackageId.PackageId': 'PACKAGE_ID',
};
try {
const response = await amazonMws.easyShip.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2018-09-01',
Action: 'GetScheduledPackage',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ScheduledPackageId.AmazonOrderId': 'AMAZON_ORDER_ID',
'ScheduledPackageId.PackageId': 'PACKAGE_ID',
};
amazonMws.easyShip.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2018-09-01',
Action: 'GetScheduledPackage',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ScheduledPackageId.AmazonOrderId': 'AMAZON_ORDER_ID',
'ScheduledPackageId.PackageId': 'PACKAGE_ID',
};
amazonMws.easyShip.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "adb18f0d-2076-48d4-99ef-fb4b9f892a4e"
},
"Result": {
"ScheduledPackage": {
"ScheduledPackageId": {
"AmazonOrderId": "903-1713775-3598252",
"PackageId": "1ab0f06a-9149-87e0-aba9-7098117872d6"
},
"PackageDimensions": {
"Length": "12.00",
"Width": "12.00",
"Height": "12.00",
"Unit": "cm"
},
"PackageWeight": {
"Value": ",23.00",
"Unit": "g"
},
"PackagePickupSlot": {
"SlotId": "Xyt123bbdg=",
"PickupTimeStart": "2018-02-19T14:00:00.50+05:30",
"PickupTimeEnd": "2018-02-19T16:00:00.50+05:30"
},
"PackageStatus": "Scheduled"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Description
The GetScheduledPackage operation returns information about a scheduled package, including dimensions, weight, pickup slot information, invoice and item information, and status.
GetServiceStatus
const mwsRequestData = {
Version: '2018-09-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
};
try {
const response = await amazonMws.easyShip.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2018-09-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
};
amazonMws.easyShip.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2018-09-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
};
amazonMws.easyShip.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "d80c6c7b-f7c7-4fa7-bdd7-854711cb3bcc"
},
"Result": {
"Status": "GREEN",
"Timestamp": "2018-11-05T21:38:09.676Z"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the operational status of the Easy Ship API section.
Description
The GetServiceStatus operation returns the operational status of the Easy Ship API section of Amazon Marketplace Web Service. Status values are GREEN, YELLOW, and RED.
ListPickupSlots
const mwsRequestData = {
Version: '2018-09-01',
Action: 'ListPickupSlots',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
AmazonOrderId: 'AMAZON_ORDER_ID',
MarketplaceId: 'MARKET_PLACE_ID',
'PackageDimensions.Length': 'PACKAGE_DIMENSIONS_LENGTH',
'PackageDimensions.Width': 'PACKAGE_DIMENSIONS_WEIGHT',
'PackageDimensions.Height': 'PACKAGE_DIMENSIONS_HEIGHT',
'PackageDimensions.Unit': 'PACKAGE_DIMENSIONS_UNIT',
'PackageWeight.Unit': 'UNIT',
'PackageWeight.Value': 'VALUE'
};
try {
const response = await amazonMws.easyShip.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2018-09-01',
Action: 'ListPickupSlots',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
AmazonOrderId: 'AMAZON_ORDER_ID',
MarketplaceId: 'MARKET_PLACE_ID',
'PackageDimensions.Length': 'PACKAGE_DIMENSIONS_LENGTH',
'PackageDimensions.Width': 'PACKAGE_DIMENSIONS_WEIGHT',
'PackageDimensions.Height': 'PACKAGE_DIMENSIONS_HEIGHT',
'PackageDimensions.Unit': 'PACKAGE_DIMENSIONS_UNIT',
'PackageWeight.Unit': 'UNIT',
'PackageWeight.Value': 'VALUE'
};
amazonMws.easyShip.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2018-09-01',
Action: 'ListPickupSlots',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
AmazonOrderId: 'AMAZON_ORDER_ID',
MarketplaceId: 'MARKET_PLACE_ID',
'PackageDimensions.Length': 'PACKAGE_DIMENSIONS_LENGTH',
'PackageDimensions.Width': 'PACKAGE_DIMENSIONS_WEIGHT',
'PackageDimensions.Height': 'PACKAGE_DIMENSIONS_HEIGHT',
'PackageDimensions.Unit': 'PACKAGE_DIMENSIONS_UNIT',
'PackageWeight.Unit': 'UNIT',
'PackageWeight.Value': 'VALUE'
};
amazonMws.easyShip.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "adb18f0d-2076-48d4-99ef-fb4b9f892a4e"
},
"Result": {
"AmazonOrderId": "903-1713775-3598252",
"PickupSlotList": {
"PickupSlot": [
{
"SlotId": "Xyt123bbdg=",
"PickupTimeStart": "2018-11-05T14:00:00.50+05:30",
"PickupTimeEnd": "2018-11-05T16:00:00.50+05:30"
},
{
"SlotId": "Byvjdhsdb=",
"PickupTimeStart": "2018-11-05T10:00:00.50+05:30",
"PickupTimeEnd": "2018-11-05T13:59:00.50+05:30"
}
]
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Description
The ListPickupSlots operation returns time slots for Amazon Easy Ship package pickup, based on the package dimensions and package weight that the seller specifies.
UpdateScheduledPackages
const mwsRequestData = {
Version: '2018-09-01',
Action: 'UpdateScheduledPackages',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ScheduledPackageUpdateDetailsList.PackageUpdateDetails.1.ScheduledPackageId.AmazonOrderId': 'AMAZON_ORDER_ID',
'ScheduledPackageUpdateDetailsList.PackageUpdateDetails.1.ScheduledPackageId.PackageId': 'PACKAGE_ID',
'ScheduledPackageUpdateDetailsList.PackageUpdateDetails.1.PackagePickupSlot.SlotId': 'SLOT_ID',
'ScheduledPackageUpdateDetailsList.PackageUpdateDetails.1.PackagePickupSlot.PickupTimeStart': '2018-09-05',
'ScheduledPackageUpdateDetailsList.PackageUpdateDetails.1.PackagePickupSlot.PickupTimeEnd': '2018-09-05'
};
try {
const response = await amazonMws.easyShip.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2018-09-01',
Action: 'UpdateScheduledPackages',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ScheduledPackageUpdateDetailsList.PackageUpdateDetails.1.ScheduledPackageId.AmazonOrderId': 'AMAZON_ORDER_ID',
'ScheduledPackageUpdateDetailsList.PackageUpdateDetails.1.ScheduledPackageId.PackageId': 'PACKAGE_ID',
'ScheduledPackageUpdateDetailsList.PackageUpdateDetails.1.PackagePickupSlot.SlotId': 'SLOT_ID',
'ScheduledPackageUpdateDetailsList.PackageUpdateDetails.1.PackagePickupSlot.PickupTimeStart': '2018-09-05',
'ScheduledPackageUpdateDetailsList.PackageUpdateDetails.1.PackagePickupSlot.PickupTimeEnd': '2018-09-05'
};
amazonMws.easyShip.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2018-09-01',
Action: 'UpdateScheduledPackages',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ScheduledPackageUpdateDetailsList.PackageUpdateDetails.1.ScheduledPackageId.AmazonOrderId': 'AMAZON_ORDER_ID',
'ScheduledPackageUpdateDetailsList.PackageUpdateDetails.1.ScheduledPackageId.PackageId': 'PACKAGE_ID',
'ScheduledPackageUpdateDetailsList.PackageUpdateDetails.1.PackagePickupSlot.SlotId': 'SLOT_ID',
'ScheduledPackageUpdateDetailsList.PackageUpdateDetails.1.PackagePickupSlot.PickupTimeStart': '2018-09-05',
'ScheduledPackageUpdateDetailsList.PackageUpdateDetails.1.PackagePickupSlot.PickupTimeEnd': '2018-09-05'
};
amazonMws.easyShip.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "adb18f0d-2076-48d4-99ef-fb4b9f892a4e"
},
"Result": {
"ScheduledPackageList": {
"Package": {
"ScheduledPackageId": {
"AmazonOrderId": "903-1713775-3598252",
"PackageId": "1ab0f06a-9149-87e0-aba9-7098117872d6"
},
"PackageDimensions": {
"Length": "12.00",
"Width": "12.00",
"Height": "12.00",
"Unit": "cm"
},
"PackageWeight": {
"Value": ",23.00",
"Unit": "g"
},
"PackagePickupSlot": {
"SlotId": "Xyt123bbdg=",
"PickupTimeStart": "2018-11-05T14:00:00.50+05:30",
"PickupTimeEnd": "2018-11-05T16:00:00.50+05:30"
},
"PackageStatus": "Scheduled"
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Description
The UpdateScheduledPackages operation updates the pickup slot of an existing scheduled package. Pass in the ScheduledPackageId value for the scheduled package that the seller wants to change, along with a new SlotId value for the desired scheduled pickup slot.
Feeds
CancelFeedSubmissions
const mwsRequestData = {
Version: '2009-01-01',
Action: 'CancelFeedSubmissions',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'FeedSubmissionIdList.Id.1': 'Feed_Submission_Id_List',
'FeedTypeList.Type.1': 'Feed_Type_List_1',
'FeedTypeList.Type.2': 'Feed_Type_List_2'
};
try {
const response = await amazonMws.feeds.submit(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2009-01-01',
Action: 'CancelFeedSubmissions',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'FeedSubmissionIdList.Id.1': 'Feed_Submission_Id_List',
'FeedTypeList.Type.1': 'Feed_Type_List_1',
'FeedTypeList.Type.2': 'Feed_Type_List_2'
};
amazonMws.feeds.submit(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2009-01-01',
Action: 'CancelFeedSubmissions',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'FeedSubmissionIdList.Id.1': 'Feed_Submission_Id_List',
'FeedTypeList.Type.1': 'Feed_Type_List_1',
'FeedTypeList.Type.2': 'Feed_Type_List_2'
};
amazonMws.feeds.submit(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "18e78983-bbf9-43aa-a661-ae7696cb49d4"
},
"Result": {
"Count": "1",
"FeedSubmissionInfo": {
"FeedSubmissionId": "2291326430",
"FeedType": "_POST_PRODUCT_DATA_",
"SubmittedDate": "2009-02-20T02:10:35+00:00",
"FeedProcessingStatus": "_CANCELLED_"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Cancels one or more feed submissions and returns a count of the feed submissions that were canceled.
Description
The CancelFeedSubmissions operation cancels one or more feed submissions and returns a count of the canceled feed submissions and the feed submission information.
GetFeedSubmissionCount
const mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionCount',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'FeedProcessingStatusList.Status.1': 'DONE',
'FeedProcessingStatusList.Status.2': 'CANCELLED'
};
try {
const response = await amazonMws.feeds.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionCount',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'FeedProcessingStatusList.Status.1': 'DONE',
'FeedProcessingStatusList.Status.2': 'CANCELLED'
};
amazonMws.feeds.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionCount',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'FeedProcessingStatusList.Status.1': 'DONE',
'FeedProcessingStatusList.Status.2': 'CANCELLED'
};
amazonMws.feeds.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "21e482a8-15c7-4da3-91a4-424995ed0756"
},
"Result": {
"Count": "463"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a count of the feeds submitted in the previous 90 days.
Description
The GetFeedSubmissionCount operation returns a count of the total number of feeds submitted in the previous 90 days.
GetFeedSubmissionListByNextToken
const mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionListByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'NEXT_TOKEN'
};
try {
const response = await amazonMws.feeds.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionListByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'NEXT_TOKEN'
};
amazonMws.feeds.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionListByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'NEXT_TOKEN'
};
amazonMws.feeds.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "1105b931-6f1c-4480-8e97-f3b467840a9e"
},
"Result": {
"NextToken": "none",
"HasNext": "false",
"FeedSubmissionInfo": {
"FeedSubmissionId": "2291326430",
"FeedType": "_POST_PRODUCT_DATA_",
"SubmittedDate": "2009-02-20T02:10:35+00:00",
"FeedProcessingStatus": "_SUBMITTED_"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of feed submissions using the NextToken parameter.
Description
The GetFeedSubmissionListByNextToken operation returns a list of feed submissions that match the query parameters. It uses the NextToken, which was supplied in a previous request to either the GetFeedSubmissionListByNextToken operation or the GetFeedSubmissionList operation where the value of HasNext was true.
GetFeedSubmissionList
const mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionList',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
try {
const response = await amazonMws.feeds.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionList',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.feeds.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionList',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.feeds.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "1105b931-6f1c-4480-8e97-f3b467840a9e"
},
"Result": {
"NextToken": "2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=",
"HasNext": "true",
"FeedSubmissionInfo": {
"FeedSubmissionId": "2291326430",
"FeedType": "_POST_PRODUCT_DATA_",
"SubmittedDate": "2009-02-20T02:10:35+00:00",
"FeedProcessingStatus": "_SUBMITTED_"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of all feed submissions submitted in the previous 90 days.
Description
The GetFeedSubmissionList operation returns a list of feed submissions submitted in the previous 90 days that match the query parameters. Use this operation to determine the status of a feed submission by passing in the FeedProcessingId that was returned by the SubmitFeed operation. The GetFeedSubmissionList request can return a maximum of 100 results. If there are additional results to return, HasNext is returned in the response with a true value. To retrieve all the results, you can pass the value of the NextToken parameter to the GetFeedSubmissionListByNextToken operation and repeat until HasNext is false.
GetFeedSubmissionResult
const FeedSubmissionId = '10101010XXX';
const mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionResult',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
FeedSubmissionId: FeedSubmissionId
};
try {
const response = await amazonMws.feeds.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var FeedSubmissionId = '10101010XXX';
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionResult',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
FeedSubmissionId: FeedSubmissionId
};
amazonMws.feeds.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var FeedSubmissionId = '10101010XXX';
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionResult',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
FeedSubmissionId: FeedSubmissionId
};
amazonMws.feeds.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"AmazonEnvelope": {
"xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
"xsi:noNamespaceSchemaLocation": "amzn-envelope.xsd",
"Header": {
"DocumentVersion": "1.02",
"MerchantIdentifier": "T_M_GOOD_83835495"
},
"MessageType": "ProcessingReport",
"Message": {
"MessageID": "1",
"ProcessingReport": {
"DocumentTransactionID": "4319742521"
}
}
},
"ResponseMetadata": {},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the feed processing report and the Content-MD5 header.
Description
The GetFeedSubmissionResult operation returns the feed processing report and the Content-MD5 header for the returned HTTP body. You should compute the MD5 hash of the HTTP body of the report that Amazon MWS returned to you, and compare that with the Content-MD5 header value that is returned. If the computed hash value and the returned hash value do not match, the report body was corrupted during transmission. You should discard the result and automatically retry the request for up to three more times.
GetFeedSubmissionResultCharset
const FeedSubmissionId = '10101010XXX';
const mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionResult',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
FeedSubmissionId: FeedSubmissionId,
// __CHARSET__: 'latin1'
__CHARSET__: 'ISO-8859-1'
};
try {
const response = await amazonMws.feeds.search(mwsRequestData);
console.log('response ', JSON.stringify(response));
} catch (error) {
console.log('error ', error);
}
var FeedSubmissionId = '10101010XXX';
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionResult',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
FeedSubmissionId: FeedSubmissionId,
// __CHARSET__: 'latin1'
__CHARSET__: 'ISO-8859-1'
};
amazonMws.feeds.search(mwsRequestData).then(function (response) {
console.log('response', JSON.stringify(response));
}).catch(function (error) {
console.log('error ', error);
});
var FeedSubmissionId = '10101010XXX';
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionResult',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
FeedSubmissionId: FeedSubmissionId,
// __CHARSET__: 'latin1'
__CHARSET__: 'ISO-8859-1'
};
amazonMws.feeds.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response ', JSON.stringify(response));
});
The above command returns JSON structured like this:
{
"AmazonEnvelope": {
"xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
"xsi:noNamespaceSchemaLocation": "amzn-envelope.xsd",
"Header": {
"DocumentVersion": "1.02",
"MerchantIdentifier": "T_M_GOOD_83835495"
},
"MessageType": "ProcessingReport",
"Message": {
"MessageID": "1",
"ProcessingReport": {
"DocumentTransactionID": "4319742521"
}
}
},
"ResponseMetadata": {},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the feed processing report and the Content-MD5 header.
Description
The GetFeedSubmissionResult operation returns the feed processing report and the Content-MD5 header for the returned HTTP body. You should compute the MD5 hash of the HTTP body of the report that Amazon MWS returned to you, and compare that with the Content-MD5 header value that is returned. If the computed hash value and the returned hash value do not match, the report body was corrupted during transmission. You should discard the result and automatically retry the request for up to three more times.
GetFeedSubmissionResultRaw
const FeedSubmissionId = '10101010XXX';
const mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionResult',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
FeedSubmissionId: FeedSubmissionId,
__RAW__: true
};
try {
const response = await amazonMws.feeds.search(mwsRequestData);
fse.writeFileSync('response.txt', response.data);
console.log('Headers', response.Headers);
} catch (error) {
console.log('error ', error);
}
var FeedSubmissionId = '10101010XXX';
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionResult',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
FeedSubmissionId: FeedSubmissionId,
__RAW__: true
};
amazonMws.feeds.search(mwsRequestData).then(function (response) {
fse.writeFileSync('response.txt', response.data);
console.log('Headers', response.Headers);
}).catch(function (error) {
console.log('error ', error);
});
var FeedSubmissionId = '10101010XXX';
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetFeedSubmissionResult',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
FeedSubmissionId: FeedSubmissionId,
__RAW__: true
};
amazonMws.feeds.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
fse.writeFileSync('response.txt', response.data);
console.log('Headers', response.Headers);
});
The above command returns JSON structured like this:
{
"AmazonEnvelope": {
"xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
"xsi:noNamespaceSchemaLocation": "amzn-envelope.xsd",
"Header": {
"DocumentVersion": "1.02",
"MerchantIdentifier": "T_M_GOOD_83835495"
},
"MessageType": "ProcessingReport",
"Message": {
"MessageID": "1",
"ProcessingReport": {
"DocumentTransactionID": "4319742521"
}
}
},
"ResponseMetadata": {},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the feed processing report and the Content-MD5 header.
Description
The GetFeedSubmissionResult operation returns the feed processing report and the Content-MD5 header for the returned HTTP body. You should compute the MD5 hash of the HTTP body of the report that Amazon MWS returned to you, and compare that with the Content-MD5 header value that is returned. If the computed hash value and the returned hash value do not match, the report body was corrupted during transmission. You should discard the result and automatically retry the request for up to three more times.
SubmitFeed
const FeedContent = fse.readFileSync('./good.xml', 'UTF-8');
console.log('FeedContent ', FeedContent);
const mwsRequestData = {
Version: '2009-01-01',
Action: 'SubmitFeed',
FeedType: '_POST_PRODUCT_DATA_',
FeedContent: FeedContent,
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
try {
const response = await amazonMws.feeds.submit(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var FeedContent = fse.readFileSync('./good.xml', 'UTF-8');
console.log('FeedContent ', FeedContent);
var mwsRequestData = {
Version: '2009-01-01',
Action: 'SubmitFeed',
FeedType: '_POST_PRODUCT_DATA_',
FeedContent: FeedContent,
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.feeds.submit(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var FeedContent = fse.readFileSync('../good.xml', 'UTF-8');
console.log('FeedContent ', FeedContent);
var mwsRequestData = {
Version: '2009-01-01',
Action: 'SubmitFeed',
FeedType: '_POST_PRODUCT_DATA_',
FeedContent: FeedContent,
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.feeds.submit(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "75424a38-f333-4105-98f0-2aa9592d665c"
},
"Result": {
"FeedSubmissionInfo": {
"FeedSubmissionId": "2291326430",
"FeedType": "_POST_PRODUCT_DATA_",
"SubmittedDate": "2009-02-20T02:10:35+00:00",
"FeedProcessingStatus": "_SUBMITTED_"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Uploads a feed for processing by Amazon MWS.
Description
The SubmitFeed operation uploads a file and any necessary metadata for processing. Feed size must be below 2 GiB (231, or 2,147,483,648 bytes) per feed. If you have a large amount of data to submit, you should submit feeds smaller than the feed size limit by breaking up the data, or submit the feeds over a period of time. For optimal performance, a good practice is to submit feeds with a size limit of 30,000 records/items, or submit feeds over a period of time, such as every few hours.
SubmitFeedUploadVatInvoice
const FeedContent = fse.readFileSync('./invoice.pdf', 'UTF-8');
console.log('FeedContent ', FeedContent);
const mwsRequestData = {
Version: '2009-01-01',
Action: 'SubmitFeed',
FeedType: '_UPLOAD_VAT_INVOICE_',
FeedContent: FeedContent,
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'MarketplaceIdList.Id.1': 'MarketplaceIdList.Id.1',
'metadata.OrderId': 'OrderId',
'metadata.InvoiceNumber': 'InvoiceNumber',
'metadata.TotalAmount': 'TotalAmount',
'metadata.VATAmount': 'VATAmount',
'metadata.DocumentType': 'DocumentType', //'Invoice' , 'CreditNote'
};
try {
const response = await amazonMws.feeds.submit(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var FeedContent = fse.readFileSync('./invoice.pdf', 'UTF-8');
console.log('FeedContent ', FeedContent);
var mwsRequestData = {
Version: '2009-01-01',
Action: 'SubmitFeed',
FeedType: '_UPLOAD_VAT_INVOICE_',
FeedContent: FeedContent,
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'MarketplaceIdList.Id.1': 'MarketplaceIdList.Id.1',
'metadata.OrderId': 'OrderId',
'metadata.InvoiceNumber': 'InvoiceNumber',
'metadata.TotalAmount': 'TotalAmount',
'metadata.VATAmount': 'VATAmount',
'metadata.DocumentType': 'DocumentType', //'Invoice' , 'CreditNote'
};
amazonMws.feeds.submit(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var FeedContent = fse.readFileSync('./invoice.pdf', 'UTF-8');
console.log('FeedContent ', FeedContent);
var mwsRequestData = {
Version: '2009-01-01',
Action: 'SubmitFeed',
FeedType: '_UPLOAD_VAT_INVOICE_',
FeedContent: FeedContent,
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'MarketplaceIdList.Id.1': 'MarketplaceIdList.Id.1',
'metadata.OrderId': 'OrderId',
'metadata.InvoiceNumber': 'InvoiceNumber',
'metadata.TotalAmount': 'TotalAmount',
'metadata.VATAmount': 'VATAmount',
'metadata.DocumentType': 'DocumentType', //'Invoice' , 'CreditNote'
};
amazonMws.feeds.submit(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "75424a38-f333-4105-98f0-2aa9592d665c"
},
"Result": {
"FeedSubmissionInfo": {
"FeedSubmissionId": "2291326430",
"FeedType": "_UPLOAD_VAT_INVOICE_",
"SubmittedDate": "2009-02-20T02:10:35+00:00",
"FeedProcessingStatus": "_SUBMITTED_"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Uploads a feed for processing by Amazon MWS.
Description
The SubmitFeed operation uploads a file and any necessary metadata for processing. Feed size must be below 2 GiB (231, or 2,147,483,648 bytes) per feed. If you have a large amount of data to submit, you should submit feeds smaller than the feed size limit by breaking up the data, or submit the feeds over a period of time. For optimal performance, a good practice is to submit feeds with a size limit of 30,000 records/items, or submit feeds over a period of time, such as every few hours.
Finances
ListFinancialEventGroups
const mwsRequestData = {
Version: '2015-05-01',
Action: 'ListFinancialEventGroups',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
FinancialEventGroupStartedAfter: new Date(2016, 11, 24)
};
try {
const response = await amazonMws.finances.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2015-05-01',
Action: 'ListFinancialEventGroups',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
FinancialEventGroupStartedAfter: new Date(2016, 11, 24)
};
amazonMws.finances.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2015-05-01',
Action: 'ListFinancialEventGroups',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
FinancialEventGroupStartedAfter: new Date(2016, 11, 24)
};
amazonMws.finances.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "1105b931-6f1c-4480-8e97-f3b46EXAMPLE"
},
"Result": {
"NextToken": "2YgYW55IGNhcm5hbCBwbGVhcEXAMPLE",
"FinancialEventGroupList": {
"FinancialEventGroup": {
"FinancialEventGroupId": "22YgYW55IGNhcm5hbCBwbGVhEXAMPLE",
"ProcessingStatus": "Closed",
"FundTransferStatus": "Successful",
"OriginalTotal": {
"CurrencyCode": "USD",
"Amount": "19.00"
},
"ConvertedTotal": {
"CurrencyCode": "USD",
"Amount": "19.00"
},
"FundTransferDate": "2014-09-09T01:30:00.000-06:00",
"TraceId": "128311029381HSADJEXAMPLE",
"AccountTail": "1212",
"BeginningBalance": {
"CurrencyCode": "USD",
"Amount": "0.00"
},
"FinancialEventGroupStart": "2014-09-01T01:30:00.000-06:00",
"FinancialEventGroupEnd": "2014-09-09T01:30:00.000-06:00"
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns financial event groups for a given date range.
Description
The ListFinancialEventGroups operation returns a list of financial event groups opened during a time frame specified by the FinancialEventGroupStartedAfter or the FinancialEventGroupStartedBefore request parameters.
ListFinancialEventGroupsByNextToken
const mwsRequestData = {
Version: '2015-05-01',
Action: 'ListFinancialEventGroupsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'NEXT_TOKEN'
};
try {
const response = await amazonMws.finances.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2015-05-01',
Action: 'ListFinancialEventGroupsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'NEXT_TOKEN'
};
amazonMws.finances.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2015-05-01',
Action: 'ListFinancialEventGroupsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'NEXT_TOKEN'
};
amazonMws.finances.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "1105b931-6f1c-4480-8e97-f3b46EXAMPLE"
},
"Result": {
"NextToken": "2YgYW55IGNhcm5hbCBwbGVhcEXAMPLE",
"FinancialEventGroupList": {
"FinancialEventGroup": {
"FinancialEventGroupId": "22YgYW55IGNhcm5hbCBwbGVhEXAMPLE",
"ProcessingStatus": "Closed",
"FundTransferStatus": "Successful",
"OriginalTotal": {
"CurrencyCode": "USD",
"Amount": "19.00"
},
"ConvertedTotal": {
"CurrencyCode": "USD",
"Amount": "19.00"
},
"FundTransferDate": "2014-09-09T01:30:00.000-06:00",
"TraceId": "128311029381HSADJEXAMPLE",
"AccountTail": "1212",
"BeginningBalance": {
"CurrencyCode": "USD",
"Amount": "0.00"
},
"FinancialEventGroupStart": "2014-09-01T01:30:00.000-06:00",
"FinancialEventGroupEnd": "2014-09-09T01:30:00.000-06:00"
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the next page of financial event groups using the NextToken parameter.
Description
The ListFinancialEventGroupsByNextToken operation returns the next page of financial event groups using the NextToken value that was returned by your previous request to either ListFinancialEventGroups or ListFinancialEventGroupsByNextToken. If NextToken is not returned, there are no more pages to return. Event groups opened more than 18 months before the current date are not returned.
ListFinancialEvents
const mwsRequestData = {
Version: '2015-05-01',
Action: 'ListFinancialEvents',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
AmazonOrderId: 'Amazon_Order_Id'
};
try {
const response = await amazonMws.finances.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2015-05-01',
Action: 'ListFinancialEvents',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
AmazonOrderId: 'Amazon_Order_Id'
};
amazonMws.finances.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2015-05-01',
Action: 'ListFinancialEvents',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
AmazonOrderId: 'Amazon_Order_Id'
};
amazonMws.finances.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "6a2929e5-5c77-470e-ad71-36f30bfaffcc"
},
"Result": {
"FinancialEvents": {
"ProductAdsPaymentEventList": [
{},
{
"ProductAdsPaymentEvent": {
"PostedDate": "2017-01-11T13:17:15.000Z",
"transactionType": "Charge",
"invoiceId": "TR1W0B4YB-6",
"baseValue": {
"CurrencyAmount": "115.34",
"CurrencyCode": "USD"
},
"taxValue": {
"CurrencyAmount": "21.91",
"CurrencyCode": "USD"
},
"transactionValue": {
"CurrencyAmount": "137.25",
"CurrencyCode": "USD"
}
}
}
],
"RentalTransactionEventList": {},
"PayWithAmazonEventList": {},
"ServiceFeeEventList": {},
"ServiceProviderCreditEventList": {},
"SellerDealPaymentEventList": {
"SellerDealPaymentEvent": {
"PostedDate": "2016-11-21T16:18:15.000Z",
"DealDescription": "test fees",
"DealId": "fec11097c1f4379426a7de68bf938b684f677de2",
"EventType": "SellerDealComplete",
"FeeType": "RunLightningDealFee",
"FeeAmount": {
"CurrencyAmount": "16.38",
"CurrencyCode": "USD"
},
"TaxAmount": {
"CurrencyAmount": "3.18",
"CurrencyCode": "USD"
}
}
},
"DebtRecoveryEventList": {},
"ShipmentEventList": {
"ShipmentEvent": {
"ShipmentItemList": {
"ShipmentItem": {
"ItemChargeList": {
"ChargeComponent": [
{
"ChargeType": "Principal",
"ChargeAmount": {
"CurrencyAmount": "25.99",
"CurrencyCode": "USD"
}
},
{
"ChargeType": "Tax",
"ChargeAmount": {
"CurrencyAmount": "0.0",
"CurrencyCode": "USD"
}
}
]
},
"ItemFeeList": {
"FeeComponent": [
{
"FeeType": "ShippingChargeback",
"FeeAmount": {
"CurrencyAmount": "0.0",
"CurrencyCode": "USD"
}
},
{
"FeeType": "VariableClosingFee",
"FeeAmount": {
"CurrencyAmount": "0.0",
"CurrencyCode": "USD"
}
}
]
},
"OrderItemId": "46432915698730",
"QuantityShipped": "1",
"SellerSKU": "HS223A-C00"
}
},
"AmazonOrderId": "105-0457358-1245022",
"PostedDate": "2017-01-23T01:31:25Z",
"MarketplaceName": "Amazon.com",
"SellerOrderId": "105-0457358-1245022"
}
},
"AffordabilityExpenseEventList": {
"AffordabilityExpenseEvent": {
"PostedDate": "2018-02-08T13:17:15.000Z",
"TransactionType": "Charge",
"AmazonOrderId": "931-2463294-5740665",
"MarketplaceId": "A2XZLSVIQ0F4JT",
"BaseExpense": {
"CurrencyAmount": "-100.00",
"CurrencyCode": "INR"
},
"TaxTypeIGST": {
"CurrencyAmount": "-18.00",
"CurrencyCode": "INR"
},
"TaxTypeSGST": {
"CurrencyAmount": "0.00",
"CurrencyCode": "INR"
},
"TaxTypeCGST": {
"CurrencyAmount": "0.00",
"CurrencyCode": "INR"
},
"TotalExpense": {
"CurrencyAmount": "-118.00",
"CurrencyCode": "INR"
}
}
},
"RetrochargeEventList": {},
"GuaranteeClaimEventList": {},
"ChargebackEventList": {},
"LoanServicingEventList": {},
"RefundEventList": {},
"AdjustmentEventList": {},
"PerformanceBondRefundEventList": {},
"AffordabilityExpenseReversalEventList": {
"AffordabilityExpenseReversalEvent": {
"PostedDate": "2018-02-08T13:17:15.000Z",
"TransactionType": "Refund",
"AmazonOrderId": "931-2463294-5740665",
"MarketplaceId": "A2XZLSVIQ0F4JT",
"BaseExpense": {
"CurrencyAmount": "100.00",
"CurrencyCode": "INR"
},
"TaxTypeIGST": {
"CurrencyAmount": "18.00",
"CurrencyCode": "INR"
},
"TaxTypeSGST": {
"CurrencyAmount": "0.00",
"CurrencyCode": "INR"
},
"TaxTypeCGST": {
"CurrencyAmount": "0.00",
"CurrencyCode": "INR"
},
"TotalExpense": {
"CurrencyAmount": "118.00",
"CurrencyCode": "INR"
}
}
},
"TDSReimbursementEventList": {
"TDSReimbursementEvent": {
"ReimbursedAmount": {
"CurrencyCode": "INR",
"CurrencyAmount": "3.98"
},
"PostedDate": "2019-08-01T16:18:15.000Z",
"TdsOrderId": "TDS-1235"
}
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns financial events for a given order, financial event group, or date range.
Description
The ListFinancialEvents operation returns a list of financial events that matches the filter specified in the request. You can filter by financial event group ID, date range, or order ID. If you specify a financial event group ID in the request, then all financial events in that financial event group are returned. If you specify a time range in the request, then all financial events that are posted between the time ranges are returned. If you specify an order ID in the request, then all financial events that are part of the order are returned.
ListFinancialEventsByNextToken
const mwsRequestData = {
Version: '2015-05-01',
Action: 'ListFinancialEventsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'Next_Token'
};
try {
const response = await amazonMws.finances.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2015-05-01',
Action: 'ListFinancialEventsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'Next_Token'
};
amazonMws.finances.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2015-05-01',
Action: 'ListFinancialEventsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'Next_Token'
};
amazonMws.finances.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "c07d1dd2-12f9-415f-a167-8ab5f7726dbf"
},
"Result": {
"NextToken": "e21hcmtldHBsYWNlSWQ6bnVsbCxtYXhSZXN1bHRzUGVyUGFnZTowLHNlYXJjaFF1ZXJ5Q2hlY2tzdW06bnVsbCxxdWVyeVBhZ2luYXRpb25Ub2tlbjoidDB3V25MNXFLWkRIZ2p5ZzB3ZHRWODVnV0htVExVMkM0XzlsMHpRMG9HVXFZOVhTdjFyWUNWUE8teGxWRnF3N0ZyaDIyY3lQX0VTOXYxendQNUVvc0t0V1NKM1YyQkRJdWcyWFpXdm1KVmdPVktBdzNIMXUyVHBiTGoxVmRmY3Z6ZlU1WlpNaEpsQ0RKUnYxRk16am13Y1YyQ1BoOXNWMU1xNUZqamxUMlRCeFBkSjdEa3BkbENISElVZ094aHVTN3ZfZlFCUWYyWWJYZ2l3NHNxZXkwNnQyaVBucm5PdnAzRTdKbW4xcnc1UTlaTGV1Ymk5WUV6UGJ6UnhjRmh2VUFKdlQ5U2U3eERIdHVMUzNJVWFRODBubVhja3JLeWt3dVZKeWZXQm5CY3p0bjZTbVRHenJmZ1VOanFMWFFNT2giLHNlYXJjaFF1ZXJ5Om51bGwsdG9rZW5DcmVhdGlvbkRhdGU6MTQ4NTg2MjY5ODI1NCxzZWxsZXJJZDoiQTM1SlMxREpITjdGViJ9",
"FinancialEvents": {
"ProductAdsPaymentEventList": [
{},
{
"ProductAdsPaymentEvent": {
"PostedDate": "2017-01-11T13:17:15.000Z",
"transactionType": "Charge",
"invoiceId": "TR1W0B4YB-6",
"baseValue": {
"CurrencyAmount": "115.34",
"CurrencyCode": "USD"
},
"taxValue": {
"CurrencyAmount": "21.91",
"CurrencyCode": "USD"
},
"transactionValue": {
"CurrencyAmount": "137.25",
"CurrencyCode": "USD"
}
}
}
],
"RentalTransactionEventList": {},
"PayWithAmazonEventList": {},
"SellerDealPaymentEventList": [
{
"SellerDealPaymentEvent": {
"PostedDate": "2016-11-21T16:18:15.000Z",
"DealDescription": "test fees",
"DealId": "fec11097c1f4379426a7de68bf938b684f677de2",
"EventType": "SellerDealComplete",
"FeeType": "RunLightningDealFee",
"FeeAmount": {
"CurrencyAmount": "16.38",
"CurrencyCode": "USD"
},
"TaxAmount": {
"CurrencyAmount": "3.18",
"CurrencyCode": "USD"
}
}
},
{}
],
"AffordabilityExpenseEventList": {
"AffordabilityExpenseEvent": {
"PostedDate": "2018-02-08T13:17:15.000Z",
"TransactionType": "Charge",
"AmazonOrderId": "931-2463294-5740665",
"MarketplaceId": "A2XZLSVIQ0F4JT",
"BaseExpense": {
"CurrencyAmount": "-100.00",
"CurrencyCode": "INR"
},
"TaxTypeIGST": {
"CurrencyAmount": "-18.00",
"CurrencyCode": "INR"
},
"TaxTypeSGST": {
"CurrencyAmount": "0.00",
"CurrencyCode": "INR"
},
"TaxTypeCGST": {
"CurrencyAmount": "0.00",
"CurrencyCode": "INR"
},
"TotalExpense": {
"CurrencyAmount": "-118.00",
"CurrencyCode": "INR"
}
}
},
"ServiceFeeEventList": {
"ServiceFeeEvent": [
{
"FeeDescription": "Shacke Luggage Tags with Full Back Privacy Cover w/ Steel Loops - Set of 2
(Green)",
"SellerSKU": "FH-REED-16DX"
},
{
"FeeDescription": "Shacke Luggage Tags with Full Back Privacy Cover w/ Steel Loops - Set of 2
(Green)",
"SellerSKU": "FH-REED-16DX",
"FeeList": {
"FeeComponent": [
{
"FeeType": "FBACustomerReturnPerOrderFee",
"FeeAmount": {
"CurrencyAmount": "-1.0",
"CurrencyCode": "USD"
}
},
{
"FeeType": "FBACustomerReturnPerUnitFee",
"FeeAmount": {
"CurrencyAmount": "-1.06",
"CurrencyCode": "USD"
}
},
{
"FeeType": "FBACustomerReturnWeightBasedFee",
"FeeAmount": {
"CurrencyAmount": "-0.5",
"CurrencyCode": "USD"
}
}
]
}
}
]
},
"AffordabilityExpenseReversalEventList": {
"AffordabilityExpenseReversalEvent": {
"PostedDate": "2018-02-08T13:17:15.000Z",
"TransactionType": "Refund",
"AmazonOrderId": "931-2463294-5740665",
"MarketplaceId": "A2XZLSVIQ0F4JT",
"BaseExpense": {
"CurrencyAmount": "100.00",
"CurrencyCode": "INR"
},
"TaxTypeIGST": {
"CurrencyAmount": "18.00",
"CurrencyCode": "INR"
},
"TaxTypeSGST": {
"CurrencyAmount": "0.00",
"CurrencyCode": "INR"
},
"TaxTypeCGST": {
"CurrencyAmount": "0.00",
"CurrencyCode": "INR"
},
"TotalExpense": {
"CurrencyAmount": "118.00",
"CurrencyCode": "INR"
}
}
},
"ServiceProviderCreditEventList": {},
"DebtRecoveryEventList": {},
"AdjustmentEventList": {
"AdjustmentEvent": {
"AdjustmentItemList": {
"AdjustmentItem": {
"PerUnitAmount": {
"CurrencyAmount": "3.38",
"CurrencyCode": "USD"
},
"TotalAmount": {
"CurrencyAmount": "3.38",
"CurrencyCode": "USD"
},
"Quantity": "1",
"SellerSKU": "KL-BPYA-C1VH",
"ProductDescription": "Shacke Metal Shoe Horn 7.5\" inches - Double Sided Stainless
Steel (Silver)"
}
},
"AdjustmentType": "REVERSAL_REIMBURSEMENT"
}
},
"PerformanceBondRefundEventList": {}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the next page of financial events using the NextToken parameter.
Description
The ListFinancialEventsByNextToken operation returns the next page of financial events using the NextToken value that was returned by your previous request to either ListFinancialEvents or ListFinancialEventsByNextToken. If NextToken is not returned, there are no more pages to return.
GetServiceStatus
const mwsRequestData = {
Version: '2015-05-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
try {
const response = await amazonMws.finances.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2015-05-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.finances.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2015-05-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.finances.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "082c41fd-2f6b-4616-a518-7db14EXAMPLE"
},
"Result": {
"Status": "GREEN",
"Timestamp": "2015-05-01T18:12:21.687Z"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the operational status of the Finances API section.
Description
The GetServiceStatus operation returns the operational status of the Finances API section of Amazon Marketplace Web Service (Amazon MWS). Status values are GREEN, YELLOW, and RED. The GetServiceStatus operation has a maximum request quota of two and a restore rate of one request every five minutes.
FulfillmentInboundShipment
ConfirmPreorder
const mwsRequestData = {
Version: '2010-10-01',
Action: 'ConfirmPreorder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id',
NeedByDate: '2015-12-27'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ConfirmPreorder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id',
NeedByDate: '2015-12-27'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ConfirmPreorder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id',
NeedByDate: '2015-12-27'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "4a1a7029-462b-4a27-a04c-4cbe0fd107e3"
},
"Result": {
"ConfirmedNeedByDate": "2015-12-27",
"ConfirmedFulfillableDate": "2015-12-31"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Confirms a shipment for pre-order.
Description
The ConfirmPreorder operation confirms a shipment for pre-order. Call this operation after calling the GetPreorderInfo operation to get the NeedByDate value and other pre-order information about the shipment. To get a list of shipments that are confirmed for pre-order, call the ListInboundShipments operation and sort the result set by the ConfirmedNeedByDate response element. After a shipment is confirmed for pre-order, the pre-order Buy Box displays for all of the items in the shipment with release dates on or after the date in the ConfirmedFulfillableDate response element. A shipment that is confirmed for pre-order must arrive at an Amazon fulfillment center by the date in the ConfirmedNeedByDate response element to avoid promise breaks.
GetInboundGuidanceForSKU
const mwsRequestData = {
Version: '2010-10-01',
Action: 'GetInboundGuidanceForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'SellerSKUList.Id.1': 'us001'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetInboundGuidanceForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'SellerSKUList.Id.1': 'us001'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetInboundGuidanceForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'SellerSKUList.Id.1': 'us001'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "d80c6c7b-f7c7-4fa7-bdd7-854711cb3bcc"
},
"Result": {
"SKUInboundGuidanceList": {
"SellerSKU": "us001",
"ASIN": "B00005N5PF",
"InboundGuidance": "InboundNotRecommended",
"GuidanceReasonList": {
"GuidanceReason": "SlowMovingASIN"
}
},
"InvalidSKUList": {}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns inbound guidance for a list of items by Seller SKU.
Description
The GetInboundGuidanceForSKU operation lets a seller know if Amazon recommends sending an item to a given marketplace. In some cases, Amazon provides guidance for why a given Seller SKU is not recommended for shipment to Amazon's fulfillment network. Sellers may still ship items that are not recommended, at their discretion.
GetInboundGuidanceForASIN
const mwsRequestData = {
Version: '2010-10-01',
Action: 'GetInboundGuidanceForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ASINList.Id.1': 'ASIN_List_Id'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetInboundGuidanceForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ASINList.Id.1': 'ASIN_List_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetInboundGuidanceForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ASINList.Id.1': 'ASIN_List_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "d80c6c7b-f7c7-4fa7-bdd7-854711cb3bcc"
},
"Result": {
"ASINInboundGuidanceList": {
"ASIN": "B00005N5PF",
"InboundGuidance": "InboundNotRecommended",
"GuidanceReasonList": {
"GuidanceReason": "SlowMovingASIN"
}
},
"InvalidASINList": {}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns inbound guidance for a list of items by ASIN.
Description
The GetInboundGuidanceForASIN operation lets a seller know if Amazon recommends sending a product to a given marketplace. In some cases, Amazon provides guidance for why a given ASIN is not recommended for shipment to Amazon's fulfillment network.
CreateInboundShipmentPlan
const mwsRequestData = {
Version: '2010-10-01',
Action: 'CreateInboundShipmentPlan',
SellerId: 'SELLER_ID',
LabelPrepPreference: 'Label_Prep_Preference',
'ShipFromAddress.Name': 'Name',
'ShipFromAddress.AddressLine1': 'AddressLine',
'ShipFromAddress.City': 'City',
'ShipFromAddress.StateOrProvinceCode': 'State_Or_Province_Code',
'ShipFromAddress.PostalCode': 'Postal_Code',
'ShipFromAddress.CountryCode': 'Country_Code',
'InboundShipmentPlanRequestItems.member.1.SellerSKU': 'Seller_Sku',
'InboundShipmentPlanRequestItems.member.1.Quantity': 'Quantity',
'InboundShipmentPlanRequestItems.member.1.PrepDetailsList.member.1.PrepInstruction': 'Prep_Instruction',
'InboundShipmentPlanRequestItems.member.1.PrepDetailsList.member.1.PrepOwner': 'Prep_Owner'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'CreateInboundShipmentPlan',
SellerId: 'SELLER_ID',
LabelPrepPreference: 'Label_Prep_Preference',
'ShipFromAddress.Name': 'Name',
'ShipFromAddress.AddressLine1': 'AddressLine',
'ShipFromAddress.City': 'City',
'ShipFromAddress.StateOrProvinceCode': 'State_Or_Province_Code',
'ShipFromAddress.PostalCode': 'Postal_Code',
'ShipFromAddress.CountryCode': 'Country_Code',
'InboundShipmentPlanRequestItems.member.1.SellerSKU': 'Seller_Sku',
'InboundShipmentPlanRequestItems.member.1.Quantity': 'Quantity',
'InboundShipmentPlanRequestItems.member.1.PrepDetailsList.member.1.PrepInstruction': 'Prep_Instruction',
'InboundShipmentPlanRequestItems.member.1.PrepDetailsList.member.1.PrepOwner': 'Prep_Owner'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'CreateInboundShipmentPlan',
SellerId: 'SELLER_ID',
LabelPrepPreference: 'Label_Prep_Preference',
'ShipFromAddress.Name': 'Name',
'ShipFromAddress.AddressLine1': 'AddressLine',
'ShipFromAddress.City': 'City',
'ShipFromAddress.StateOrProvinceCode': 'State_Or_Province_Code',
'ShipFromAddress.PostalCode': 'Postal_Code',
'ShipFromAddress.CountryCode': 'Country_Code',
'InboundShipmentPlanRequestItems.member.1.SellerSKU': 'Seller_Sku',
'InboundShipmentPlanRequestItems.member.1.Quantity': 'Quantity',
'InboundShipmentPlanRequestItems.member.1.PrepDetailsList.member.1.PrepInstruction': 'Prep_Instruction',
'InboundShipmentPlanRequestItems.member.1.PrepDetailsList.member.1.PrepOwner': 'Prep_Owner'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "babd156d-8b2f-40b1-a770-d117f9ccafef"
},
"Result": {
"InboundShipmentPlans": {
"member": {
"DestinationFulfillmentCenterId": "ABE2",
"LabelPrepType": "SELLER_LABEL",
"ShipToAddress": {
"City": "Breinigsville",
"CountryCode": "US",
"PostalCode": "18031",
"Name": "Amazon.com",
"AddressLine1": "705 Boulder Drive",
"StateOrProvinceCode": "PA"
},
"EstimatedBoxContentsFee": {
"TotalUnits": "10",
"FeePerUnit": {
"Value": ",0.10",
"CurrencyCode": "USD"
},
"TotalFee": {
"Value": ",10.0",
"CurrencyCode": "USD"
}
},
"Items": {
"member": {
"FulfillmentNetworkSKU": "FNSKU00001",
"Quantity": "1",
"SellerSKU": "SKU00001",
"PrepDetailsList": {
"PrepDetails": {
"PrepInstruction": "Taping",
"PrepOwner": "AMAZON"
}
}
}
},
"ShipmentId": "FBA0000001"
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the information required to create an inbound shipment.
Description
The CreateInboundShipmentPlan operation returns one or more inbound shipment plans, which provide the information you need to create one or more inbound shipments for a set of items that you specify. Multiple inbound shipment plans might be required so that items can be optimally placed in Amazon's fulfillment network—for example, positioning inventory closer to the customer. Alternatively, two inbound shipment plans might be created with the same Amazon fulfillment center destination if the two shipment plans require different processing—for example, items that require labels must be shipped separately from stickerless, commingled inventory.
CreateInboundShipment
const mwsRequestData = {
Version: '2010-10-01',
Action: 'CreateInboundShipment',
SellerId: 'SELLER_ID',
ShipmentId: 'Shipment_Id',
'InboundShipmentHeader.ShipmentName': 'SHIPMENT_NAME',
'InboundShipmentHeader.ShipFromAddress.Name': 'NAME',
'InboundShipmentHeader.ShipFromAddress.AddressLine1': 'Address_Line1',
'InboundShipmentHeader.ShipFromAddress.City': 'City',
'InboundShipmentHeader.ShipFromAddress.StateOrProvinceCode': 'State_Or_Province_Code',
'InboundShipmentHeader.ShipFromAddress.PostalCode': 'Postal_Code',
'InboundShipmentHeader.ShipFromAddress.CountryCode': 'Country_Code',
'InboundShipmentHeader.DestinationFulfillmentCenterId': 'Destination_Fulfillment_Center_Id',
'InboundShipmentHeader.ShipmentStatus': 'Shipment_Status',
'InboundShipmentHeader.LabelPrepPreference': 'Label_Prep_Preference',
'InboundShipmentHeader.IntendedBoxContentsSource': 'Intended_Box_Contents_Source',
'InboundShipmentItems.member.1.QuantityShipped': 'Quantity_Shipped_1',
'InboundShipmentItems.member.1.SellerSKU': 'Seller_Sku_1',
'InboundShipmentItems.member.1.PrepDetailsList.member.1.PrepInstruction': 'Prep_Instruction_1',
'InboundShipmentItems.member.1.PrepDetailsList.member.1.PrepOwner': 'Prep_Owner_1',
'InboundShipmentItems.member.2.QuantityShipped': 'Quantity_Shipped_2',
'InboundShipmentItems.member.2.SellerSKU': 'Seller_Sku_2',
'InboundShipmentItems.member.2.PrepDetailsList.member.1.PrepInstruction': 'Prep_Instruction_2',
'InboundShipmentItems.member.2.PrepDetailsList.member.1.PrepOwner': 'Prep_Owner_2',
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'CreateInboundShipment',
SellerId: 'SELLER_ID',
ShipmentId: 'Shipment_Id',
'InboundShipmentHeader.ShipmentName': 'SHIPMENT_NAME',
'InboundShipmentHeader.ShipFromAddress.Name': 'NAME',
'InboundShipmentHeader.ShipFromAddress.AddressLine1': 'Address_Line1',
'InboundShipmentHeader.ShipFromAddress.City': 'City',
'InboundShipmentHeader.ShipFromAddress.StateOrProvinceCode': 'State_Or_Province_Code',
'InboundShipmentHeader.ShipFromAddress.PostalCode': 'Postal_Code',
'InboundShipmentHeader.ShipFromAddress.CountryCode': 'Country_Code',
'InboundShipmentHeader.DestinationFulfillmentCenterId': 'Destination_Fulfillment_Center_Id',
'InboundShipmentHeader.ShipmentStatus': 'Shipment_Status',
'InboundShipmentHeader.LabelPrepPreference': 'Label_Prep_Preference',
'InboundShipmentHeader.IntendedBoxContentsSource': 'Intended_Box_Contents_Source',
'InboundShipmentItems.member.1.QuantityShipped': 'Quantity_Shipped_1',
'InboundShipmentItems.member.1.SellerSKU': 'Seller_Sku_1',
'InboundShipmentItems.member.1.PrepDetailsList.member.1.PrepInstruction': 'Prep_Instruction_1',
'InboundShipmentItems.member.1.PrepDetailsList.member.1.PrepOwner': 'Prep_Owner_1',
'InboundShipmentItems.member.2.QuantityShipped': 'Quantity_Shipped_2',
'InboundShipmentItems.member.2.SellerSKU': 'Seller_Sku_2',
'InboundShipmentItems.member.2.PrepDetailsList.member.1.PrepInstruction': 'Prep_Instruction_2',
'InboundShipmentItems.member.2.PrepDetailsList.member.1.PrepOwner': 'Prep_Owner_2',
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'CreateInboundShipment',
SellerId: 'SELLER_ID',
ShipmentId: 'Shipment_Id',
'InboundShipmentHeader.ShipmentName': 'SHIPMENT_NAME',
'InboundShipmentHeader.ShipFromAddress.Name': 'NAME',
'InboundShipmentHeader.ShipFromAddress.AddressLine1': 'Address_Line1',
'InboundShipmentHeader.ShipFromAddress.City': 'City',
'InboundShipmentHeader.ShipFromAddress.StateOrProvinceCode': 'State_Or_Province_Code',
'InboundShipmentHeader.ShipFromAddress.PostalCode': 'Postal_Code',
'InboundShipmentHeader.ShipFromAddress.CountryCode': 'Country_Code',
'InboundShipmentHeader.DestinationFulfillmentCenterId': 'Destination_Fulfillment_Center_Id',
'InboundShipmentHeader.ShipmentStatus': 'Shipment_Status',
'InboundShipmentHeader.LabelPrepPreference': 'Label_Prep_Preference',
'InboundShipmentHeader.IntendedBoxContentsSource': 'Intended_Box_Contents_Source',
'InboundShipmentItems.member.1.QuantityShipped': 'Quantity_Shipped_1',
'InboundShipmentItems.member.1.SellerSKU': 'Seller_Sku_1',
'InboundShipmentItems.member.1.PrepDetailsList.member.1.PrepInstruction': 'Prep_Instruction_1',
'InboundShipmentItems.member.1.PrepDetailsList.member.1.PrepOwner': 'Prep_Owner_1',
'InboundShipmentItems.member.2.QuantityShipped': 'Quantity_Shipped_2',
'InboundShipmentItems.member.2.SellerSKU': 'Seller_Sku_2',
'InboundShipmentItems.member.2.PrepDetailsList.member.1.PrepInstruction': 'Prep_Instruction_2',
'InboundShipmentItems.member.2.PrepDetailsList.member.1.PrepOwner': 'Prep_Owner_2',
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "2a1455aa-c5f9-4993-9b18-dc10407e09ba"
},
"Result": {
"ShipmentId": "FBA2F50GYX"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Creates an inbound shipment.
Description
The CreateInboundShipment operation creates an inbound shipment, based on information that was returned by the CreateInboundShipmentPlan operation. The CreateInboundShipment operation can include up to 200 items.
UpdateInboundShipment
const mwsRequestData = {
Version: '2010-10-01',
Action: 'UpdateInboundShipment',
SellerId: 'SELLER_ID',
ShipmentId: 'Shipment_Id',
'InboundShipmentHeader.ShipmentName': 'SHIPMENT_NAME',
'InboundShipmentHeader.ShipFromAddress.Name': 'NAME',
'InboundShipmentHeader.ShipFromAddress.AddressLine1': 'Address_Line1',
'InboundShipmentHeader.ShipFromAddress.City': 'City',
'InboundShipmentHeader.ShipFromAddress.StateOrProvinceCode': 'State_Or_Province_Code',
'InboundShipmentHeader.ShipFromAddress.PostalCode': 'Postal_Code',
'InboundShipmentHeader.ShipFromAddress.CountryCode': 'Country_Code',
'InboundShipmentHeader.DestinationFulfillmentCenterId': 'Destination_Fulfillment_Center_Id',
'InboundShipmentHeader.ShipmentStatus': 'Shipment_Status',
'InboundShipmentHeader.LabelPrepPreference': 'Label_Prep_Preference',
'InboundShipmentHeader.IntendedBoxContentsSource': 'Intended_Box_Contents_Source',
'InboundShipmentItems.member.1.QuantityShipped': 'Quantity_Shipped_1',
'InboundShipmentItems.member.1.SellerSKU': 'Seller_Sku_1',
'InboundShipmentItems.member.1.PrepDetailsList.member.1.PrepInstruction': 'Prep_Instruction_1',
'InboundShipmentItems.member.1.PrepDetailsList.member.1.PrepOwner': 'Prep_Owner_1',
'InboundShipmentItems.member.2.QuantityShipped': 'Quantity_Shipped_2',
'InboundShipmentItems.member.2.SellerSKU': 'Seller_Sku_2',
'InboundShipmentItems.member.2.PrepDetailsList.member.1.PrepInstruction': 'Prep_Instruction_2',
'InboundShipmentItems.member.2.PrepDetailsList.member.1.PrepOwner': 'Prep_Owner_2',
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'UpdateInboundShipment',
SellerId: 'SELLER_ID',
ShipmentId: 'Shipment_Id',
'InboundShipmentHeader.ShipmentName': 'SHIPMENT_NAME',
'InboundShipmentHeader.ShipFromAddress.Name': 'NAME',
'InboundShipmentHeader.ShipFromAddress.AddressLine1': 'Address_Line1',
'InboundShipmentHeader.ShipFromAddress.City': 'City',
'InboundShipmentHeader.ShipFromAddress.StateOrProvinceCode': 'State_Or_Province_Code',
'InboundShipmentHeader.ShipFromAddress.PostalCode': 'Postal_Code',
'InboundShipmentHeader.ShipFromAddress.CountryCode': 'Country_Code',
'InboundShipmentHeader.DestinationFulfillmentCenterId': 'Destination_Fulfillment_Center_Id',
'InboundShipmentHeader.ShipmentStatus': 'Shipment_Status',
'InboundShipmentHeader.LabelPrepPreference': 'Label_Prep_Preference',
'InboundShipmentHeader.IntendedBoxContentsSource': 'Intended_Box_Contents_Source',
'InboundShipmentItems.member.1.QuantityShipped': 'Quantity_Shipped_1',
'InboundShipmentItems.member.1.SellerSKU': 'Seller_Sku_1',
'InboundShipmentItems.member.1.PrepDetailsList.member.1.PrepInstruction': 'Prep_Instruction_1',
'InboundShipmentItems.member.1.PrepDetailsList.member.1.PrepOwner': 'Prep_Owner_1',
'InboundShipmentItems.member.2.QuantityShipped': 'Quantity_Shipped_2',
'InboundShipmentItems.member.2.SellerSKU': 'Seller_Sku_2',
'InboundShipmentItems.member.2.PrepDetailsList.member.1.PrepInstruction': 'Prep_Instruction_2',
'InboundShipmentItems.member.2.PrepDetailsList.member.1.PrepOwner': 'Prep_Owner_2',
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'UpdateInboundShipment',
SellerId: 'SELLER_ID',
ShipmentId: 'Shipment_Id',
'InboundShipmentHeader.ShipmentName': 'SHIPMENT_NAME',
'InboundShipmentHeader.ShipFromAddress.Name': 'NAME',
'InboundShipmentHeader.ShipFromAddress.AddressLine1': 'Address_Line1',
'InboundShipmentHeader.ShipFromAddress.City': 'City',
'InboundShipmentHeader.ShipFromAddress.StateOrProvinceCode': 'State_Or_Province_Code',
'InboundShipmentHeader.ShipFromAddress.PostalCode': 'Postal_Code',
'InboundShipmentHeader.ShipFromAddress.CountryCode': 'Country_Code',
'InboundShipmentHeader.DestinationFulfillmentCenterId': 'Destination_Fulfillment_Center_Id',
'InboundShipmentHeader.ShipmentStatus': 'Shipment_Status',
'InboundShipmentHeader.LabelPrepPreference': 'Label_Prep_Preference',
'InboundShipmentHeader.IntendedBoxContentsSource': 'Intended_Box_Contents_Source',
'InboundShipmentItems.member.1.QuantityShipped': 'Quantity_Shipped_1',
'InboundShipmentItems.member.1.SellerSKU': 'Seller_Sku_1',
'InboundShipmentItems.member.1.PrepDetailsList.member.1.PrepInstruction': 'Prep_Instruction_1',
'InboundShipmentItems.member.1.PrepDetailsList.member.1.PrepOwner': 'Prep_Owner_1',
'InboundShipmentItems.member.2.QuantityShipped': 'Quantity_Shipped_2',
'InboundShipmentItems.member.2.SellerSKU': 'Seller_Sku_2',
'InboundShipmentItems.member.2.PrepDetailsList.member.1.PrepInstruction': 'Prep_Instruction_2',
'InboundShipmentItems.member.2.PrepDetailsList.member.1.PrepOwner': 'Prep_Owner_2',
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "4a2d48a7-9ac3-41f9-82e8-cbd9c137c7c6"
},
"Result": {
"ShipmentId": "FBA2F50GYX"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Updates an existing inbound shipment.
Description
The UpdateInboundShipment operation can add, update, and remove items from an existing inbound shipment. The existing shipment is identified by the ShipmentId. Each UpdateInboundShipment operation that you submit can include up to 200 items. If you include the InboundShipmentHeader request parameter, it replaces the InboundShipmentHeader information for the shipment you are updating.
GetPreorderInfo
const mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPreorderInfo',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPreorderInfo',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPreorderInfo',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "4a1a7029-462b-4a27-a04c-4cbe0fd107e3"
},
"Result": {
"ShipmentContainsPreorderableItems": "true",
"NeedByDate": "2015-12-27",
"ConfirmedFulfillableDate": "2015-12-31",
"ShipmentConfirmedForPreorder": "true"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order. Also indicates if a shipment has already been confirmed for pre-order.
Description
The GetPreorderInfo operation returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order. Call this operation after creating the shipment using the CreateInboundShipment operation. You can also call this operation to find out if a shipment has already been confirmed for pre-order. To confirm the shipment for pre-order, call the ConfirmPreorder operation.
GetPrepInstructionsForSKU
const mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPrepInstructionsForSKU',
SellerId: 'SELLER_ID',
'SellerSKUList.Id.1': 'Seller_Sku_List_Id',
ShipToCountryCode: 'Country_Code'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetInboundGuidanceForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'SellerSKUList.Id.1': 'us001'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPrepInstructionsForSKU',
SellerId: 'SELLER_ID',
'SellerSKUList.Id.1': 'Seller_Sku_List_Id',
ShipToCountryCode: 'Country_Code'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "171a23ca-12f9-4599-bbdf-47bc5701d955"
},
"Result": {
"SKUPrepInstructionsList": {
"SKUPrepInstructions": {
"SellerSKU": "ca_001",
"ASIN": "B00EXAMPLE",
"BarcodeInstruction": "RequiresFNSKULabel",
"PrepGuidance": "SeePrepInstructionsList",
"PrepInstructionList": {
"PrepInstruction": [
"Polybagging",
"Taping",
"Labeling"
]
},
"AmazonPrepFeesDetailsList": {
"AmazonPrepFeesDetails": [
{
"PrepInstruction": "Polybagging",
"Amount": {
"Value": ",0.2",
"CurrencyCode": "USD"
}
},
{
"PrepInstruction": "Taping",
"Amount": {
"Value": ",0.2",
"CurrencyCode": "USD"
}
},
{
"PrepInstruction": "Labeling",
"Amount": {
"Value": ",0.2",
"CurrencyCode": "USD"
}
}
]
}
}
},
"InvalidSKUList": {}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns labeling requirements and item preparation instructions to help you prepare items for an inbound shipment.
Description
The GetPrepInstructionsForSKU operation returns labeling requirements and item preparation instructions to help you prepare items for shipment to Amazon's fulfillment network.
GetPrepInstructionsForASIN
const mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPrepInstructionsForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'ASINList.Id.1': 'ASIN_List_Id_1',
'ASINList.Id.2': 'ASIN_List_Id_2',
ShipToCountryCode: 'Country_Code'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPrepInstructionsForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'ASINList.Id.1': 'ASIN_List_Id_1',
'ASINList.Id.2': 'ASIN_List_Id_2',
ShipToCountryCode: 'Country_Code'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPrepInstructionsForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'ASINList.Id.1': 'ASIN_List_Id_1',
'ASINList.Id.2': 'ASIN_List_Id_2',
ShipToCountryCode: 'Country_Code'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "171a23ca-12f9-4599-bbdf-47bc5701d955"
},
"Result": {
"ASINPrepInstructionsList": {
"ASINPrepInstructions": {
"ASIN": "B00005N5PF",
"BarcodeInstruction": "RequiresFNSKULabel",
"PrepGuidance": "SeePrepInstructionsList",
"PrepInstructionList": {
"PrepInstruction": [
"Polybagging",
"Taping"
]
}
}
},
"InvalidASINList": {
"InvalidASIN": {
"ASIN": "B0INVALIDF",
"ErrorReason": "InvalidASIN"
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns item preparation instructions to help with item sourcing decisions.
Description
The GetPrepInstructionsForASIN operation returns item preparation instructions to help with item sourcing decisions.
PutTransportContent
const mwsRequestData = {
Version: '2010-10-01',
Action: 'PutTransportContent',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id',
IsPartnered: 'false',
ShipmentType: 'Shipment_Type',
'TransportDetails.NonPartneredSmallParcelData.CarrierName': 'Carrier_Name',
'TransportDetails.NonPartneredSmallParcelData.PackageList.member.1.TrackingId': 'Tracking_Id'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'PutTransportContent',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id',
IsPartnered: 'false',
ShipmentType: 'Shipment_Type',
'TransportDetails.NonPartneredSmallParcelData.CarrierName': 'Carrier_Name',
'TransportDetails.NonPartneredSmallParcelData.PackageList.member.1.TrackingId': 'Tracking_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'PutTransportContent',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id',
IsPartnered: 'false',
ShipmentType: 'Shipment_Type',
'TransportDetails.NonPartneredSmallParcelData.CarrierName': 'Carrier_Name',
'TransportDetails.NonPartneredSmallParcelData.PackageList.member.1.TrackingId': 'Tracking_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "616f4f53-973e-4bb3-8dd3-0b46978a45c5"
},
"Result": {
"TransportResult": {
"TransportStatus": "WORKING"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Sends transportation information to Amazon about an inbound shipment.
Description
The PutTransportContent operation sends transportation information to Amazon about an inbound shipment. This includes whether an inbound shipment is a Small Parcel or Less Than Truckload/Full Truckload (LTL/FTL) delivery, and whether you intend to use an Amazon-partnered carrier.
EstimateTransportRequest
const mwsRequestData = {
Version: '2010-10-01',
Action: 'EstimateTransportRequest',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'EstimateTransportRequest',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'EstimateTransportRequest',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "827e673d-8399-492f-bfb6-4fdf26d146ba"
},
"Result": {
"TransportResult": {
"TransportStatus": "ESTIMATING"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Requests an estimate of the shipping cost for an inbound shipment.
Description
The EstimateTransportRequest operation initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier. Prior to calling the EstimateTransportRequest operation, you must call the PutTransportContent operation to provide Amazon with the transportation information for your inbound shipment.
GetTransportContent
const mwsRequestData = {
Version: '2010-10-01',
Action: 'GetTransportContent',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetTransportContent',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetTransportContent',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "89a965c3-1af7-41e3-9152-44cf0affd34b"
},
"Result": {
"TransportContent": {
"TransportDetails": {
"NonPartneredSmallParcelData": {
"PackageList": {
"member": {
"TrackingId": "1Z6Y68W00342402864",
"CarrierName": "UNITED PARCEL SERVICE INC",
"PackageStatus": "SHIPPED"
}
}
}
},
"TransportResult": {
"TransportStatus": "WORKING"
},
"TransportHeader": {
"ShipmentType": "SP",
"ShipmentId": "FBAQ6QBP",
"SellerId": "A135KKEKWF1J56",
"IsPartnered": "false"
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns current transportation information about an inbound shipment.
Description
The GetTransportContent operation returns current transportation information about an inbound shipment. This includes the current workflow status for shipments by Amazon-partnered carriers and the current workflow status for individual Small Parcel Delivery packages as they are processed by the Amazon fulfillment center. This also includes the PartneredEstimate response element, which indicates the estimated shipping cost for an inbound shipment by an Amazon-partnered carrier.
ConfirmTransportRequest
const mwsRequestData = {
Version: '2010-10-01',
Action: 'ConfirmTransportRequest',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ConfirmTransportRequest',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ConfirmTransportRequest',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "27bdc3df-d41b-4cf5-a96d-047815797bbf"
},
"Result": {
"TransportResult": {
"TransportStatus": "CONFIRMING"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Confirms that you accept the Amazon-partnered shipping estimate and you request that the Amazon-partnered carrier ship your inbound shipment.
Description
The ConfirmTransportRequest operation confirms that you accept the Amazon-partnered shipping estimate, agree to allow Amazon to charge your account for the shipping cost, and request that the Amazon-partnered carrier ship your inbound shipment. Prior to calling the ConfirmTransportRequest operation, you should call the GetTransportContent operation to get the Amazon-partnered shipping estimate (indicated by the PartneredEstimate response element).
VoidTransportRequest
const mwsRequestData = {
Version: '2010-10-01',
Action: 'VoidTransportRequest',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'VoidTransportRequest',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'VoidTransportRequest',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "c5818219-de93-4b3e-8f9b-b172fbacd010"
},
"Result": {
"TransportResult": {
"TransportStatus": "VOIDING"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Voids a previously-confirmed request to ship your inbound shipment using an Amazon-partnered carrier.
Description
The VoidTransportRequest operation voids a previously-confirmed request to ship your inbound shipment using an Amazon-partnered carrier. To be successful, this operation must be called before the VoidDeadline date that is returned by the GetTransportContent operation.
GetPackageLabels
const mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPackageLabels',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id',
PageType: 'Page_Type'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPackageLabels',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id',
PageType: 'Page_Type'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPackageLabels',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id',
PageType: 'Page_Type'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "985a3fa9-3ce2-46fb-a1c7-321439269d2b"
},
"Result": {
"TransportDocument": {
"PdfDocument": "ABEAAAAAAlbHMucGRmUEsFBgAAAAABAAEAPwAAALQXAQAAAA==",
"Checksum": "WGQwqA+NlzMVL1plHc/7ZA=="
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns package labels.
Description
The GetPackageLabels operation returns PDF document data for printing shipping labels and carrier labels for an inbound shipment. The language of the address section of a shipping label is determined by the ShipFromAddress value for the shipment, which was specified with a previous call to the CreateInboundShipmentPlan operation. The language of the FC Prep instructions (if applicable) is determined by the marketplace of the Amazon fulfillment center receiving the shipment.
GetUniquePackageLabels
const mwsRequestData = {
Version: '2010-10-01',
Action: 'GetUniquePackageLabels',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id',
PageType: 'Page_Type',
'PackageLabelsToPrint.member.1': 'Member_1',
'PackageLabelsToPrint.member.2': 'Member_2',
'PackageLabelsToPrint.member.3': 'Member_3',
'PackageLabelsToPrint.member.4': 'Member_4'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetUniquePackageLabels',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id',
PageType: 'Page_Type',
'PackageLabelsToPrint.member.1': 'Member_1',
'PackageLabelsToPrint.member.2': 'Member_2',
'PackageLabelsToPrint.member.3': 'Member_3',
'PackageLabelsToPrint.member.4': 'Member_4'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetUniquePackageLabels',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id',
PageType: 'Page_Type',
'PackageLabelsToPrint.member.1': 'Member_1',
'PackageLabelsToPrint.member.2': 'Member_2',
'PackageLabelsToPrint.member.3': 'Member_3',
'PackageLabelsToPrint.member.4': 'Member_4'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "985a3fa9-3ce2-46fb-a1c7-321439269d2b"
},
"Result": {
"TransportDocument": {
"PdfDocument": "ABEAAAAAAlbHMucGRmUEsFBgAAAAABAAEAPwAAALQXAQAAAA==",
"Checksum": "WGQwqA+NlzMVL1plHc/7ZA=="
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns unique package labels for faster and more accurate shipment processing at the Amazon fulfillment center.
Description
The GetUniquePackageLabels operation returns PDF document data for printing unique shipping labels and carrier labels for an inbound shipment. Use this operation to get unique shipping labels for the packages in all types of inbound shipments: Small Parcel, Less Than Truckload/Full Truckload (LTL/FTL), Amazon-partnered, or non-Amazon-partnered shipments. For Amazon-partnered, Small Parcel shipments, this operation returns carrier labels in addition to shipping labels. The language of the address section of a shipping label is determined by the ShipFromAddress value for the shipment, which was specified with a previous call to the CreateInboundShipmentPlan operation. The language of the FC Prep instructions (if applicable) is determined by the marketplace of the Amazon fulfillment center receiving the shipment.
GetPalletLabels
const mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPalletLabels',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id',
PageType: 'Page_Type',
NumberOfPallets: 'Number_Of_Pallets'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPalletLabels',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id',
PageType: 'Page_Type',
NumberOfPallets: 'Number_Of_Pallets'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPalletLabels',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id',
PageType: 'Page_Type',
NumberOfPallets: 'Number_Of_Pallets'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"Value": "xmlns=\"http://mws.amazonaws.com/FulfillmentInboundShipment/2010-10-01/\">",
"ResponseMetadata": {
"RequestId": "985a3fa9-3ce2-46fb-a1c7-321439269d2b"
},
"Result": {
"TransportDocument": {
"PdfDocument": "ABEAAAAAAlbHMucGRmUEsFBgAAAAABAAEAPwAAALQXAQAAAA==",
"Checksum": "WGQwqA+NlzMVL1plHc/7ZA=="
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns pallet labels.
Description
The GetPalletLabels operation returns PDF document data for printing pallet labels for a Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. This operation returns the InvalidOperation error code if you include a ShipmentId value for a Small Parcel shipment.
GetBillOfLading
const mwsRequestData = {
Version: '2010-10-01',
Action: 'GetBillOfLading',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetBillOfLading',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetBillOfLading',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "985a3fa9-3ce2-46fb-a1c7-321439269d2b"
},
"Result": {
"TransportDocument": {
"PdfDocument": "ABEAAAAAAlbHMucGRmUEsFBgAAAAABAAEAPwAAALQXAQAAAA==",
"Checksum": "WGQwqA+NlzMVL1plHc/7ZA=="
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment.
Description
The GetBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment.
ListInboundShipments
const mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInboundShipments',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'ShipmentStatusList.member.1': 'WORKING',
LastUpdatedAfter: '2015-10-02',
LastUpdatedBefore: '2015-11-02',
'ShipmentStatusList.member.2': 'CLOSED',
'ShipmentIdList.member.1': 'Shipment_Id_List_Member_1',
'ShipmentIdList.member.2': 'Shipment_Id_List_Member_2',
'ShipmentIdList.member.3': 'Shipment_Id_List_Member_3'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInboundShipments',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'ShipmentStatusList.member.1': 'WORKING',
LastUpdatedAfter: '2015-10-02',
LastUpdatedBefore: '2015-11-02',
'ShipmentStatusList.member.2': 'CLOSED',
'ShipmentIdList.member.1': 'Shipment_Id_List_Member_1',
'ShipmentIdList.member.2': 'Shipment_Id_List_Member_2',
'ShipmentIdList.member.3': 'Shipment_Id_List_Member_3'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInboundShipments',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'ShipmentStatusList.member.1': 'WORKING',
LastUpdatedAfter: '2015-10-02',
LastUpdatedBefore: '2015-11-02',
'ShipmentStatusList.member.2': 'CLOSED',
'ShipmentIdList.member.1': 'Shipment_Id_List_Member_1',
'ShipmentIdList.member.2': 'Shipment_Id_List_Member_2',
'ShipmentIdList.member.3': 'Shipment_Id_List_Member_3'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"Result": {
"ShipmentData": {
"member": [
{
"ShipFromAddress": {
"PostalCode": "V5V 1A1",
"Name": "jsowprni Devo CA20",
"CountryCode": "CA",
"StateOrProvinceCode": "BC",
"AddressLine1": "Address Line 1",
"City": "Vancouver"
},
"ShipmentId": "FBAN4QNH",
"ShipmentName": "FBA (8/27/12 1:55 PM)",
"ShipmentStatus": "WORKING",
"LabelPrepType": "NO_LABEL",
"DestinationFulfillmentCenterId": "YYZ1"
},
{
"ShipFromAddress": {
"PostalCode": "V5V 1A1",
"Name": "Janani Arvind FBA QA",
"CountryCode": "CA",
"StateOrProvinceCode": "BC",
"AddressLine1": "Address 1",
"City": "Vancouver"
},
"ShipmentId": "FBA1123",
"ShipmentName": "Test MWS CA Shipment 1",
"ShipmentStatus": "WORKING",
"LabelPrepType": "NO_LABEL",
"DestinationFulfillmentCenterId": "RIC2",
"BoxContentsSource": "NONE",
"EstimatedBoxContentsFee": {
"TotalUnits": "10",
"FeePerUnit": {
"Value": ",0.10",
"CurrencyCode": "USD"
},
"TotalFee": {
"Value": ",10.0",
"CurrencyCode": "USD"
}
}
}
]
}
},
"ResponseMetadata": {},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of inbound shipments based on criteria that you specify.
Description
The ListInboundShipments operation returns a list of inbound shipments based on request parameters that you specify. You can use the ShipmentIdList request parameter to request inbound shipments by their ShipmentId values. You can also request inbound shipments based on their shipment status and by when they were last updated. A ShipmentId is generated by submitting the CreateInboundShipmentPlan operation and remains the primary identifier for an inbound shipment throughout the inbound shipment process. The ListInboundShipments operation returns a maximum of 50 inbound shipments. If there are additional inbound shipments to return, NextToken is returned in the response. To retrieve all of the inbound shipments, pass the value of NextToken to the ListInboundShipmentsByNextToken operation and repeat until NextToken is no longer returned.
ListInboundShipmentsByNextToken
const mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInboundShipmentsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'Next_Token'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInboundShipmentsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'Next_Token'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInboundShipmentsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'Next_Token'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "8547a35c-8e70-11df-8af1-5bf2881764d8"
},
"Result": {
"NextToken": "QVYyVTY5NUVaQzBDWHw0ODh8MjAwfCB8IHw1OTM0MDZ8IHwwLDJ8
IHwgfCB8IHx0cnVl",
"ShipmentData": {
"member": [
{
"ShipFromAddress": {
"PostalCode": "98101",
"Name": "Joan Doe",
"CountryCode": "US",
"StateOrProvinceCode": "WA",
"AddressLine2": "Apt 2",
"AddressLine1": "876 Elm St",
"City": "Seattle"
},
"AreCasesRequired": "false",
"ShipmentId": "SSF85DGIZZ7PKF",
"ShipmentStatus": "WORKING",
"ShipmentName": "ExampleShipmentName4",
"DestinationFulfillmentCenterId": "RNO2",
"LabelPrepType": "SELLER_LABEL"
},
{
"ShipFromAddress": {
"PostalCode": "98101",
"Name": "Joan Doe",
"CountryCode": "US",
"StateOrProvinceCode": "WA",
"AddressLine2": "Apt 2",
"AddressLine1": "876 Elm St",
"City": "Seattle"
},
"AreCasesRequired": "true",
"ShipmentId": "SSF85DGIZZ7PL3",
"ShipmentStatus": "SHIPPED",
"ShipmentName": "ExampleShipmentName5",
"DestinationFulfillmentCenterId": "RNO2",
"LabelPrepType": "SELLER_LABEL",
"ConfirmedNeedByDate": "2015-12-30"
}
]
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the next page of inbound shipments using the NextToken parameter.
Description
The ListInboundShipmentsByNextToken operation returns the next page of inbound shipments using the NextToken value that was returned by your previous request to either ListInboundShipments or ListInboundShipmentsByNextToken. If NextToken is not returned, there are no more pages to return.
ListInboundShipmentItems
const mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInboundShipmentItems',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInboundShipmentItems',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInboundShipmentItems',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShipmentId: 'Shipment_Id'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "ffce8932-8e69-11df-8af1-5bf2881764d8"
},
"Result": {
"ItemData": {
"member": [
{
"ShipmentId": "SSF85DGIZZ3OF1",
"SellerSKU": "SampleSKU1",
"QuantityShipped": "3",
"QuantityInCase": "0",
"QuantityReceived": "0",
"FulfillmentNetworkSKU": "B000FADVPQ",
"ReleaseDate": "2014-12-31"
},
{
"ShipmentId": "SSF85DGIZZ3OF1",
"SellerSKU": "SampleSKU2",
"QuantityShipped": "10",
"QuantityInCase": "0",
"QuantityReceived": "0",
"FulfillmentNetworkSKU": "B0011VECH4"
}
]
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame.
Description
The ListInboundShipmentItems operation returns a list of items contained in an inbound shipment that you specify with a ShipmentId. Alternatively, if you submit the LastUpdatedAfter and LastUpdatedBefore request parameters, the ListInboundShipmentItems operation returns inbound shipment items based on when the items were last updated. Note that if you specify the ShipmentId, then the LastUpdatedAfter and LastUpdatedBefore request parameters are ignored. You can obtain ShipmentId values for a list of inbound shipments by submitting the ListInboundShipments operation. The ListInboundShipmentItems operation returns a maximum of 200 inbound shipment items. If there are additional inbound shipment items to return, NextToken is returned in the response. To retrieve all of the inbound shipment items, pass the value of NextToken to the ListInboundShipmentItemsByNextToken operation and repeat until NextToken is no longer returned.
ListInboundShipmentItemsByNextToken
const mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInboundShipmentItemsByNextToken',
SellerId: 'SELLER_ID',
NextToken: 'Next_Token'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInboundShipmentItemsByNextToken',
SellerId: 'SELLER_ID',
NextToken: 'Next_Token'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInboundShipmentItemsByNextToken',
SellerId: 'SELLER_ID',
NextToken: 'Next_Token'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "9581f746-c8fb-42ca-ad20-42f8a5333a1b"
},
"Result": {
"ItemData": {
"member": {
"QuantityShipped": "2",
"ShipmentId": "FBA0000001",
"FulfillmentNetworkSKU": "FNSKU1",
"SellerSKU": "SKU00001",
"QuantityReceived": "0",
"QuantityInCase": "0",
"PrepDetailsList": {
"PrepDetails": [
{
"PrepInstruction": "Taping",
"PrepOwner": "AMAZON"
},
{
"PrepInstruction": "Polybagging",
"PrepOwner": "AMAZON"
}
]
}
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the next page of inbound shipment items using the NextToken parameter.
Description
The ListInboundShipmentItemsByNextToken operation returns the next page of inbound shipment items using the NextToken value that was returned by your previous request to either ListInboundShipmentItems or ListInboundShipmentItemsByNextToken. If NextToken is not returned, there are no more pages to return.
GetServiceStatus
const mwsRequestData = {
Version: '2010-10-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
try {
const response = await amazonMws.fulfillmentInboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.fulfillmentInboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "d80c6c7b-f7c7-4fa7-bdd7-854711cb3bcc"
},
"Result": {
"Status": "GREEN",
"Timestamp": "2010-11-01T21:38:09.676Z"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the operational status of the Fulfillment Inbound Shipment API section.
Description
The GetServiceStatus operation returns the operational status of the Fulfillment Inbound Shipment API section of Amazon Marketplace Web Service. Status values are GREEN, YELLOW, and RED.
FulfillmentInventory
ListInventorySupply
const mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInventorySupply',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
QueryStartDateTime: new Date(2016, 11, 24)
};
try {
const response = await amazonMws.fulfillmentInventory.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInventorySupply',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
QueryStartDateTime: new Date(2016, 11, 24)
};
amazonMws.fulfillmentInventory.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInventorySupply',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
QueryStartDateTime: new Date(2016, 11, 24)
};
amazonMws.fulfillmentInventory.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "e8698ffa-8e59-11df-9acb-230ae7a8b736"
},
"Result": {
"InventorySupplyList": {
"member": [
{
"SellerSKU": "SampleSKU1",
"ASIN": "B00000K3CQ",
"TotalSupplyQuantity": "20",
"FNSKU": "X0000000FM",
"Condition": "NewItem",
"SupplyDetail": {},
"InStockSupplyQuantity": "15",
"EarliestAvailability": {
"TimepointType": "Immediately"
}
},
{
"SellerSKU": "SampleSKU2",
"ASIN": "B00004RWQR",
"TotalSupplyQuantity": "0",
"FNSKU": "X00008FZR1",
"Condition": "UsedLikeNew",
"SupplyDetail": {},
"InStockSupplyQuantity": "0"
}
]
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns information about the availability of a seller's inventory.
Description
The ListInventorySupply operation returns information about the availability of inventory that a seller has in Amazon's fulfillment network and in current inbound shipments. You can check the current availability status for your Fulfillment by Amazon inventory as well as discover when availability status changes.
ListInventorySupplyByNextToken
const mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInventorySupplyByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'Next_Token'
};
try {
const response = await amazonMws.fulfillmentInventory.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInventorySupplyByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'Next_Token'
};
amazonMws.fulfillmentInventory.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListInventorySupplyByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'Next_Token'
};
amazonMws.fulfillmentInventory.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "b3a020ac-8e5e-11df-9acb-230ae7a8b736"
},
"Result": {
"NextToken": "2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=",
"InventorySupplyList": {
"member": [
{
"SellerSKU": "SampleSKU5",
"ASIN": "B00008UI0R",
"TotalSupplyQuantity": "0",
"FNSKU": "B00008UI0R",
"Condition": {},
"SupplyDetail": {},
"InStockSupplyQuantity": "0"
},
{
"SellerSKU": "SampleSKU6",
"ASIN": "B00000K3CQ",
"TotalSupplyQuantity": "5259",
"FNSKU": "X0000000FM",
"Condition": "NewItem",
"SupplyDetail": {},
"InStockSupplyQuantity": "5259",
"EarliestAvailability": {
"TimepointType": "Immediately"
}
}
]
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the next page of information about the availability of a seller's inventory using the NextToken parameter.
Description
The ListInventorySupplyByNextToken operation returns the next page of information about the availability of a seller's inventory using the NextToken value that was returned by your previous request to either ListInventorySupply or ListInventorySupplyByNextToken. If NextToken is not returned, there are no more pages to return.
GetServiceStatus
const mwsRequestData = {
Version: '2010-10-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
try {
const response = await amazonMws.fulfillmentInventory.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.fulfillmentInventory.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.fulfillmentInventory.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "d80c6c7b-f7c7-4fa7-bdd7-854711cb3bcc"
},
"Result": {
"Status": "GREEN",
"Timestamp": "2010-11-01T21:38:09.676Z"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the operational status of the Fulfillment Inventory API section.
Description
The GetServiceStatus operation returns the operational status of the Fulfillment Inventory API section of Amazon Marketplace Web Service. Status values are GREEN, YELLOW, and RED.
FulfillmentOutboundShipment
GetFulfillmentPreview
const mwsRequestData = {
Version: '2010-10-01',
Action: 'GetFulfillmentPreview',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKETPLACE_Id',
'Address.Name': 'ADDRESS_NAME',
'Address.Line1': 'ADDRESS_LINE1',
'Address.Line2': 'ADDRESS_LINE2',
'Address.StateOrProvinceCode': 'STATE_OR_PROVINCE_CODE',
'Address.PostalCode': 'POSTAL_CODE',
'Address.CountryCode': 'COUNTRY_CODE',
'Items.member.1.Quantity': 'Quantity1',
'Items.member.1.SellerFulfillmentOrderItemId': 'SELLER_FULFILLMENT_ORDER_ITEM_ID1',
'Items.member.1.SellerSKU': 'SELLER_SKU1',
'Items.member.2.Quantity': 'Quantity2',
'Items.member.2.SellerFulfillmentOrderItemId': 'SELLER_FULFILLMENT_ORDER_ITEM_ID2',
'Items.member.2.SellerSKU': 'SELLER_SKU2',
'ShippingSpeedCategories.1': 'Shipping_Speed_Categories1',
'ShippingSpeedCategories.2': 'Shipping_Speed_Categories2',
'ShippingSpeedCategories.3': 'Shipping_Speed_Categories3',
'IncludeCODFulfillmentPreview': 'true',
'IncludeDeliveryWindows': 'true'
};
try {
const response = await amazonMws.fulfillmentOutboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetFulfillmentPreview',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKETPLACE_Id',
'Address.Name': 'ADDRESS_NAME',
'Address.Line1': 'ADDRESS_LINE1',
'Address.Line2': 'ADDRESS_LINE2',
'Address.StateOrProvinceCode': 'STATE_OR_PROVINCE_CODE',
'Address.PostalCode': 'POSTAL_CODE',
'Address.CountryCode': 'COUNTRY_CODE',
'Items.member.1.Quantity': 'Quantity1',
'Items.member.1.SellerFulfillmentOrderItemId': 'SELLER_FULFILLMENT_ORDER_ITEM_ID1',
'Items.member.1.SellerSKU': 'SELLER_SKU1',
'Items.member.2.Quantity': 'Quantity2',
'Items.member.2.SellerFulfillmentOrderItemId': 'SELLER_FULFILLMENT_ORDER_ITEM_ID2',
'Items.member.2.SellerSKU': 'SELLER_SKU2',
'ShippingSpeedCategories.1': 'Shipping_Speed_Categories1',
'ShippingSpeedCategories.2': 'Shipping_Speed_Categories2',
'ShippingSpeedCategories.3': 'Shipping_Speed_Categories3',
'IncludeCODFulfillmentPreview': 'true',
'IncludeDeliveryWindows': 'true'
};
amazonMws.fulfillmentOutboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetFulfillmentPreview',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKETPLACE_Id',
'Address.Name': 'ADDRESS_NAME',
'Address.Line1': 'ADDRESS_LINE1',
'Address.Line2': 'ADDRESS_LINE2',
'Address.StateOrProvinceCode': 'STATE_OR_PROVINCE_CODE',
'Address.PostalCode': 'POSTAL_CODE',
'Address.CountryCode': 'COUNTRY_CODE',
'Items.member.1.Quantity': 'Quantity1',
'Items.member.1.SellerFulfillmentOrderItemId': 'SELLER_FULFILLMENT_ORDER_ITEM_ID1',
'Items.member.1.SellerSKU': 'SELLER_SKU1',
'Items.member.2.Quantity': 'Quantity2',
'Items.member.2.SellerFulfillmentOrderItemId': 'SELLER_FULFILLMENT_ORDER_ITEM_ID2',
'Items.member.2.SellerSKU': 'SELLER_SKU2',
'ShippingSpeedCategories.1': 'Shipping_Speed_Categories1',
'ShippingSpeedCategories.2': 'Shipping_Speed_Categories2',
'ShippingSpeedCategories.3': 'Shipping_Speed_Categories3',
'IncludeCODFulfillmentPreview': 'true',
'IncludeDeliveryWindows': 'true'
};
amazonMws.fulfillmentOutboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "f4c29ec4-ceb7-4608-a764-5c758ac0021a"
},
"Result": {
"FulfillmentPreviews": {
"member": [
{
"EstimatedShippingWeight": {
"Value": ",12",
"Unit": "kilograms"
},
"ShippingSpeedCategory": "Expedited",
"FulfillmentPreviewShipments": {
"member": {
"LatestShipDate": "2014-01-04T00:30:00Z",
"LatestArrivalDate": "2014-01-06T06:59:59Z",
"FulfillmentPreviewItems": {
"member": [
{
"EstimatedShippingWeight": {
"Value": ",10",
"Unit": "kilograms"
},
"SellerSKU": "SampleSKU1",
"SellerFulfillmentOrderItemId": "mws-test-query-20100713023406723-2",
"ShippingWeightCalculationMethod": "Package",
"Quantity": "2"
},
{
"EstimatedShippingWeight": {
"Value": ",2",
"Unit": "kilograms"
},
"SellerSKU": "SampleSKU2",
"SellerFulfillmentOrderItemId": "mws-test-query-20100713023406723-1",
"ShippingWeightCalculationMethod": "Package",
"Quantity": "1"
}
]
},
"EarliestShipDate": "2014-01-04T00:30:00Z",
"EarliestArrivalDate": "2014-01-05T07:00:00Z"
}
},
"EstimatedFees": {
"member": [
{
"Amount": {
"Value": ",225",
"CurrencyCode": "JPY"
},
"Name": "FBAPerUnitFulfillmentFee"
},
{
"Amount": {
"Value": ",475",
"CurrencyCode": "JPY"
},
"Name": "FBAPerOrderFulfillmentFee"
},
{
"Amount": {
"Value": ",660",
"CurrencyCode": "JPY"
},
"Name": "FBATransportationFee"
}
]
},
"UnfulfillablePreviewItems": {},
"IsFulfillable": "true",
"IsCODCapable": "false",
"MarketplaceId": "ATVPDKIKX0DER"
},
{
"EstimatedShippingWeight": {
"Value": ",12",
"Unit": "kilograms"
},
"ShippingSpeedCategory": "Standard",
"FulfillmentPreviewShipments": {
"member": {
"LatestShipDate": "2014-01-04T00:30:00Z",
"LatestArrivalDate": "2014-07-09T06:59:59Z",
"FulfillmentPreviewItems": {
"member": [
{
"EstimatedShippingWeight": {
"Value": ",10",
"Unit": "kilograms"
},
"SellerSKU": "SampleSKU1",
"SellerFulfillmentOrderItemId": "mws-test-query-20100713023406723-2",
"ShippingWeightCalculationMethod": "Package",
"Quantity": "2"
},
{
"EstimatedShippingWeight": {
"Value": ",2",
"Unit": "kilograms"
},
"SellerSKU": "SampleSKU2",
"SellerFulfillmentOrderItemId": "mws-test-query-20100713023406723-1",
"ShippingWeightCalculationMethod": "Package",
"Quantity": "1"
}
]
},
"EarliestShipDate": "2014-01-04T00:30:00Z",
"EarliestArrivalDate": "2014-01-05T07:00:00Z"
}
},
"EstimatedFees": {
"member": [
{
"Amount": {
"Value": ",225",
"CurrencyCode": "JPY"
},
"Name": "FBAPerUnitFulfillmentFee"
},
{
"Amount": {
"Value": ",475",
"CurrencyCode": "JPY"
},
"Name": "FBAPerOrderFulfillmentFee"
},
{
"Amount": {
"Value": ",660",
"CurrencyCode": "JPY"
},
"Name": "FBATransportationFee"
},
{
"Amount": {
"Value": ",315",
"CurrencyCode": "JPY"
},
"Name": "FBAFulfillmentCODFee"
}
]
},
"UnfulfillablePreviewItems": {},
"IsFulfillable": "true",
"IsCODCapable": "true"
},
{
"EstimatedShippingWeight": {
"Value": ",12",
"Unit": "kilograms"
},
"ShippingSpeedCategory": "ScheduledDelivery",
"ScheduledDeliveryInfo": {
"DeliveryTimeZone": "Asia/Tokyo",
"DeliveryWindows": {
"member": [
{
"DeliveryWindow": {
"StartDateTime": "2014-01-04T23:00:00Z",
"EndDateTime": "2014-01-05T03:00:00Z"
}
},
{
"DeliveryWindow": {
"StartDateTime": "2014-01-05T03:00:00Z",
"EndDateTime": "2014-01-05T05:00:00Z"
}
},
{
"DeliveryWindow": {
"StartDateTime": "2014-01-05T05:00:00Z",
"EndDateTime": "2014-01-05T07:00:00Z"
}
},
{
"DeliveryWindow": {
"StartDateTime": "2014-01-05T07:00:00Z",
"EndDateTime": "2014-01-05T09:00:00Z"
}
},
{
"DeliveryWindow": {
"StartDateTime": "2014-01-05T09:00:00Z",
"EndDateTime": "2014-01-05T11:00:00Z"
}
},
{
"DeliveryWindow": {
"StartDateTime": "2014-01-05T11:00:00Z",
"EndDateTime": "2014-01-05T12:00:00Z"
}
},
{
"DeliveryWindow": {
"StartDateTime": "2014-01-05T23:00:00Z",
"EndDateTime": "2014-01-06T03:00:00Z"
}
},
{
"DeliveryWindow": {
"StartDateTime": "2014-01-06T03:00:00Z",
"EndDateTime": "2014-01-06T05:00:00Z"
}
},
{
"DeliveryWindow": {
"StartDateTime": "2014-01-06T05:00:00Z",
"EndDateTime": "2014-01-06T07:00:00Z"
}
},
{
"DeliveryWindow": {
"StartDateTime": "2014-01-06T07:00:00Z",
"EndDateTime": "2014-01-06T09:00:00Z"
}
},
{
"DeliveryWindow": {
"StartDateTime": "2014-01-06T09:00:00Z",
"EndDateTime": "2014-01-06T11:00:00Z"
}
},
{
"DeliveryWindow": {
"StartDateTime": "2014-01-06T11:00:00Z",
"EndDateTime": "2014-01-06T12:00:00Z"
}
}
]
}
},
"FulfillmentPreviewShipments": {
"member": {
"LatestShipDate": "2014-01-04T00:30:00Z",
"LatestArrivalDate": "2014-01-06T06:59:59Z",
"FulfillmentPreviewItems": {
"member": [
{
"EstimatedShippingWeight": {
"Value": ",10",
"Unit": "kilograms"
},
"SellerSKU": "SampleSKU1",
"SellerFulfillmentOrderItemId": "mws-test-query-20100713023406723-2",
"ShippingWeightCalculationMethod": "Package",
"Quantity": "2"
},
{
"EstimatedShippingWeight": {
"Value": ",2",
"Unit": "kilograms"
},
"SellerSKU": "SampleSKU2",
"SellerFulfillmentOrderItemId": "mws-test-query-20100713023406723-1",
"ShippingWeightCalculationMethod": "Package",
"Quantity": "1"
}
]
},
"EarliestShipDate": "2014-01-04T00:30:00Z",
"EarliestArrivalDate": "2014-01-05T07:00:00Z"
}
},
"EstimatedFees": {
"member": [
{
"Amount": {
"Value": ",225",
"CurrencyCode": "JPY"
},
"Name": "FBAPerUnitFulfillmentFee"
},
{
"Amount": {
"Value": ",475",
"CurrencyCode": "JPY"
},
"Name": "FBAPerOrderFulfillmentFee"
},
{
"Amount": {
"Value": ",660",
"CurrencyCode": "JPY"
},
"Name": "FBATransportationFee"
}
]
},
"UnfulfillablePreviewItems": {},
"IsFulfillable": "true",
"IsCODCapable": "false"
}
]
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of fulfillment order previews based on shipping criteria that you specify.
Description
The GetFulfillmentPreview operation returns a list of fulfillment order previews based on shipping criteria that you specify. Each fulfillment order preview contains the estimated shipping weight and the estimated shipping fees for the potential fulfillment order, as well as ship dates, arrival dates, and estimated shipping weights for individual shipments within the potential fulfillment order. In Japan, the GetFulfillmentPreview operation optionally returns delivery windows for scheduling Multi-Channel Fulfillment orders. This operation also provides information about unfulfillable items in fulfillment order previews.
CreateFulfillmentOrder
const mwsRequestData = {
Version: '2010-10-01',
Action: 'CreateFulfillmentOrder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerFulfillmentOrderId: 'SELLER_FULFILLMENT_ORDER_ID',
ShippingSpeedCategory: 'SHIPPING_SPEED_CATEGORY',
DisplayableOrderId: 'DISPLAYABLE_ORDER_ID',
DisplayableOrderDateTime: 'DISPLAYABLE_ORDER_DATE_TIME',
DisplayableOrderComment: 'DISPLAYABLE_ORDER_COMMENT',
'DestinationAddress.Name': 'NAME',
'DestinationAddress.Line1': 'LINE_1',
'DestinationAddress.Line2': 'LINE_2',
'DestinationAddress.City': 'CITY',
'DestinationAddress.StateOrProvinceCode': 'STATE_OR_PROVINCE_CODE',
'DestinationAddress.PostalCode': 'POSTAL_CODE',
'DestinationAddress.CountryCode': 'COUNTRY_CODE',
'DestinationAddress.DistrictOrCounty': 'DISTRICT_OR_COUNTY',
'DestinationAddress.PhoneNumber': 'PHONE_NUMBER',
'Items.member.1.DisplayableComment': 'DISPLAYABLE_COMMENT',
'Items.member.1.GiftMessage': 'GIFT_MESSAGE',
'Items.member.1.PerUnitDeclaredValue.Value': 'VALUE',
'Items.member.1.PerUnitDeclaredValue.CurrencyCode': 'CURRENCY_CODE',
'Items.member.1.FulfillmentNetworkSKU': 'FULFILLMENT_NETWORK_SKU',
'Items.member.1.Quantity': 'QUANTITY',
'Items.member.1.SellerFulfillmentOrderItemId': 'SELLER_FULFILLMENT_ORDER_ITEM_ID',
'Items.member.1.SellerSKU': 'SELLER_SKU',
MarketplaceId: 'MARKETPLACE_ID',
FulfillmentAction: 'FULFILLMENT_ACTION'
};
try {
const response = await amazonMws.fulfillmentOutboundShipment.create(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'CreateFulfillmentOrder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerFulfillmentOrderId: 'SELLER_FULFILLMENT_ORDER_ID',
ShippingSpeedCategory: 'SHIPPING_SPEED_CATEGORY',
DisplayableOrderId: 'DISPLAYABLE_ORDER_ID',
DisplayableOrderDateTime: 'DISPLAYABLE_ORDER_DATE_TIME',
DisplayableOrderComment: 'DISPLAYABLE_ORDER_COMMENT',
'DestinationAddress.Name': 'NAME',
'DestinationAddress.Line1': 'LINE_1',
'DestinationAddress.Line2': 'LINE_2',
'DestinationAddress.City': 'CITY',
'DestinationAddress.StateOrProvinceCode': 'STATE_OR_PROVINCE_CODE',
'DestinationAddress.PostalCode': 'POSTAL_CODE',
'DestinationAddress.CountryCode': 'COUNTRY_CODE',
'DestinationAddress.DistrictOrCounty': 'DISTRICT_OR_COUNTY',
'DestinationAddress.PhoneNumber': 'PHONE_NUMBER',
'Items.member.1.DisplayableComment': 'DISPLAYABLE_COMMENT',
'Items.member.1.GiftMessage': 'GIFT_MESSAGE',
'Items.member.1.PerUnitDeclaredValue.Value': 'VALUE',
'Items.member.1.PerUnitDeclaredValue.CurrencyCode': 'CURRENCY_CODE',
'Items.member.1.FulfillmentNetworkSKU': 'FULFILLMENT_NETWORK_SKU',
'Items.member.1.Quantity': 'QUANTITY',
'Items.member.1.SellerFulfillmentOrderItemId': 'SELLER_FULFILLMENT_ORDER_ITEM_ID',
'Items.member.1.SellerSKU': 'SELLER_SKU',
MarketplaceId: 'MARKETPLACE_ID',
FulfillmentAction: 'FULFILLMENT_ACTION'
};
amazonMws.fulfillmentOutboundShipment.create(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'CreateFulfillmentOrder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerFulfillmentOrderId: 'SELLER_FULFILLMENT_ORDER_ID',
ShippingSpeedCategory: 'SHIPPING_SPEED_CATEGORY',
DisplayableOrderId: 'DISPLAYABLE_ORDER_ID',
DisplayableOrderDateTime: 'DISPLAYABLE_ORDER_DATE_TIME',
DisplayableOrderComment: 'DISPLAYABLE_ORDER_COMMENT',
'DestinationAddress.Name': 'NAME',
'DestinationAddress.Line1': 'LINE_1',
'DestinationAddress.Line2': 'LINE_2',
'DestinationAddress.City': 'CITY',
'DestinationAddress.StateOrProvinceCode': 'STATE_OR_PROVINCE_CODE',
'DestinationAddress.PostalCode': 'POSTAL_CODE',
'DestinationAddress.CountryCode': 'COUNTRY_CODE',
'DestinationAddress.DistrictOrCounty': 'DISTRICT_OR_COUNTY',
'DestinationAddress.PhoneNumber': 'PHONE_NUMBER',
'Items.member.1.DisplayableComment': 'DISPLAYABLE_COMMENT',
'Items.member.1.GiftMessage': 'GIFT_MESSAGE',
'Items.member.1.PerUnitDeclaredValue.Value': 'VALUE',
'Items.member.1.PerUnitDeclaredValue.CurrencyCode': 'CURRENCY_CODE',
'Items.member.1.FulfillmentNetworkSKU': 'FULFILLMENT_NETWORK_SKU',
'Items.member.1.Quantity': 'QUANTITY',
'Items.member.1.SellerFulfillmentOrderItemId': 'SELLER_FULFILLMENT_ORDER_ITEM_ID',
'Items.member.1.SellerSKU': 'SELLER_SKU',
MarketplaceId: 'MARKETPLACE_ID',
FulfillmentAction: 'FULFILLMENT_ACTION'
};
amazonMws.fulfillmentOutboundShipment.create(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "d95be26c-16cf-4bbc-ab58-dce89fd4ac53"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Requests that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address.
Description
The CreateFulfillmentOrder operation generates a request for Amazon to ship items from the seller's inventory in Amazon's fulfillment network to a destination address.
ListAllFulfillmentOrders
const mwsRequestData = {
Version: '2010-10-01',
Action: 'ListAllFulfillmentOrders',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
QueryStartDateTime: new Date(2016, 11, 24)
};
try {
const response = await amazonMws.fulfillmentOutboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListAllFulfillmentOrders',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
QueryStartDateTime: new Date(2016, 11, 24)
};
amazonMws.fulfillmentOutboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListAllFulfillmentOrders',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
QueryStartDateTime: new Date(2016, 11, 24)
};
amazonMws.fulfillmentOutboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "7e9c8d48-8e79-11df-929f-87c80302f8f6"
},
"Result": {
"NextToken": "H4sIAAAAAAAAAC2MwQqDMBBEfyXsPXU3ITUEEyjFQ6FWUNt7sbEI
alH7/3SVwjLLG3iTzeLjoe6n9xAv3ziWyysuIFoPCjGVqCWmDaZOWYckkRNB9B4MgZj
4MY0euuewRhBxswhZkaQbUk5pZ+iA1nK1m+u+ayXxlmnwyCXffzdkXTiXt/pe5FWWdB
tWeVE+Ttedkjn8AF4nvJquAAAA",
"FulfillmentOrders": {
"member": [
{
"ShippingSpeedCategory": "Standard",
"StatusUpdatedDateTime": "2011-01-28T23:48:48Z",
"NotificationEmailList": {
"member": "[email protected]"
},
"SellerFulfillmentOrderId": "extern_id_1154539615776",
"DestinationAddress": {
"PostalCode": "98101",
"PhoneNumber": "321-098-7654",
"Name": "Jane Adams",
"CountryCode": "US",
"Line1": "123 Oak St.",
"StateOrProvinceCode": "WA",
"City": "Seattle",
"Line2": "Apt. 321"
},
"DisplayableOrderDateTime": "2011-02-05T17:26:56Z",
"FulfillmentPolicy": "FillOrKill",
"ReceivedDateTime": "2011-02-06T17:26:56Z",
"DisplayableOrderId": "test_displayable_id",
"DisplayableOrderComment": "Sample comment text.",
"FulfillmentOrderStatus": "PROCESSING"
},
{
"ShippingSpeedCategory": "Standard",
"StatusUpdatedDateTime": "2011-03-05T18:48:53Z",
"SellerFulfillmentOrderId": "external-order-ebaytime1154557376014",
"DestinationAddress": {
"PostalCode": "98104",
"PhoneNumber": "123-123-4567",
"Name": "George Jones",
"CountryCode": "US",
"Line1": "2345 5th Ave",
"StateOrProvinceCode": "WA",
"City": "Seattle"
},
"DisplayableOrderDateTime": "2011-03-11T18:48:52Z",
"FulfillmentPolicy": "FillAllAvailable",
"ReceivedDateTime": "2011-03-03T18:48:53Z",
"DisplayableOrderId": "test-order-test-1159210132812",
"DisplayableOrderComment": "Sample order comment.",
"FulfillmentOrderStatus": "PLANNING"
}
]
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of fulfillment orders fulfilled after (or at) a specified date.
Description
The ListAllFulfillmentOrders operation returns a list of fulfillment orders that were updated after (or at) a specified date. This operation returns general fulfillment order information but does not return item-level or shipment-level information. The ListAllFulfillmentOrders operation returns a maximum of 50 fulfillment orders. If there are additional fulfillment orders to return, NextToken is returned in the response. To retrieve all of the fulfillment orders, pass the value of NextToken to the ListInboundShipmentItemsByNextToken operation and repeat until NextToken is no longer returned.
UpdateFulfillmentOrder
const mwsRequestData = {
Version: '2010-10-01',
Action: 'UpdateFulfillmentOrder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerFulfillmentOrderId: 'SELLER_FULFILLMENT_ORDER_ID',
ShippingSpeedCategory: 'SHIPPING_SPEED_CATEGORY',
DisplayableOrderId: 'DISPLAYABLE_ORDER_ID',
DisplayableOrderDateTime: 'DISPLAYABLE_ORDER_DATE_TIME',
DisplayableOrderComment: 'DISPLAYABLE_ORDER_COMMENT',
'DestinationAddress.Name': 'NAME',
'DestinationAddress.Line1': 'LINE_1',
'DestinationAddress.Line2': 'LINE_2',
'DestinationAddress.StateOrProvinceCode': 'STATE_OR_PROVINCE_CODE',
'DestinationAddress.PostalCode': 'POSTAL_CODE',
'DestinationAddress.CountryCode': 'COUNTRY_CODE',
'Items.member.1.DisplayableComment': 'DISPLAYABLE_COMMENT',
'Items.member.1.GiftMessage': 'GIFT_MESSAGE',
'Items.member.1.PerUnitDeclaredValue.Value': 'VALUE',
'Items.member.1.PerUnitDeclaredValue.CurrencyCode': 'CURRENCY_CODE',
'Items.member.1.Quantity': 'QUANTITY',
'Items.member.1.SellerFulfillmentOrderItemId': 'SELLER_FULFILLMENT_ORDER_ITEM_ID',
MarketplaceId: 'MARKETPLACE_ID',
FulfillmentAction: 'FULFILLMENT_ACTION',
'NotificationEmailList.member.1': 'NOTIFICATION_EMAIL_LIST'
};
try {
const response = await amazonMws.fulfillmentOutboundShipment.create(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'UpdateFulfillmentOrder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerFulfillmentOrderId: 'SELLER_FULFILLMENT_ORDER_ID',
ShippingSpeedCategory: 'SHIPPING_SPEED_CATEGORY',
DisplayableOrderId: 'DISPLAYABLE_ORDER_ID',
DisplayableOrderDateTime: 'DISPLAYABLE_ORDER_DATE_TIME',
DisplayableOrderComment: 'DISPLAYABLE_ORDER_COMMENT',
'DestinationAddress.Name': 'NAME',
'DestinationAddress.Line1': 'LINE_1',
'DestinationAddress.Line2': 'LINE_2',
'DestinationAddress.StateOrProvinceCode': 'STATE_OR_PROVINCE_CODE',
'DestinationAddress.PostalCode': 'POSTAL_CODE',
'DestinationAddress.CountryCode': 'COUNTRY_CODE',
'Items.member.1.DisplayableComment': 'DISPLAYABLE_COMMENT',
'Items.member.1.GiftMessage': 'GIFT_MESSAGE',
'Items.member.1.PerUnitDeclaredValue.Value': 'VALUE',
'Items.member.1.PerUnitDeclaredValue.CurrencyCode': 'CURRENCY_CODE',
'Items.member.1.Quantity': 'QUANTITY',
'Items.member.1.SellerFulfillmentOrderItemId': 'SELLER_FULFILLMENT_ORDER_ITEM_ID',
MarketplaceId: 'MARKETPLACE_ID',
FulfillmentAction: 'FULFILLMENT_ACTION',
'NotificationEmailList.member.1': 'NOTIFICATION_EMAIL_LIST'
};
amazonMws.fulfillmentOutboundShipment.create(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'UpdateFulfillmentOrder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerFulfillmentOrderId: 'SELLER_FULFILLMENT_ORDER_ID',
ShippingSpeedCategory: 'SHIPPING_SPEED_CATEGORY',
DisplayableOrderId: 'DISPLAYABLE_ORDER_ID',
DisplayableOrderDateTime: 'DISPLAYABLE_ORDER_DATE_TIME',
DisplayableOrderComment: 'DISPLAYABLE_ORDER_COMMENT',
'DestinationAddress.Name': 'NAME',
'DestinationAddress.Line1': 'LINE_1',
'DestinationAddress.Line2': 'LINE_2',
'DestinationAddress.StateOrProvinceCode': 'STATE_OR_PROVINCE_CODE',
'DestinationAddress.PostalCode': 'POSTAL_CODE',
'DestinationAddress.CountryCode': 'COUNTRY_CODE',
'Items.member.1.DisplayableComment': 'DISPLAYABLE_COMMENT',
'Items.member.1.GiftMessage': 'GIFT_MESSAGE',
'Items.member.1.PerUnitDeclaredValue.Value': 'VALUE',
'Items.member.1.PerUnitDeclaredValue.CurrencyCode': 'CURRENCY_CODE',
'Items.member.1.Quantity': 'QUANTITY',
'Items.member.1.SellerFulfillmentOrderItemId': 'SELLER_FULFILLMENT_ORDER_ITEM_ID',
MarketplaceId: 'MARKETPLACE_ID',
FulfillmentAction: 'FULFILLMENT_ACTION',
'NotificationEmailList.member.1': 'NOTIFICATION_EMAIL_LIST'
};
amazonMws.fulfillmentOutboundShipment.create(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "d95be26c-16cf-4bbc-ab58-dce89fd4ac53"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Updates and/or requests shipment for a fulfillment order with an order hold on it.
Description
With the UpdateFulfillmentOrder operation, you can update and/or ship a fulfillment order with an order hold on it.
GetFulfillmentOrder
const mwsRequestData = {
Version: '2010-10-01',
Action: 'GetFulfillmentOrder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerFulfillmentOrderId: 'SELLER_FULFILLMENT_ORDER_ID'
};
try {
const response = await amazonMws.fulfillmentOutboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetFulfillmentOrder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerFulfillmentOrderId: 'SELLER_FULFILLMENT_ORDER_ID'
};
amazonMws.fulfillmentOutboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetFulfillmentOrder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerFulfillmentOrderId: 'SELLER_FULFILLMENT_ORDER_ID'
};
amazonMws.fulfillmentOutboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "5e5e5694-8e76-11df-929f-87c80302f8f6"
},
"Result": {
"FulfillmentOrderItem": {
"member": [
{
"SellerSKU": "SKU100",
"GiftMessage": "giftwrap_message",
"SellerFulfillmentOrderItemId": "merchant_order_item_id_2",
"EstimatedShipDateTime": "2016-09-03T07:07:53Z",
"DisplayableComment": "Example comment",
"UnfulfillableQuantity": "0",
"CancelledQuantity": "1",
"Quantity": "5",
"EstimatedArrivalDateTime": "2016-09-05T08:07:53Z",
"PerUnitPrice": {
"Value": ",2500",
"CurrencyCode": "JPY"
},
"PerUnitTax": {
"Value": ",5000",
"CurrencyCode": "JPY"
}
},
{
"SellerSKU": "SKU101",
"GiftMessage": "giftwrap_message",
"SellerFulfillmentOrderItemId": "merchant_order_item_id_1",
"EstimatedShipDateTime": "2016-09-03T07:07:53Z",
"DisplayableComment": "Example comment",
"UnfulfillableQuantity": "2",
"CancelledQuantity": "1",
"Quantity": "5",
"EstimatedArrivalDateTime": "2016-09-05T08:07:53Z",
"PerUnitPrice": {
"Value": ",1000",
"CurrencyCode": "JPY"
},
"PerUnitTax": {
"Value": ",2000",
"CurrencyCode": "JPY"
}
}
]
},
"FulfillmentOrder": {
"ShippingSpeedCategory": "ScheduledDelivery",
"DeliveryWindow": {
"StartDateTime": "2016-09-05T03:00:00Z",
"EndDateTime": "2016-09-05T05:00:00Z"
},
"NotificationEmailList": {
"member": "[email protected]"
},
"StatusUpdatedDateTime": "2016-09-05T23:48:48Z",
"SellerFulfillmentOrderId": "extern_id_1154539615776",
"DestinationAddress": {
"PostalCode": "153-0002",
"Name": "Amazon Taro",
"CountryCode": "JP",
"Line1": "Meguro-ku Shimomeguro 12-34-56",
"StateOrProvinceCode": "Tokyo",
"Line2": "XXX building 101"
},
"DisplayableOrderDateTime": "2016-09-02T17:26:56Z",
"FulfillmentPolicy": "FillOrKill",
"ReceivedDateTime": "2016-09-02T17:26:56Z",
"DisplayableOrderId": "test_displayable_id",
"DisplayableOrderComment": "Sample comment",
"CODSettings": {
"IsCODRequired": "true",
"CODCharge": {
"Value": ",4000",
"CurrencyCode": "JPY"
},
"CODChargeTax": {
"Value": ",300",
"CurrencyCode": "JPY"
},
"ShippingCharge": {
"Value": ",1000",
"CurrencyCode": "JPY"
},
"ShippingChargeTax": {
"Value": ",75",
"CurrencyCode": "JPY"
}
},
"FulfillmentOrderStatus": "PROCESSING",
"FulfillmentAction": "Ship",
"MarketplaceId": "ATVPDKIKX0DER"
},
"FulfillmentShipment": {
"member": [
{
"FulfillmentShipmentStatus": "PENDING",
"FulfillmentShipmentItem": {
"member": {
"SellerSKU": "SKU100",
"SellerFulfillmentOrderItemId": "merchant_order_item_id_2",
"Quantity": "2",
"PackageNumber": "0"
}
},
"AmazonShipmentId": "DnMDLWJWN",
"ShippingDateTime": "2016-09-03T07:00:00Z",
"FulfillmentCenterId": "RNO1",
"EstimatedArrivalDateTime": "2016-09-04T07:00:00Z"
},
{
"FulfillmentShipmentStatus": "SHIPPED",
"FulfillmentShipmentItem": {
"member": {
"SellerSKU": "SKU101",
"SellerFulfillmentOrderItemId": "merchant_order_item_id_1",
"Quantity": "1",
"PackageNumber": "1"
}
},
"AmazonShipmentId": "DKMKLXJmN",
"ShippingDateTime": "2016-09-03T07:00:00Z",
"FulfillmentShipmentPackage": {
"member": {
"TrackingNumber": "93ZZ00",
"CarrierCode": "UPS",
"PackageNumber": "1"
}
},
"FulfillmentCenterId": "TST1",
"EstimatedArrivalDateTime": "2016-09-05T07:00:00Z"
}
]
},
"ReturnItemList": {
"ReturnItem": {
"SellerReturnItemId": "16a6a142EXAMPLE",
"SellerFulfillmentOrderItemId": "order-item-1",
"AmazonShipmentId": "DLHg36GDN",
"ReturnReasonCode": "REASON-CODE",
"ReturnComment": "Did not like color",
"AmazonReturnReasonCode": "OTHER-REASON-CODE",
"Status": "Processed",
"StatusChangedDate": "2016-09-02T02:40:36Z",
"ReturnAuthorizationId": "amzn-rma-id",
"ReturnReceivedCondition": "Sellable",
"FulfillmentCenterId": "FC123"
}
},
"ReturnAuthorizationList": {
"ReturnAuthorization": {
"ReturnAuthorizationId": "amzn-rma-id",
"FulfillmentCenterId": "FC123",
"ReturnToAddress": {
"Name": "Amazon FC",
"Line1": "123 Main Street",
"City": "Anywhere",
"StateOrRegionCode": "WA",
"PostalCode": "98122",
"CountryCode": "US"
},
"AmazonRmaId": "test123",
"RmaPageURL": "https://sellercentral.amazon.com/URL"
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a fulfillment order based on a specified SellerFulfillmentOrderId.
Description
The GetFulfillmentOrder operation returns a fulfillment order based on a SellerFulfillmentOrderId that you specify. This operation returns general fulfillment order information as well as item-level and shipment-level information.
ListAllFulfillmentOrdersByNextToken
const mwsRequestData = {
Version: '2010-10-01',
Action: 'ListAllFulfillmentOrdersByNextToken',
NextToken: 'NEXT_TOKEN'
};
try {
const response = await amazonMws.fulfillmentOutboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListAllFulfillmentOrdersByNextToken',
NextToken: 'NEXT_TOKEN'
};
amazonMws.fulfillmentOutboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListAllFulfillmentOrdersByNextToken',
NextToken: 'NEXT_TOKEN'
};
amazonMws.fulfillmentOutboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"NextToken": "H4sIAAAAAAAAAC2M0QqCQBBFf2WZ982ZXVeHxRUifMsEs96jVhIq0fX/ab
VguMw5cG8xidFBGJanXHxY5Dg//Px7ibI0N0YTMacg7g4UYha1VNyRschWGxkTEcTggJBAf
ByYiG8H/e0VPAi/1ggl5pJ0R8oqbQ3tkDmqrRq2YV6H0XSYRRnvP1wWfdlWdXP
dH4ukX+nQnM6Xumo3TKbyC+hpQInCAAAA",
"ResponseMetadata": {
"RequestId": "f14964dd-8e79-11df-929f-87c80302f8f6"
},
"Result": {
"FulfillmentOrders": {
"member": [
{
"ShippingSpeedCategory": "Standard",
"StatusUpdatedDateTime": "2011-01-02T07:49:35Z",
"SellerFulfillmentOrderId": "SampleOrderId",
"DestinationAddress": {
"PostalCode": "98101",
"PhoneNumber": "123-456-7890",
"Name": "Fred Jones",
"CountryCode": "US",
"Line1": "Amazon.com",
"StateOrProvinceCode": "WA",
"City": "Seattle"
},
"DisplayableOrderDateTime": "2011-01-08T08:00:00Z",
"FulfillmentPolicy": "FillAllAvailable",
"ReceivedDateTime": "2011-01-08T17:23:20Z",
"DisplayableOrderId": "MinimalOrder",
"DisplayableOrderComment": "Sample order comment",
"FulfillmentOrderStatus": "PROCESSING"
},
{
"ShippingSpeedCategory": "Standard",
"StatusUpdatedDateTime": "2011-02-20T19:00:07Z",
"SellerFulfillmentOrderId": "SampleOrderId",
"DestinationAddress": {
"PostalCode": "98101",
"PhoneNumber": "098-765-4321",
"Name": "Mary Johnson",
"CountryCode": "US",
"Line1": "456 7th Ave",
"StateOrProvinceCode": "WA",
"City": "Seattle"
},
"DisplayableOrderDateTime": "2011-02-25T07:00:00Z",
"FulfillmentPolicy": "FillAllAvailable",
"ReceivedDateTime": "2011-02-25T18:47:49Z",
"DisplayableOrderId": "SampleOrderID",
"DisplayableOrderComment": "Sample order comment.",
"FulfillmentOrderStatus": "PROCESSING"
}
]
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the next page of fulfillment orders using the NextToken parameter.
Description
The ListAllFulfillmentOrdersByNextToken operation returns the next page of fulfillment orders using the NextToken value that was returned by your previous request to either ListAllFulfillmentOrders or ListAllFulfillmentOrdersByNextToken. If NextToken is not returned, there are no more pages to return.
GetPackageTrackingDetails
const mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPackageTrackingDetails',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
PackageNumber: 'PACKAGE_NUMBER'
};
try {
const response = await amazonMws.fulfillmentOutboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPackageTrackingDetails',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
PackageNumber: 'PACKAGE_NUMBER'
};
amazonMws.fulfillmentOutboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetPackageTrackingDetails',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
PackageNumber: 'PACKAGE_NUMBER'
};
amazonMws.fulfillmentOutboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetaData": {
"RequestId": "5e5e5694-8e76-11df-929f-87c80302f8f6"
},
"Result": {
"PackageNumber": "42343",
"TrackingNumber": "3A18351E0390447173",
"CarrierCode": "UPS",
"CarrierPhoneNumber": "206-000-0000",
"CarrierURL": "http://www.ups.com/",
"ShipDate": "2012-03-09T10:27:10Z",
"ShipToAddress": {
"City": "Seattle",
"State": "WA",
"Country": "US"
},
"CurrentStatus": "DELIVERED",
"SignedForBy": "John",
"EstimatedArrivalDate": "2012-03-09T10:00:00Z",
"TrackingEvents": {
"member": [
{
"EventDate": "2012-03-09T08:48:53Z",
"EventAddress": {
"City": "Reno",
"State": "NV",
"Country": "US"
},
"EventCode": "EVENT_202"
},
{
"EventDate": "2012-03-10T10:27:10Z",
"EventAddress": {
"City": "Seattle",
"State": "WA",
"Country": "US"
},
"EventCode": "EVENT_301"
}
]
},
"AdditionalLocationInfo": "FRONT_DESK"
},
"ResponseMetadata": {},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order.
Description
The GetPackageTrackingDetails operation returns delivery tracking information for a package in an outbound shipment, based on the PackageNumber that you specify. This operation returns the current tracking status of the package as well as a list of tracking events.
CancelFulfillmentOrder
const mwsRequestData = {
Version: '2010-10-01',
Action: 'CancelFulfillmentOrder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerFulfillmentOrderId: 'SELLER_FULFILLMENT_ORDER_ID'
};
try {
const response = await amazonMws.fulfillmentOutboundShipment.create(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'CancelFulfillmentOrder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerFulfillmentOrderId: 'SELLER_FULFILLMENT_ORDER_ID'
};
amazonMws.fulfillmentOutboundShipment.create(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'CancelFulfillmentOrder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerFulfillmentOrderId: 'SELLER_FULFILLMENT_ORDER_ID'
};
amazonMws.fulfillmentOutboundShipment.create(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "d95be26c-16cf-4bbc-ab58-dce89fd4ac53"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Requests that Amazon stop attempting to fulfill an existing fulfillment order.
Description
The CancelFulfillmentOrder operation requests that Amazon stop attempting to ship the items in an existing fulfillment order. Amazon attempts to stop shipment of items that have not already shipped, but cannot guarantee success. You can check the extent to which the cancellation of your fulfillment order succeeded by submitting the GetFulfillmentOrder operation. Submit the same SellerFulfillmentOrderId that you submitted with the CancelFulfillmentOrder operation. The GetFulfillmentOrder operation returns the cancelled quantity for each item in the fulfillment order.
ListReturnReasonCodes
const mwsRequestData = {
Version: '2010-10-01',
Action: 'ListReturnReasonCodes',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKETPLACE_ID',
SellerSKU: 'SELLER_SKU',
Language: 'LANGUAGE'
};
try {
const response = await amazonMws.fulfillmentOutboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListReturnReasonCodes',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKETPLACE_ID',
SellerSKU: 'SELLER_SKU',
Language: 'LANGUAGE'
};
amazonMws.fulfillmentOutboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'ListReturnReasonCodes',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKETPLACE_ID',
SellerSKU: 'SELLER_SKU',
Language: 'LANGUAGE'
};
amazonMws.fulfillmentOutboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "5e5e5694-8e76-11df-929f-87c80302f8f6"
},
"Result": {
"ReasonCodeDetailsList": {
"ReasonCodeDetails": {
"ReturnReasonCode": "REASON-CODE",
"Description": "This is a description of the reason code.",
"TranslatedDescription": "This is an optional translated description of the reason code."
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of return reason codes for a seller SKU in a given marketplace.
Description
The ListReturnReasonCodes operation returns a list of valid return reasons codes for a seller SKU in a given marketplace. Valid reason codes are required in subsequent calls to the CreateFulfillmentReturn operation.
CreateFulfillmentReturn
const mwsRequestData = {
Version: '2010-10-01',
Action: 'CreateFulfillmentReturn',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerFulfillmentOrderId: 'SELLER_FULFILLMENT_ORDER_ID',
'Items.member.1.SellerReturnItemId': 'SELLER_RETURN_ITEM_ID',
'Items.member.1.SellerFulfillmentOrderItemId': 'ITEMS_MEMBER_SELLER_FULFILLMENT_ORDER_ID',
'Items.member.1.AmazonShipmentId': 'AMAZON_SHIPMENT_ID',
'Items.member.1.ReturnReasonCode': 'RETURN_REASON_CODE',
'Items.member.1.ReturnComment': 'RETURN_COMMENT'
};
try {
const response = await amazonMws.fulfillmentOutboundShipment.create(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'CreateFulfillmentReturn',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerFulfillmentOrderId: 'SELLER_FULFILLMENT_ORDER_ID',
'Items.member.1.SellerReturnItemId': 'SELLER_RETURN_ITEM_ID',
'Items.member.1.SellerFulfillmentOrderItemId': 'ITEMS_MEMBER_SELLER_FULFILLMENT_ORDER_ID',
'Items.member.1.AmazonShipmentId': 'AMAZON_SHIPMENT_ID',
'Items.member.1.ReturnReasonCode': 'RETURN_REASON_CODE',
'Items.member.1.ReturnComment': 'RETURN_COMMENT'
};
amazonMws.fulfillmentOutboundShipment.create(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'CreateFulfillmentReturn',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerFulfillmentOrderId: 'SELLER_FULFILLMENT_ORDER_ID',
'Items.member.1.SellerReturnItemId': 'SELLER_RETURN_ITEM_ID',
'Items.member.1.SellerFulfillmentOrderItemId': 'ITEMS_MEMBER_SELLER_FULFILLMENT_ORDER_ID',
'Items.member.1.AmazonShipmentId': 'AMAZON_SHIPMENT_ID',
'Items.member.1.ReturnReasonCode': 'RETURN_REASON_CODE',
'Items.member.1.ReturnComment': 'RETURN_COMMENT'
};
amazonMws.fulfillmentOutboundShipment.create(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"CreateFulfillmenReturnResponse": {
"CreateFulfillmentReturnResult": {
"ReturnItemList": {
"ReturnItem": {
"SellerReturnItemId": "16a6a142EXAMPLE",
"SellerFulfillmentOrderItemId": "order-item-1",
"AmazonShipmentId": "DLHg36GDN",
"SellerReturnReasonCode": "REASON-CODE",
"ReturnComment": "Did not like color",
"AmazonReturnReasonCode": "OTHER-REASON-CODE",
"Status": "Processed",
"StatusChangedDate": "2016-09-29T02:40:36Z",
"ReturnAuthorizationId": "amzn-rma-id",
"ReturnReceivedCondition": "Sellable",
"FulfillmentCenterId": "FC123"
}
},
"InvalidReturnItemList": {
"InvalidReturnItem": {
"SellerReturnItemId": "20a6a142EXAMPLE",
"SellerFulfillmentOrderItemId": "order-item-2",
"InvalidItemReason": {
"InvalidItemReasonCode": "DuplicateRequest",
"Description": "There are duplicate return requests for this item."
}
}
},
"ReturnAuthorizationList": {
"ReturnAuthorization": {
"ReturnAuthorizationId": "amzn-rma-id",
"FulfillmentCenterId": "FC123",
"ReturnToAddress": {
"Name": "Amazon FC",
"Line1": "123 Main Street",
"City": "Anywhere",
"StateOrRegionCode": "WA",
"PostalCode": "98122",
"CountryCode": "US"
},
"AmazonRmaId": "test123",
"RmaPageURL": "https://sellercentral.amazon.com/URL"
}
}
},
"ResponseMetadata": {
"RequestId": "5e5e5694-8e76-11df-929f-87c80302f8f6"
}
},
"ResponseMetadata": {},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Creates a fulfillment return.
Description
The CreateFulfillmentReturn operation creates a fulfillment return for items that were fulfilled using the CreateFulfillmentOrder operation. For calls to CreateFulfillmentReturn you must include ReturnReasonCode values returned by a previous call to the ListReturnReasonCodes operation.
GetServiceStatus
const mwsRequestData = {
Version: '2010-10-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
};
try {
const response = await amazonMws.fulfillmentOutboundShipment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
};
amazonMws.fulfillmentOutboundShipment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2010-10-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
};
amazonMws.fulfillmentOutboundShipment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "d80c6c7b-f7c7-4fa7-bdd7-854711cb3bcc"
},
"Result": {
"Status": "GREEN",
"Timestamp": "2010-11-01T21:38:09.676Z"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the operational status of the Fulfillment Outbound Shipment API section.
Description
The GetServiceStatus operation returns the operational status of the Fulfillment Outbound Shipment API section of Amazon Marketplace Web Service. Status values are GREEN, YELLOW, and RED.
MerchantFulfillment
CreateShipment
const mwsRequestData = {
Version: '2015-06-01',
Action: 'CreateShipment',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShippingServiceId: 'SHIPPING_SERVICE_ID',
'ShipmentRequestDetails.AmazonOrderId': 'AMAZON_ORDER_ID',
'ShipmentRequestDetails.PackageDimensions.Length': 'PACKAGE_LENGTH',
'ShipmentRequestDetails.PackageDimensions.Width': 'PACKAGE_WIDTH',
'ShipmentRequestDetails.PackageDimensions.Height': 'PACKAGE_HEIGHT',
'ShipmentRequestDetails.PackageDimensions.Unit': 'PACKAGE_UNIT',
'ShipmentRequestDetails.Weight.Value': 'WEIGHT_VALUE',
'ShipmentRequestDetails.Weight.Unit': 'WEIGHT_UNIT',
'ShipmentRequestDetails.ShipFromAddress.Name': 'SHIP_FROM_ADDRESS_NAME',
'ShipmentRequestDetails.ShipFromAddress.AddressLine1': 'SHIP_FROM_ADDRESS_LINE_1',
'ShipmentRequestDetails.ShipFromAddress.City': 'SHIP_FROM_ADDRESS_CITY',
'ShipmentRequestDetails.ShipFromAddress.StateOrProvinceCode': 'SHIP_FROM_ADDRESS_STATE_OR_PROVINCE_CODE',
'ShipmentRequestDetails.ShipFromAddress.PostalCode': 'SHIP_FROM_ADDRESS_POSTAL_CODE',
'ShipmentRequestDetails.ShipFromAddress.CountryCode': 'SHIP_FROM_ADDRESS_COUNTRY_CODE',
'ShipmentRequestDetails.ShipFromAddress.Email': 'SHIP_FROM_ADDRESS_EMAIL',
'ShipmentRequestDetails.ShipFromAddress.Phone': 'SHIP_FROM_ADDRESS_PHONE',
'ShipmentRequestDetails.ShippingServiceOptions.DeliveryExperience': 'DELIVERY_EXPERIENCE',
'ShipmentRequestDetails.ShippingServiceOptions.CarrierWillPickUp': 'CARRIER_WILL_PICKUP',
'ShipmentRequestDetails.ItemList.Item.1.OrderItemId': 'ORDER_ITEM_ID',
'ShipmentRequestDetails.ItemList.Item.1.Quantity': 'QUANTITY'
};
try {
const response = await amazonMws.merchantFulfillment.create(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
const mwsRequestData = {
Version: '2015-06-01',
Action: 'CreateShipment',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShippingServiceId: 'SHIPPING_SERVICE_ID',
'ShipmentRequestDetails.AmazonOrderId': 'AMAZON_ORDER_ID',
'ShipmentRequestDetails.PackageDimensions.Length': 'PACKAGE_LENGTH',
'ShipmentRequestDetails.PackageDimensions.Width': 'PACKAGE_WIDTH',
'ShipmentRequestDetails.PackageDimensions.Height': 'PACKAGE_HEIGHT',
'ShipmentRequestDetails.PackageDimensions.Unit': 'PACKAGE_UNIT',
'ShipmentRequestDetails.Weight.Value': 'WEIGHT_VALUE',
'ShipmentRequestDetails.Weight.Unit': 'WEIGHT_UNIT',
'ShipmentRequestDetails.ShipFromAddress.Name': 'SHIP_FROM_ADDRESS_NAME',
'ShipmentRequestDetails.ShipFromAddress.AddressLine1': 'SHIP_FROM_ADDRESS_LINE_1',
'ShipmentRequestDetails.ShipFromAddress.City': 'SHIP_FROM_ADDRESS_CITY',
'ShipmentRequestDetails.ShipFromAddress.StateOrProvinceCode': 'SHIP_FROM_ADDRESS_STATE_OR_PROVINCE_CODE',
'ShipmentRequestDetails.ShipFromAddress.PostalCode': 'SHIP_FROM_ADDRESS_POSTAL_CODE',
'ShipmentRequestDetails.ShipFromAddress.CountryCode': 'SHIP_FROM_ADDRESS_COUNTRY_CODE',
'ShipmentRequestDetails.ShipFromAddress.Email': 'SHIP_FROM_ADDRESS_EMAIL',
'ShipmentRequestDetails.ShipFromAddress.Phone': 'SHIP_FROM_ADDRESS_PHONE',
'ShipmentRequestDetails.ShippingServiceOptions.DeliveryExperience': 'DELIVERY_EXPERIENCE',
'ShipmentRequestDetails.ShippingServiceOptions.CarrierWillPickUp': 'CARRIER_WILL_PICKUP',
'ShipmentRequestDetails.ItemList.Item.1.OrderItemId': 'ORDER_ITEM_ID',
'ShipmentRequestDetails.ItemList.Item.1.Quantity': 'QUANTITY'
};
amazonMws.merchantFulfillment.create(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
const mwsRequestData = {
Version: '2015-06-01',
Action: 'CreateShipment',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ShippingServiceId: 'SHIPPING_SERVICE_ID',
'ShipmentRequestDetails.AmazonOrderId': 'AMAZON_ORDER_ID',
'ShipmentRequestDetails.PackageDimensions.Length': 'PACKAGE_LENGTH',
'ShipmentRequestDetails.PackageDimensions.Width': 'PACKAGE_WIDTH',
'ShipmentRequestDetails.PackageDimensions.Height': 'PACKAGE_HEIGHT',
'ShipmentRequestDetails.PackageDimensions.Unit': 'PACKAGE_UNIT',
'ShipmentRequestDetails.Weight.Value': 'WEIGHT_VALUE',
'ShipmentRequestDetails.Weight.Unit': 'WEIGHT_UNIT',
'ShipmentRequestDetails.ShipFromAddress.Name': 'SHIP_FROM_ADDRESS_NAME',
'ShipmentRequestDetails.ShipFromAddress.AddressLine1': 'SHIP_FROM_ADDRESS_LINE_1',
'ShipmentRequestDetails.ShipFromAddress.City': 'SHIP_FROM_ADDRESS_CITY',
'ShipmentRequestDetails.ShipFromAddress.StateOrProvinceCode': 'SHIP_FROM_ADDRESS_STATE_OR_PROVINCE_CODE',
'ShipmentRequestDetails.ShipFromAddress.PostalCode': 'SHIP_FROM_ADDRESS_POSTAL_CODE',
'ShipmentRequestDetails.ShipFromAddress.CountryCode': 'SHIP_FROM_ADDRESS_COUNTRY_CODE',
'ShipmentRequestDetails.ShipFromAddress.Email': 'SHIP_FROM_ADDRESS_EMAIL',
'ShipmentRequestDetails.ShipFromAddress.Phone': 'SHIP_FROM_ADDRESS_PHONE',
'ShipmentRequestDetails.ShippingServiceOptions.DeliveryExperience': 'DELIVERY_EXPERIENCE',
'ShipmentRequestDetails.ShippingServiceOptions.CarrierWillPickUp': 'CARRIER_WILL_PICKUP',
'ShipmentRequestDetails.ItemList.Item.1.OrderItemId': 'ORDER_ITEM_ID',
'ShipmentRequestDetails.ItemList.Item.1.Quantity': 'QUANTITY'
};
amazonMws.merchantFulfillment.create(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "adb18f0d-2076-48d4-99ef-fb4b9f892a4e"
},
"Result": {
"Shipment": {
"Insurance": {
"CurrencyCode": "USD",
"Amount": "10.00"
},
"ShipToAddress": {
"City": "Seattle",
"Phone": {},
"CountryCode": "US",
"PostalCode": "98121-2778",
"Name": "Jane Smith",
"AddressLine1": "321 Main St",
"StateOrProvinceCode": "WA",
"Email": {}
},
"AmazonOrderId": "903-1713775-3598252",
"Weight": {
"Value": ",10",
"Unit": "oz"
},
"Label": {
"CustomTextForLabel": "ABC123",
"LabelFormat": "ZPL203",
"FileContents": {
"Checksum": "DmsWbJpdMPALN3jV4wHOrg==",
"Contents": "H4sIAAAAAAAAAK16WbeqyrLmO2Pc/zBVRLG...
...kI0Ycv76w378UfL6O6ev7UsAwmkWBfL6nycD/Bd+Zx3S8LwAA",
"FileType": "application/zpl",
"LabelFormat": "ZPL203"
},
"Dimensions": {
"Width": "8.50000",
"Length": "11.00000",
"Unit": "inches"
},
"StandardIdForLabel": "AmazonOrderId"
},
"ShippingService": {
"CarrierName": "FEDEX",
"ShippingServiceOptions": {
"CarrierWillPickUp": "false",
"DeclaredValue": {
"CurrencyCode": "USD",
"Amount": "10.00"
},
"DeliveryExperience": "DELIVERY_CONFIRMATION"
},
"ShippingServiceId": "FEDEX_PTP_PRIORITY_OVERNIGHT",
"Rate": {
"CurrencyCode": "USD",
"Amount": "27.81"
},
"LatestEstimatedDeliveryDate": "2015-09-24T10:30:00Z",
"EarliestEstimatedDeliveryDate": "2015-09-24T10:30:00Z",
"ShippingServiceOfferId": "HDDUKqtQVFetpBZAqx5c1yaCZ9vuFfND0kudyw3lLWCa
3mN2+zUOsRCAZS2oYt0ey6fXKdOAucmYVXR9LAkU9O9eys9V3FJCgvQ+vAqm4bSAzHVH04vD8oLy oUPKqxa8Otbek97Z85LFUSsfcUf8frNRMEfNLP8t5RyLXa4ZOjc=",
"ShipDate": "2015-09-23T20:10:56.829Z",
"ShippingServiceName": "FedEx Priority Overnight®"
},
"PackageDimensions": {
"Width": "5",
"Length": "5",
"Unit": "inches",
"Height": "5"
},
"CreatedDate": "2015-09-23T20:11:12.908Z",
"ShipFromAddress": {
"City": "Seattle",
"Phone": "2061234567",
"CountryCode": "US",
"PostalCode": "98121",
"Name": "John Doe",
"AddressLine1": "1234 Westlake Ave",
"StateOrProvinceCode": "WA"
},
"ShipmentId": "6f77095e-9f75-47eb-aaab-a42d5428fa1a",
"ItemList": {
"Item": {
"OrderItemId": "40525960574974",
"Quantity": "1",
"ItemWeight": "200",
"ItemDescription": "Poster"
}
},
"Status": "Purchased",
"TrackingId": "794657111237"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Description
The CreateShipment operation purchases shipping and returns PDF, PNG, or ZPL document data for a shipping label, depending on the carrier. Amazon compresses the document data before returning it as a Base64-encoded string. The CreateShipment operation also returns a Base64-encoded MD5 hash to validate the document data.
GetEligibleShippingServices
const mwsRequestData = {
Version: '2015-06-01',
Action: 'GetEligibleShippingServices',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'ShipmentRequestDetails.AmazonOrderId': 'AMAZON_ORDER_ID',
'ShipmentRequestDetails.PackageDimensions.Length': 'PACKAGE_LENGTH',
'ShipmentRequestDetails.PackageDimensions.Width': 'PACKAGE_WIDTH',
'ShipmentRequestDetails.PackageDimensions.Height': 'PACKAGE_HEIGHT',
'ShipmentRequestDetails.PackageDimensions.Unit': 'PACKAGE_UNIT',
'ShipmentRequestDetails.Weight.Value': 'WEIGHT_VALUE',
'ShipmentRequestDetails.Weight.Unit': 'WEIGHT_UNIT',
'ShipmentRequestDetails.ShipFromAddress.Name': 'SHIP_FROM_ADDRESS_NAME',
'ShipmentRequestDetails.ShipFromAddress.AddressLine1': 'SHIP_FROM_ADDRESS_LINE_1',
'ShipmentRequestDetails.ShipFromAddress.City': 'SHIP_FROM_ADDRESS_CITY',
'ShipmentRequestDetails.ShipFromAddress.StateOrProvinceCode': 'SHIP_FROM_ADDRESS_STATE_OR_PROVINCE_CODE',
'ShipmentRequestDetails.ShipFromAddress.PostalCode': 'SHIP_FROM_ADDRESS_POSTAL_CODE',
'ShipmentRequestDetails.ShipFromAddress.CountryCode': 'SHIP_FROM_ADDRESS_COUNTRY_CODE',
'ShipmentRequestDetails.ShipFromAddress.Email': 'SHIP_FROM_ADDRESS_EMAIL',
'ShipmentRequestDetails.ShipFromAddress.Phone': 'SHIP_FROM_ADDRESS_PHONE',
'ShipmentRequestDetails.ShippingServiceOptions.DeliveryExperience': 'DELIVERY_EXPERIENCE',
'ShipmentRequestDetails.ShippingServiceOptions.CarrierWillPickUp': 'CARRIER_WILL_PICKUP',
'ShipmentRequestDetails.ItemList.Item.1.OrderItemId': 'ORDER_ITEM_ID',
'ShipmentRequestDetails.ItemList.Item.1.Quantity': 'QUANTITY'
};
try {
const response = await amazonMws.merchantFulfillment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2015-06-01',
Action: 'GetEligibleShippingServices',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'ShipmentRequestDetails.AmazonOrderId': 'AMAZON_ORDER_ID',
'ShipmentRequestDetails.PackageDimensions.Length': 'PACKAGE_LENGTH',
'ShipmentRequestDetails.PackageDimensions.Width': 'PACKAGE_WIDTH',
'ShipmentRequestDetails.PackageDimensions.Height': 'PACKAGE_HEIGHT',
'ShipmentRequestDetails.PackageDimensions.Unit': 'PACKAGE_UNIT',
'ShipmentRequestDetails.Weight.Value': 'WEIGHT_VALUE',
'ShipmentRequestDetails.Weight.Unit': 'WEIGHT_UNIT',
'ShipmentRequestDetails.ShipFromAddress.Name': 'SHIP_FROM_ADDRESS_NAME',
'ShipmentRequestDetails.ShipFromAddress.AddressLine1': 'SHIP_FROM_ADDRESS_LINE_1',
'ShipmentRequestDetails.ShipFromAddress.City': 'SHIP_FROM_ADDRESS_CITY',
'ShipmentRequestDetails.ShipFromAddress.StateOrProvinceCode': 'SHIP_FROM_ADDRESS_STATE_OR_PROVINCE_CODE',
'ShipmentRequestDetails.ShipFromAddress.PostalCode': 'SHIP_FROM_ADDRESS_POSTAL_CODE',
'ShipmentRequestDetails.ShipFromAddress.CountryCode': 'SHIP_FROM_ADDRESS_COUNTRY_CODE',
'ShipmentRequestDetails.ShipFromAddress.Email': 'SHIP_FROM_ADDRESS_EMAIL',
'ShipmentRequestDetails.ShipFromAddress.Phone': 'SHIP_FROM_ADDRESS_PHONE',
'ShipmentRequestDetails.ShippingServiceOptions.DeliveryExperience': 'DELIVERY_EXPERIENCE',
'ShipmentRequestDetails.ShippingServiceOptions.CarrierWillPickUp': 'CARRIER_WILL_PICKUP',
'ShipmentRequestDetails.ItemList.Item.1.OrderItemId': 'ORDER_ITEM_ID',
'ShipmentRequestDetails.ItemList.Item.1.Quantity': 'QUANTITY'
};
amazonMws.merchantFulfillment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2015-06-01',
Action: 'GetEligibleShippingServices',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'ShipmentRequestDetails.AmazonOrderId': 'AMAZON_ORDER_ID',
'ShipmentRequestDetails.PackageDimensions.Length': 'PACKAGE_LENGTH',
'ShipmentRequestDetails.PackageDimensions.Width': 'PACKAGE_WIDTH',
'ShipmentRequestDetails.PackageDimensions.Height': 'PACKAGE_HEIGHT',
'ShipmentRequestDetails.PackageDimensions.Unit': 'PACKAGE_UNIT',
'ShipmentRequestDetails.Weight.Value': 'WEIGHT_VALUE',
'ShipmentRequestDetails.Weight.Unit': 'WEIGHT_UNIT',
'ShipmentRequestDetails.ShipFromAddress.Name': 'SHIP_FROM_ADDRESS_NAME',
'ShipmentRequestDetails.ShipFromAddress.AddressLine1': 'SHIP_FROM_ADDRESS_LINE_1',
'ShipmentRequestDetails.ShipFromAddress.City': 'SHIP_FROM_ADDRESS_CITY',
'ShipmentRequestDetails.ShipFromAddress.StateOrProvinceCode': 'SHIP_FROM_ADDRESS_STATE_OR_PROVINCE_CODE',
'ShipmentRequestDetails.ShipFromAddress.PostalCode': 'SHIP_FROM_ADDRESS_POSTAL_CODE',
'ShipmentRequestDetails.ShipFromAddress.CountryCode': 'SHIP_FROM_ADDRESS_COUNTRY_CODE',
'ShipmentRequestDetails.ShipFromAddress.Email': 'SHIP_FROM_ADDRESS_EMAIL',
'ShipmentRequestDetails.ShipFromAddress.Phone': 'SHIP_FROM_ADDRESS_PHONE',
'ShipmentRequestDetails.ShippingServiceOptions.DeliveryExperience': 'DELIVERY_EXPERIENCE',
'ShipmentRequestDetails.ShippingServiceOptions.CarrierWillPickUp': 'CARRIER_WILL_PICKUP',
'ShipmentRequestDetails.ItemList.Item.1.OrderItemId': 'ORDER_ITEM_ID',
'ShipmentRequestDetails.ItemList.Item.1.Quantity': 'QUANTITY'
};
amazonMws.merchantFulfillment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "5b7997fb-efd1-495b-b7db-03ecfa691038"
},
"Result": {
"ShippingServiceList": {
"ShippingService": {
"ShippingServiceName": "UPS Ground",
"CarrierName": "UPS",
"ShippingServiceId": "UPS_PTP_GND",
"ShippingServiceOfferId": "ly51yzA1nAXlJzmYlKaH+7WbKOWz2BTujIOPx5PU8luilmZYK/JFhbx177aKey8MdZcG90uABbT5q8WAgPI+uxcxx/XDtIbI7c161j5spbfsiPTwIJg4Bk66bnP6Ip+JJtuSU5++rAdv4mzXvKpisLGYGrc+FuJvBAjTersJhq4=",
"ShipDate": "10/16/2018 07:41:12",
"EarliestEstimatedDeliveryDate": "10/18/2018 02:00:00",
"LatestEstimatedDeliveryDate": "10/18/2018 02:00:00",
"Rate": {
"CurrencyCode": "USD",
"Amount": "16.83"
},
"ShippingServiceOptions": {
"DeliveryExperience": "DeliveryConfirmationWithoutSignature",
"CarrierWillPickUp": "False"
},
"AvailableLabelFormats": {
"LabelFormat": [
"ZPL203",
"ShippingServiceDefault",
"PDF",
"PNG"
]
},
"RequiresAdditionalSellerInputs": "False"
}
},
"RejectedShippingServiceList": {
"RejectedShippingService": {
"CarrierName": "UPS",
"ShippingServiceId": "UPS_PTP_3DS",
"RejectionReasonCode": "INELIGIBLE",
"RejectionReasonMessage": "This ship method is not eligible for this
order.",
"ShippingServiceName": "UPS Three Day Saver"
}
},
"TemporarilyUnavailableCarrierList": {
"TemporarilyUnavailableCarrier": [
{
"CarrierName": "DYNAMEX"
},
{
"CarrierName": "USPS"
},
{
"CarrierName": "DHLECOMMERCE"
},
{
"CarrierName": "SELF_DELIVERY"
},
{
"CarrierName": "ONTRAC"
},
{
"CarrierName": "DHLMX"
},
{
"CarrierName": "DHLM"
},
{
"CarrierName": "FEDEX"
}
]
},
"TermsAndConditionsNotAcceptedCarrierList": {
"TermsAndConditionsNotAcceptedCarrier": [
{
"CarrierName": "AMZN_US"
},
{
"CarrierName": "ONTRAC"
}
]
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of shipping service offers.
Description
The GetEligibleShippingServices operation returns a list of shipping service offers that satisfy the shipment request details that you specify. Use this operation to find a shipping service offer that meets your requirements. If the shipping service offer that you choose requires additional seller inputs (when RequiresAdditionalSellerInputs=true), you must call the GetAdditionalSellerInputs operation to find out which additional seller inputs are required. Specify the ShippingServiceId associated with the shipping service that you want. Get the required additional seller input values from the seller and use them as input to the CreateShipment operation. Specify the ShippingServiceId value, the additional seller inputs (if required), and the optional ShippingServiceOfferId value associated with this shipping service offer.
GetAdditionalSellerInputs
const mwsRequestData = {
Version: '2015-06-01',
Action: 'GetAdditionalSellerInputs',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
OrderId: 'ORDER_ID',
ShippingServiceId: 'SHIPPING_SERVICE_ID',
'ShipFromAddress.Name': 'SHIP_FROM_ADDRESS_NAME',
'ShipFromAddress.AddressLine1': 'SHIP_FROM_ADDRESS_LINE_1',
'ShipFromAddress.City': 'SHIP_FROM_ADDRESS_CITY',
'ShipFromAddress.StateOrProvinceCode': 'SHIP_FROM_ADDRESS_STATE_OR_PROVINCE_CODE',
'ShipFromAddress.PostalCode': 'SHIP_FROM_ADDRESS_POSTAL_CODE',
'ShipFromAddress.CountryCode': 'SHIP_FROM_ADDRESS_COUNTRY_CODE',
'ShipFromAddress.Email': 'SHIP_FROM_ADDRESS_EMAIL',
'ShipFromAddress.Phone': 'SHIP_FROM_ADDRESS_PHONE',
};
try {
const response = await amazonMws.merchantFulfillment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2015-06-01',
Action: 'GetAdditionalSellerInputs',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
OrderId: 'ORDER_ID',
ShippingServiceId: 'SHIPPING_SERVICE_ID',
'ShipFromAddress.Name': 'SHIP_FROM_ADDRESS_NAME',
'ShipFromAddress.AddressLine1': 'SHIP_FROM_ADDRESS_LINE_1',
'ShipFromAddress.City': 'SHIP_FROM_ADDRESS_CITY',
'ShipFromAddress.StateOrProvinceCode': 'SHIP_FROM_ADDRESS_STATE_OR_PROVINCE_CODE',
'ShipFromAddress.PostalCode': 'SHIP_FROM_ADDRESS_POSTAL_CODE',
'ShipFromAddress.CountryCode': 'SHIP_FROM_ADDRESS_COUNTRY_CODE',
'ShipFromAddress.Email': 'SHIP_FROM_ADDRESS_EMAIL',
'ShipFromAddress.Phone': 'SHIP_FROM_ADDRESS_PHONE',
};
amazonMws.merchantFulfillment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2015-06-01',
Action: 'GetAdditionalSellerInputs',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
OrderId: 'ORDER_ID',
ShippingServiceId: 'SHIPPING_SERVICE_ID',
'ShipFromAddress.Name': 'SHIP_FROM_ADDRESS_NAME',
'ShipFromAddress.AddressLine1': 'SHIP_FROM_ADDRESS_LINE_1',
'ShipFromAddress.City': 'SHIP_FROM_ADDRESS_CITY',
'ShipFromAddress.StateOrProvinceCode': 'SHIP_FROM_ADDRESS_STATE_OR_PROVINCE_CODE',
'ShipFromAddress.PostalCode': 'SHIP_FROM_ADDRESS_POSTAL_CODE',
'ShipFromAddress.CountryCode': 'SHIP_FROM_ADDRESS_COUNTRY_CODE',
'ShipFromAddress.Email': 'SHIP_FROM_ADDRESS_EMAIL',
'ShipFromAddress.Phone': 'SHIP_FROM_ADDRESS_PHONE',
};
amazonMws.merchantFulfillment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "c16c3c89-6dcd-11e9-b318-db190c5bb6ad"
},
"Result": {
"ShipmentLevelFields": {
"member": [
{
"SellerInputDefinition": {
"IsRequired": "true",
"RestrictedSetValues": {
"member": [
"Abandon",
"Return"
]
},
"DataType": "String",
"InputTarget": "SHIPMENT_LEVEL",
"StoredValue": {
"ValueAsString": "ABANDON",
"DataType": "STRING",
"ValueAsBoolean": "false",
"ValueAsInteger": "0"
},
"InputDisplayText": "Non-Deliverable Instructions",
"Constraints": {}
},
"AdditionalInputFieldName": "NON_DELIVERABLE_INSTRUCTIONS"
},
{
"SellerInputDefinition": {
"IsRequired": "true",
"RestrictedSetValues": {},
"DataType": "Address",
"InputTarget": "SHIPMENT_LEVEL",
"InputDisplayText": "Ship From Address(Chinese)",
"Constraints": {
"member": {
"ValidationRegEx": "putjust5digitRegex",
"ValidationString": "Please enter Ship From Address in
Chinese"
}
}
},
"AdditionalInputFieldName": "SENDER_ADDRESS_TRANSLATED"
}
]
},
"ItemLevelFieldsList": {
"member": {
"Asin": "B004U9TL66",
"AdditionalInputs": {
"member": [
{
"SellerInputDefinition": {
"IsRequired": "true",
"RestrictedSetValues": {},
"DataType": "Weight",
"InputTarget": "ITEM_LEVEL",
"StoredValue": {
"ValueAsWeight": {
"Value": ",600",
"Unit": "G"
},
"DataType": "WEIGHT",
"ValueAsBoolean": "false",
"ValueAsInteger": "0"
},
"InputDisplayText": "Item weight",
"Constraints": {
"member": {
"ValidationRegEx": "^[0-9]{1,3}(.[0-9]{1,2})?$",
"ValidationString": "Please enter item weight (max 6
digits)"
}
}
},
"AdditionalInputFieldName": "ITEM_WEIGHT"
},
{
"SellerInputDefinition": {
"IsRequired": "true",
"RestrictedSetValues": {},
"DataType": "String",
"InputTarget": "ITEM_LEVEL",
"StoredValue": {
"ValueAsString": "CN",
"DataType": "STRING",
"ValueAsBoolean": "false",
"ValueAsInteger": "0"
},
"InputDisplayText": "Country of Origin",
"Constraints": {
"member": {
"ValidationRegEx": "^[a-zA-Z]{2}$",
"ValidationString": "Please enter country code of the country of
manufacture (e.g. CN)"
}
}
},
"AdditionalInputFieldName": "COUNTRY_OF_ORIGIN"
},
{
"SellerInputDefinition": {
"IsRequired": "true",
"RestrictedSetValues": {},
"DataType": "String",
"InputTarget": "ITEM_LEVEL",
"StoredValue": {
"ValueAsString": "衣�",
"DataType": "STRING",
"ValueAsBoolean": "false",
"ValueAsInteger": "0"
},
"InputDisplayText": "Item Description(Chinese)",
"Constraints": {
"member": {
"ValidationRegEx": "^[^a-zA-Z]{1,10}$",
"ValidationString": "Please enter item description in Chinese up to
10 characters"
}
}
},
"AdditionalInputFieldName": "ITEM_DESCRIPTION_TRANSLATED"
},
{
"SellerInputDefinition": {
"IsRequired": "true",
"RestrictedSetValues": {},
"DataType": "String",
"InputTarget": "ITEM_LEVEL",
"StoredValue": {
"ValueAsString": "200",
"DataType": "CURRENCY",
"ValueAsBoolean": "false",
"ValueAsInteger": "0"
},
"InputDisplayText": "Item Value(USD)",
"Constraints": {
"member": {
"ValidationRegEx": "^[0-9]{1,3}(.[0-9]{1,2})?$",
"ValidationString": "Please enter item value in USD (max 6
digits)"
}
}
},
"AdditionalInputFieldName": "ITEM_VALUE"
},
{
"SellerInputDefinition": {
"IsRequired": "false",
"RestrictedSetValues": {},
"DataType": "String",
"InputTarget": "ITEM_LEVEL",
"InputDisplayText": "HS Code",
"Constraints": {
"member": {
"ValidationRegEx": "^[0-9a-zA-Z -]{1,10}?$",
"ValidationString": "Please enter HS Code containing letters and
numbers only up to 10 characters"
}
}
},
"AdditionalInputFieldName": "HS_CODE"
},
{
"SellerInputDefinition": {
"IsRequired": "true",
"RestrictedSetValues": {},
"DataType": "String",
"InputTarget": "ITEM_LEVEL",
"StoredValue": {
"ValueAsString": "Diapers",
"DataType": "STRING",
"ValueAsBoolean": "false",
"ValueAsInteger": "0"
},
"InputDisplayText": "Item Description",
"Constraints": {
"member": {
"ValidationRegEx": "^[a-zA-Z0-9-._& ]{3,25}$",
"ValidationString": "Please enter item description using
alphanumeric characters (max 25
characters)"
}
}
},
"AdditionalInputFieldName": "ITEM_DESCRIPTION"
}
]
}
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of additional seller inputs that are required from the seller to purchase the shipping service that you specify.
Description
The GetAdditionalSellerInputs operation returns a list of additional inputs that are required from the seller for purchasing shipping for some shipping services. Calling GetAdditionalSellerInputs is only required for shipment services that require additional seller inputs. To identify shipping services that require additional seller inputs, examine the ShippingService elements that are returned by the GetEligibleShippingServices operation. When RequiresAdditionalSellerInputs=true is included in a ShippingService element, that shipment service requires additional seller inputs. Call the GetAdditionalSellerInputs operation to find out which additional seller inputs are required. When RequiresAdditionalSellerInputs=false is included in a ShippingService element, that shipment service offer does not require additional seller inputs. You can skip the GetAdditionalSellerInputs operation and call the CreateShipment operation to create your shipment. The GetAdditionalSellerInputs operation also includes syntax requirements for the additional input that you get from sellers, and returns saved values that you previously provided to Amazon.
GetShipment
const mwsRequestData = {
Version: '2015-06-01',
Action: 'GetShipment',
SellerId: 'SELLER_ID',
ShippingServiceId: 'SHIPPING_SERVICE_ID'
};
try {
const response = await amazonMws.merchantFulfillment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2015-06-01',
Action: 'GetShipment',
SellerId: 'SELLER_ID',
ShippingServiceId: 'SHIPPING_SERVICE_ID'
};
amazonMws.merchantFulfillment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2015-06-01',
Action: 'GetShipment',
SellerId: 'SELLER_ID',
ShippingServiceId: 'SHIPPING_SERVICE_ID'
};
amazonMws.merchantFulfillment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "f44b6af6-74f8-43d3-b928-1c4e0123b26c"
},
"Result": {
"Shipment": {
"Insurance": {
"CurrencyCode": "USD",
"Amount": "10.00"
},
"ShipToAddress": {
"City": "Seattle",
"Phone": {},
"CountryCode": "US",
"PostalCode": "98121-2778",
"Name": "Jane Smith",
"AddressLine1": "321 Main St",
"StateOrProvinceCode": "WA",
"Email": {}
},
"AmazonOrderId": "903-1713775-3598252",
"Weight": {
"Value": ",10",
"Unit": "oz"
},
"Label": {
"CustomTextForLabel": "ABC123",
"LabelFormat": "ZPL203",
"FileContents": {
"Checksum": "DmsWbJpdMPALN3jV4wHOrg==",
"Contents": "H4sIAAAAAAAAAK16WbeqyrLmO2Pc/zBVRLG...
...kI0Ycv76w378UfL6O6ev7UsAwmkWBfL6nycD/Bd+Zx3S8LwAA",
"FileType": "application/zpl"
},
"Dimensions": {
"Width": "8.50000",
"Length": "11.00000",
"Unit": "inches"
},
"StandardIdForLabel": "AmazonOrderId"
},
"ShippingService": {
"CarrierName": "FEDEX",
"ShippingServiceOptions": {
"CarrierWillPickUp": "false",
"DeclaredValue": {
"CurrencyCode": "USD",
"Amount": "10.00"
},
"DeliveryExperience": "DELIVERY_CONFIRMATION"
},
"ShippingServiceId": "FEDEX_PTP_PRIORITY_OVERNIGHT",
"Rate": {
"CurrencyCode": "USD",
"Amount": "27.81"
},
"LatestEstimatedDeliveryDate": "2015-09-24T10:30:00Z",
"EarliestEstimatedDeliveryDate": "2015-09-24T10:30:00Z",
"ShippingServiceOfferId": "HDDUKqtQVFetpBZAqx5c1yaCZ9vuFfND0kudyw3lLWCa
3mN2+zUOsRCAZS2oYt0ey6fXKdOAucmYVXR9LAkU9O9eys9V3FJCgvQ+vAqm4bSAzHVH04vD8oLy oUPKqxa8Otbek97Z85LFUSsfcUf8frNRMEfNLP8t5RyLXa4ZOjc=",
"ShipDate": "2015-09-23T20:10:56.829Z",
"ShippingServiceName": "FedEx Priority Overnight®"
},
"PackageDimensions": {
"Width": "5",
"Length": "5",
"Unit": "inches",
"Height": "5"
},
"CreatedDate": "2015-09-23T20:11:12.908Z",
"ShipFromAddress": {
"City": "Seattle",
"Phone": "2061234567",
"CountryCode": "US",
"PostalCode": "98121",
"Name": "John Doe",
"AddressLine1": "1234 Westlake Ave",
"StateOrProvinceCode": "WA"
},
"ShipmentId": "6f77095e-9f75-47eb-aaab-a42d5428fa1a",
"ItemList": {
"Item": {
"OrderItemId": "40525960574974",
"Quantity": "1"
}
},
"Status": "Purchased",
"TrackingId": "794657111237"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns an existing shipment for a given identifier.
Description
The GetShipment operation returns an existing shipment for the ShipmentId value that you specify. You can use this operation to get document data for shipping labels in case the label document data originally returned by the CreateShipment operation is lost.
CancelShipment
const mwsRequestData = {
Version: '2015-06-01',
Action: 'CancelShipment',
SellerId: 'SELLER_ID',
ShippingServiceId: 'SHIPPING_SERVICE_ID'
};
try {
const response = await amazonMws.merchantFulfillment.create(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2015-06-01',
Action: 'CancelShipment',
SellerId: 'SELLER_ID',
ShippingServiceId: 'SHIPPING_SERVICE_ID'
};
amazonMws.merchantFulfillment.create(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2015-06-01',
Action: 'CancelShipment',
SellerId: 'SELLER_ID',
ShippingServiceId: 'SHIPPING_SERVICE_ID'
};
amazonMws.merchantFulfillment.create(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "adb18f0d-2076-48d4-99ef-fb4b9f892a4e"
},
"Result": {
"Shipment": {
"Insurance": {
"CurrencyCode": "USD",
"Amount": "10.00"
},
"ShipToAddress": {
"City": "Seattle",
"Phone": {},
"CountryCode": "US",
"PostalCode": "98121-2778",
"Name": "Jane Smith",
"AddressLine1": "321 Main St",
"StateOrProvinceCode": "WA",
"Email": {}
},
"AmazonOrderId": "903-1713775-3598252",
"Weight": {
"Value": ",10",
"Unit": "oz"
},
"Label": {
"FileContents": {
"Checksum": "DmsWbJpdMPALN3jV4wHOrg==",
"Contents": "H4sIAAAAAAAAAK16WbeqyrLmO2Pc/zBVRLG...
...kI0Ycv76w378UfL6O6ev7UsAwmkWBfL6nycD/Bd+Zx3S8LwAA",
"FileType": "application/pdf"
},
"Dimensions": {
"Width": "8.50000",
"Length": "11.00000",
"Unit": "inches"
}
},
"ShippingService": {
"CarrierName": "FEDEX",
"ShippingServiceOptions": {
"CarrierWillPickUp": "false",
"DeclaredValue": {
"CurrencyCode": "USD",
"Amount": "10.00"
},
"DeliveryExperience": "DELIVERY_CONFIRMATION"
},
"ShippingServiceId": "FEDEX_PTP_PRIORITY_OVERNIGHT",
"Rate": {
"CurrencyCode": "USD",
"Amount": "27.81"
},
"LatestEstimatedDeliveryDate": "2015-09-24T10:30:00Z",
"EarliestEstimatedDeliveryDate": "2015-09-24T10:30:00Z",
"ShippingServiceOfferId": "HDDUKqtQVFetpBZAqx5c1yaCZ9vuFfND0kudyw3lLWCa 3mN2+zUOsRCAZS2oYt0ey6fXKdOAucmYVXR9LAkU9O9eys9V3FJCgvQ+vAqm4bSAzHVH04vD8oLy oUPKqxa8Otbek97Z85LFUSsfcUf8frNRMEfNLP8t5RyLXa4ZOjc=",
"ShipDate": "2015-09-23T20:10:56.829Z",
"ShippingServiceName": "FedEx Priority Overnight®"
},
"PackageDimensions": {
"Width": "5",
"Length": "5",
"Unit": "inches",
"Height": "5"
},
"CreatedDate": "2015-09-23T20:11:12.908Z",
"ShipFromAddress": {
"City": "Seattle",
"Phone": "2061234567",
"CountryCode": "US",
"PostalCode": "98121",
"Name": "John Doe",
"AddressLine1": "1234 Westlake Ave",
"StateOrProvinceCode": "WA"
},
"ShipmentId": "6f77095e-9f75-47eb-aaab-a42d5428fa1a",
"ItemList": {
"Item": {
"OrderItemId": "40525960574974",
"Quantity": "1"
}
},
"Status": "Purchased",
"TrackingId": "794657111237"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Cancels an existing shipment.
Description
The CancelShipment operation cancels an existing shipment and requests a refund for the ShipmentId value that you specify. Get the ShipmentId value from a previous call to the CreateShipment operation. Canceling a shipment only succeeds if the cancellation window has not expired and if the shipment has not previously been canceled. Cancellation policies vary by carrier.
GetServiceStatus
const mwsRequestData = {
Version: '2015-06-01',
Action: 'GetServiceStatus',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerId: 'SELLER_ID'
};
try {
const response = await amazonMws.merchantFulfillment.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2015-06-01',
Action: 'GetServiceStatus',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerId: 'SELLER_ID'
};
amazonMws.merchantFulfillment.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2015-06-01',
Action: 'GetServiceStatus',
MWSAuthToken: 'MWS_AUTH_TOKEN',
SellerId: 'SELLER_ID'
};
amazonMws.merchantFulfillment.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "d80c6c7b-f7c7-4fa7-bdd7-854711cb3bcc"
},
"Result": {
"Status": "GREEN",
"Timestamp": "2015-07-01421:38:09.676Z"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the operational status of the Merchant Fulfillment service.
Description
The GetServiceStatus operation returns the operational status of the Merchant Fulfillment service of Amazon Marketplace Web Service. Status values are GREEN, YELLOW, and RED.
Orders
ListOrderItems
const mwsRequestData = {
Version: '2013-09-01',
Action: 'ListOrderItems',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
AmazonOrderId: 'AMAZON_ORDER_ID'
};
try {
const response = await amazonMws.orders.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-09-01',
Action: 'ListOrderItems',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
AmazonOrderId: 'AMAZON_ORDER_ID'
};
amazonMws.orders.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-09-01',
Action: 'ListOrderItems',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
AmazonOrderId: 'AMAZON_ORDER_ID'
};
amazonMws.orders.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "88faca76-b600-46d2-b53c-0c8c4533e43a"
},
"Result": {
"NextToken": "MRgZW55IGNhcm5hbCBwbGVhc3VyZS6=",
"AmazonOrderId": "058-1233752-8214740",
"OrderItems": {
"OrderItem": [
{
"ASIN": "BT0093TELA",
"OrderItemId": "68828574383266",
"BuyerCustomizedInfo": {
"CustomizedURL": "https://zme-caps.amazon.com/t/bR6qHkzSOxuB/J8nbWhze0Bd3DkajkOdY-XQbWkFralegp2sr_QZiKEE/1"
},
"SellerSKU": "CBA_OTF_1",
"Title": "Example item name",
"QuantityOrdered": "1",
"QuantityShipped": "1",
"ProductInfo": {
"NumberOfItems": "12"
},
"PointsGranted": {
"PointsNumber": "10",
"PointsMonetaryValue": {
"CurrencyCode": "JPY",
"Amount": "10.00"
}
},
"ItemPrice": {
"CurrencyCode": "JPY",
"Amount": "25.99"
},
"ShippingPrice": {
"CurrencyCode": "JPY",
"Amount": "1.26"
},
"ScheduledDeliveryEndDate": "2013-09-09T01:30:00.000-06:00 ",
"ScheduledDeliveryStartDate": "2013-09-071T02:00:00.000-06:00 ",
"CODFee": {
"CurrencyCode": "JPY",
"Amount": "10.00"
},
"CODFeeDiscount": {
"CurrencyCode": "JPY",
"Amount": "1.00"
},
"IsGift": "false",
"IsTransparency": "true",
"GiftMessageText": "For you!",
"GiftWrapPrice": {
"CurrencyCode": "JPY",
"Amount": "1.99"
},
"GiftWrapLevel": "Classic",
"PriceDesignation": "BusinessPrice"
},
{
"ASIN": "BCTU1104UEFB",
"OrderItemId": "79039765272157",
"SellerSKU": "CBA_OTF_5",
"Title": "Example item name",
"QuantityOrdered": "2",
"ItemPrice": {
"CurrencyCode": "JPY",
"Amount": "17.95"
},
"PromotionIds": {
"PromotionId": "FREESHIP"
},
"ConditionId": "Used",
"ConditionSubtypeId": "Mint",
"ConditionNote": "Example ConditionNote",
"IsGift": "false",
"IsTransparency": "false",
"PriceDesignation": "BusinessPrice",
"TaxCollection": {
"Model": "MarketplaceFacilitator",
"ResponsibleParty": "Amazon Services, Inc."
}
}
]
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns order items based on the AmazonOrderId that you specify.
Description
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. You can retrieve order item information by first using the ListOrders operation to find orders created or updated during a time frame that you specify. An AmazonOrderId is included with each order that is returned. You can then use these AmazonOrderId values with the ListOrderItems operation to get detailed order item information for each order.
ListOrders
const mwsRequestData = {
Version: '2013-09-01',
Action: 'ListOrders',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'MarketplaceId.Id.1': 'MARKET_PLACE_ID_1',
LastUpdatedAfter: new Date(2016, 11, 24)
};
try {
const response = await amazonMws.orders.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-09-01',
Action: 'ListOrders',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'MarketplaceId.Id.1': 'MARKET_PLACE_ID_1',
LastUpdatedAfter: new Date(2016, 11, 24)
};
amazonMws.orders.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-09-01',
Action: 'ListOrders',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'MarketplaceId.Id.1': 'MARKET_PLACE_ID_1',
LastUpdatedAfter: new Date(2016, 11, 24)
};
amazonMws.orders.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "88faca76-b600-46d2-b53c-0c8c4533e43a"
},
"Result": {
"NextToken": "2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=",
"LastUpdatedBefore": "2017-02-25T18%3A10%3A21.687Z",
"Orders": {
"Order": [
{
"AmazonOrderId": "902-3159896-1390916",
"PurchaseDate": "2017-02-20T19:49:35Z",
"LastUpdateDate": "2017-02-20T19:49:35Z",
"OrderStatus": "Unshipped",
"FulfillmentChannel": "MFN",
"SalesChannel": "Amazon.com",
"ShippingAddress": {
"Name": "Buyer name",
"AddressLine1": "1234 Any St.",
"City": "Seattle",
"PostalCode": "98103",
"CountryCode": "US",
"AddressType": "Commercial"
},
"OrderTotal": {
"CurrencyCode": "USD",
"Amount": "25.00"
},
"NumberOfItemsShipped": "0",
"NumberOfItemsUnshipped": "1",
"PaymentMethod": "Other",
"PaymentMethodDetails": {
"PaymentMethodDetail": "CreditCard"
},
"MarketplaceId": "ATVPDKIKX0DER",
"BuyerEmail": "[email protected]",
"BuyerName": "Buyer name",
"BuyerTaxInfo": {
"CompanyLegalName": "Company Name",
"TaxingRegion": "US",
"TaxClassifications": {
"TaxClassification": {
"Value": ",XXX123",
"Name": "VATNumber"
}
}
},
"OrderType": "StandardOrder",
"EarliestShipDate": "2017-02-20T19:51:16Z",
"LatestShipDate": "2017-02-25T19:49:35Z",
"IsBusinessOrder": "true",
"PurchaseOrderNumber": "PO12345678",
"IsPrime": "false",
"IsPremiumOrder": "false",
"IsGlobalExpressEnabled": "false"
},
{
"AmazonOrderId": "483-3488972-0896720",
"PurchaseDate": "20178-02-20T19:49:35Z",
"LastUpdateDate": "2017-02-20T19:49:35Z",
"OrderStatus": "Unshipped",
"FulfillmentChannel": "MFN",
"ShippingAddress": {
"Name": "Buyer name",
"AddressLine1": "1234 Avenida Qualquer",
"City": "Sao Paulo",
"PostalCode": "08474-130",
"CountryCode": "BR",
"AddressType": "Residential"
},
"OrderTotal": {
"CurrencyCode": "BRL",
"Amount": "100.00"
},
"NumberOfItemsShipped": "0",
"NumberOfItemsUnshipped": "1",
"PaymentMethod": "Other",
"PaymentMethodDetails": {
"PaymentMethodDetail": "CreditCard"
},
"MarketplaceId": "A2Q3Y263D00KWC",
"BuyerEmail": "[email protected]",
"BuyerName": "John Jones",
"BuyerCounty": "Vila Olimpia",
"BuyerTaxInfo": {
"TaxingRegion": "BR",
"TaxClassifications": {
"TaxClassification": {
"Value": ",XXX123",
"Name": "CSTNumber"
}
}
},
"EarliestShipDate": "2017-02-20T19:51:16Z",
"LatestShipDate": "2017-02-25T19:49:35Z",
"IsBusinessOrder": "false",
"IsPrime": "false",
"IsPremiumOrder": "false",
"IsGlobalExpressEnabled": "false"
},
{
"AmazonOrderId": "058-1233752-8214740",
"PurchaseDate": "2017-02-05T00%3A06%3A07.000Z",
"LastUpdateDate": "2017-02-07T12%3A43%3A16.000Z",
"OrderStatus": "Unshipped",
"FulfillmentChannel": "MFN",
"ShipServiceLevel": "Std JP Kanto8",
"ShippingAddress": {
"Name": "Jane Smith",
"AddressLine1": "1-2-10 Akasaka",
"City": "Tokyo",
"PostalCode": "107-0053",
"CountryCode": "JP"
},
"OrderTotal": {
"CurrencyCode": "JPY",
"Amount": "1507.00"
},
"NumberOfItemsShipped": "0",
"NumberOfItemsUnshipped": "1",
"PaymentExecutionDetail": {
"PaymentExecutionDetailItem": [
{
"Payment": {
"Amount": "10.00",
"CurrencyCode": "JPY"
},
"PaymentMethod": "PointsAccount"
},
{
"Payment": {
"Amount": "317.00",
"CurrencyCode": "JPY"
},
"PaymentMethod": "GC"
},
{
"Payment": {
"Amount": "1180.00",
"CurrencyCode": "JPY"
},
"PaymentMethod": "COD"
}
]
},
"PaymentMethod": "COD",
"PaymentMethodDetails": {
"PaymentMethodDetail": "COD"
},
"MarketplaceId": "A1VC38T7YXB528",
"BuyerEmail": "[email protected]",
"BuyerName": "Jane Smith",
"ShipmentServiceLevelCategory": "Standard",
"OrderType": "SourcingOnDemandOrder",
"IsBusinessOrder": "false",
"IsPrime": "false",
"IsPremiumOrder": "false",
"IsGlobalExpressEnabled": "false",
"PromiseResponseDueDate": "2017-08-31T23:58:44Z",
"IsEstimatedShipDateSet": "true"
}
]
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns orders created or updated during a time frame that you specify.
Description
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.
ListOrderFilterStatus
const mwsRequestData = {
Version: '2013-09-01',
Action: 'ListOrders',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'MarketplaceId.Id.1': 'MARKET_PLACE_ID_1',
LastUpdatedAfter: new Date(2016, 11, 24),
'OrderStatus.Status.1': 'Pending',
'OrderStatus.Status.2': 'Canceled'
};
try {
const response = await amazonMws.orders.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-09-01',
Action: 'ListOrders',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'MarketplaceId.Id.1': 'MARKET_PLACE_ID_1',
LastUpdatedAfter: new Date(2016, 11, 24),
'OrderStatus.Status.1': 'Pending',
'OrderStatus.Status.2': 'Canceled'
};
amazonMws.orders.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-09-01',
Action: 'ListOrders',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'MarketplaceId.Id.1': 'MARKET_PLACE_ID_1',
LastUpdatedAfter: new Date(2016, 11, 24),
'OrderStatus.Status.1': 'Pending',
'OrderStatus.Status.2': 'Canceled'
};
amazonMws.orders.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "88faca76-b600-46d2-b53c-0c8c4533e43a"
},
"Result": {
"NextToken": "2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=",
"LastUpdatedBefore": "2017-02-25T18%3A10%3A21.687Z",
"Orders": {
"Order": [
{
"AmazonOrderId": "902-3159896-1390916",
"PurchaseDate": "2017-02-20T19:49:35Z",
"LastUpdateDate": "2017-02-20T19:49:35Z",
"OrderStatus": "Unshipped",
"FulfillmentChannel": "MFN",
"SalesChannel": "Amazon.com",
"ShippingAddress": {
"Name": "Buyer name",
"AddressLine1": "1234 Any St.",
"City": "Seattle",
"PostalCode": "98103",
"CountryCode": "US",
"AddressType": "Commercial"
},
"OrderTotal": {
"CurrencyCode": "USD",
"Amount": "25.00"
},
"NumberOfItemsShipped": "0",
"NumberOfItemsUnshipped": "1",
"PaymentMethod": "Other",
"PaymentMethodDetails": {
"PaymentMethodDetail": "CreditCard"
},
"MarketplaceId": "ATVPDKIKX0DER",
"BuyerEmail": "[email protected]",
"BuyerName": "Buyer name",
"BuyerTaxInfo": {
"CompanyLegalName": "Company Name",
"TaxingRegion": "US",
"TaxClassifications": {
"TaxClassification": {
"Value": ",XXX123",
"Name": "VATNumber"
}
}
},
"OrderType": "StandardOrder",
"EarliestShipDate": "2017-02-20T19:51:16Z",
"LatestShipDate": "2017-02-25T19:49:35Z",
"IsBusinessOrder": "true",
"PurchaseOrderNumber": "PO12345678",
"IsPrime": "false",
"IsPremiumOrder": "false",
"IsGlobalExpressEnabled": "false"
},
{
"AmazonOrderId": "483-3488972-0896720",
"PurchaseDate": "20178-02-20T19:49:35Z",
"LastUpdateDate": "2017-02-20T19:49:35Z",
"OrderStatus": "Unshipped",
"FulfillmentChannel": "MFN",
"ShippingAddress": {
"Name": "Buyer name",
"AddressLine1": "1234 Avenida Qualquer",
"City": "Sao Paulo",
"PostalCode": "08474-130",
"CountryCode": "BR",
"AddressType": "Residential"
},
"OrderTotal": {
"CurrencyCode": "BRL",
"Amount": "100.00"
},
"NumberOfItemsShipped": "0",
"NumberOfItemsUnshipped": "1",
"PaymentMethod": "Other",
"PaymentMethodDetails": {
"PaymentMethodDetail": "CreditCard"
},
"MarketplaceId": "A2Q3Y263D00KWC",
"BuyerEmail": "[email protected]",
"BuyerName": "John Jones",
"BuyerCounty": "Vila Olimpia",
"BuyerTaxInfo": {
"TaxingRegion": "BR",
"TaxClassifications": {
"TaxClassification": {
"Value": ",XXX123",
"Name": "CSTNumber"
}
}
},
"EarliestShipDate": "2017-02-20T19:51:16Z",
"LatestShipDate": "2017-02-25T19:49:35Z",
"IsBusinessOrder": "false",
"IsPrime": "false",
"IsPremiumOrder": "false",
"IsGlobalExpressEnabled": "false"
},
{
"AmazonOrderId": "058-1233752-8214740",
"PurchaseDate": "2017-02-05T00%3A06%3A07.000Z",
"LastUpdateDate": "2017-02-07T12%3A43%3A16.000Z",
"OrderStatus": "Unshipped",
"FulfillmentChannel": "MFN",
"ShipServiceLevel": "Std JP Kanto8",
"ShippingAddress": {
"Name": "Jane Smith",
"AddressLine1": "1-2-10 Akasaka",
"City": "Tokyo",
"PostalCode": "107-0053",
"CountryCode": "JP"
},
"OrderTotal": {
"CurrencyCode": "JPY",
"Amount": "1507.00"
},
"NumberOfItemsShipped": "0",
"NumberOfItemsUnshipped": "1",
"PaymentExecutionDetail": {
"PaymentExecutionDetailItem": [
{
"Payment": {
"Amount": "10.00",
"CurrencyCode": "JPY"
},
"PaymentMethod": "PointsAccount"
},
{
"Payment": {
"Amount": "317.00",
"CurrencyCode": "JPY"
},
"PaymentMethod": "GC"
},
{
"Payment": {
"Amount": "1180.00",
"CurrencyCode": "JPY"
},
"PaymentMethod": "COD"
}
]
},
"PaymentMethod": "COD",
"PaymentMethodDetails": {
"PaymentMethodDetail": "COD"
},
"MarketplaceId": "A1VC38T7YXB528",
"BuyerEmail": "[email protected]",
"BuyerName": "Jane Smith",
"ShipmentServiceLevelCategory": "Standard",
"OrderType": "SourcingOnDemandOrder",
"IsBusinessOrder": "false",
"IsPrime": "false",
"IsPremiumOrder": "false",
"IsGlobalExpressEnabled": "false",
"PromiseResponseDueDate": "2017-08-31T23:58:44Z",
"IsEstimatedShipDateSet": "true"
}
]
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns orders created or updated during a time frame that you specify.
Description
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.
ListOrderItemsByNextToken
const mwsRequestData = {
Version: '2013-09-01',
Action: 'ListOrderItemsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'NEXT_TOKEN'
};
try {
const response = await amazonMws.orders.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-09-01',
Action: 'ListOrderItemsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'NEXT_TOKEN'
};
amazonMws.orders.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-09-01',
Action: 'ListOrderItemsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'NEXT_TOKEN'
};
amazonMws.orders.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "88faca76-b600-46d2-b53c-0c8c4533e43a"
},
"Result": {
"NextToken": "MRgZW55IGNhcm5hbCBwbGVhc3VyZS6=",
"AmazonOrderId": "058-1233752-8214740",
"OrderItems": {
"OrderItem": [
{
"ASIN": "BT0093TELA",
"OrderItemId": "68828574383266",
"SellerSKU": "CBA_OTF_1",
"Title": "Example item name",
"QuantityOrdered": "1",
"QuantityShipped": "1",
"ItemPrice": {
"CurrencyCode": "USD",
"Amount": "25.99"
},
"ShippingPrice": {
"CurrencyCode": "USD",
"Amount": "1.26"
},
"ScheduledDeliveryEndDate": "2013-09-091T01:30:00.000-06:00",
"ScheduledDeliveryStartDate": "2013-09-06T02:00:00.000-06:00",
"CODFee": {
"CurrencyCode": "USD",
"Amount": "10.00"
},
"CODFeeDiscount": {
"CurrencyCode": "USD",
"Amount": "1.00"
},
"IsGift": "false",
"GiftMessageText": "For you!",
"GiftWrapPrice": {
"CurrencyCode": "USD",
"Amount": "1.99"
},
"GiftWrapLevel": "Classic",
"PriceDesignation": "BusinessPrice"
},
{
"ASIN": "BCTU1104UEFB",
"OrderItemId": "79039765272157",
"SellerSKU": "CBA_OTF_5",
"Title": "Example item name",
"QuantityOrdered": "2",
"ItemPrice": {
"CurrencyCode": "USD",
"Amount": "17.95"
},
"PromotionIds": {
"PromotionId": "FREESHIP"
},
"ConditionId": "Used",
"ConditionSubtypeId": "Mint",
"ConditionNote": "Example ConditionNote",
"IsGift": "false",
"IsTransparency": "true",
"PriceDesignation": "BusinessPrice"
}
]
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the next page of order items using the NextToken parameter.
Description
The ListOrderItemsByNextToken operation returns the next page of order items using the NextToken value that was returned by your previous request to either ListOrderItems or ListOrderItemsByNextToken. If NextToken is not returned, there are no more pages to return.
GetOrder
const mwsRequestData = {
Version: '2013-09-01',
Action: 'GetOrder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'AmazonOrderId.Id.1': 'AMAZON_ORDER_ID',
'LastUpdatedAfter': '2017-02-01'
};
try {
const response = await amazonMws.orders.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-09-01',
Action: 'GetOrder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'AmazonOrderId.Id.1': 'AMAZON_ORDER_ID',
'LastUpdatedAfter': '2017-02-01'
};
amazonMws.orders.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-09-01',
Action: 'GetOrder',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'AmazonOrderId.Id.1': 'AMAZON_ORDER_ID',
'LastUpdatedAfter': '2017-02-01'
};
amazonMws.orders.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "88faca76-b600-46d2-b53c-0c8c4533e43a"
},
"Result": {
"Orders": {
"Order": {
"Value": ">",
"AmazonOrderId": "902-3159896-1390916",
"PurchaseDate": "2017-01-20T19:49:35Z",
"LastUpdateDate": "2017-01-20T19:49:35Z",
"OrderStatus": "Pending",
"FulfillmentChannel": "MFN",
"NumberOfItemsShipped": "0",
"NumberOfItemsUnshipped": "0",
"PaymentMethod": "Other",
"PaymentMethodDetails": {
"PaymentMethodDetail": [
"CreditCard",
"GiftCerificate"
]
},
"MarketplaceId": "ATVPDKIKX0DER",
"ShipmentServiceLevelCategory": "Standard",
"OrderType": "StandardOrder",
"EarliestShipDate": "2017-01-20T19:51:16Z",
"LatestShipDate": "2017-01-25T19:49:35Z",
"IsBusinessOrder": "false",
"IsPrime": "false",
"IsPremiumOrder": "false",
"IsGlobalExpressEnabled": "false"
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns orders based on the AmazonOrderId values that you specify.
Description
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.
ListOrdersByNextToken
const mwsRequestData = {
Version: '2013-09-01',
Action: 'ListOrdersByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'NEXT_TOKEN'
};
try {
const response = await amazonMws.orders.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-09-01',
Action: 'ListOrdersByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'NEXT_TOKEN'
};
amazonMws.orders.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-09-01',
Action: 'ListOrdersByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'NEXT_TOKEN'
};
amazonMws.orders.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "88faca76-b600-46d2-b53c-0c8c4533e43a"
},
"Result": {
"Orders": {
"Order": {
"AmazonOrderId": "902-3159896-1390916",
"PurchaseDate": "2017-01-20T19:49:35Z",
"LastUpdateDate": "2017-01-20T19:49:35Z",
"OrderStatus": "Pending",
"FulfillmentChannel": "MFN",
"NumberOfItemsShipped": "0",
"NumberOfItemsUnshipped": "0",
"PaymentMethod": "Other",
"PaymentMethodDetails": {
"PaymentMethodDetail": [
"CreditCard",
"GiftCerificate"
]
},
"MarketplaceId": "A21TJRUUN4KGV",
"ShipmentServiceLevelCategory": "Standard",
"OrderType": "StandardOrder",
"EarliestShipDate": "2017-01-20T19:51:16Z",
"LatestShipDate": "2017-01-25T19:49:35Z",
"IsBusinessOrder": "false",
"IsPrime": "false",
"IsPremiumOrder": "false"
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the next page of orders using the NextToken parameter.
Description
The ListOrdersByNextToken operation returns the next page of orders using the NextToken value that was returned by your previous request to either ListOrders or ListOrdersByNextToken. If NextToken is not returned, there are no more pages to return.
GetServiceStatus
const mwsRequestData = {
Version: '2013-09-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
try {
const response = await amazonMws.orders.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-09-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.orders.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-09-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.orders.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "d80c6c7b-f7c7-4fa7-bdd7-854711cb3bcc"
},
"Result": {
"Status": "GREEN",
"Timestamp": "2013-09-05T18%3A12%3A21"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the operational status of the Orders API section.
Description
The GetServiceStatus operation returns the operational status of the Orders API section of Amazon Marketplace Web Service. Status values are GREEN, YELLOW, and RED.
Products
ListMatchingProducts
var mwsRequestData = {
Version: '2011-10-01',
Action: 'ListMatchingProducts',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
Query: 'k'
};
amazonMws.products.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error products', error);
});
var mwsRequestData = {
Version: '2011-10-01',
Action: 'ListMatchingProducts',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
Query: 'k'
};
amazonMws.products.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error products', error);
return;
}
//console.log('response ', JSON.stringify(response));
console.log('response', response);
});
const mwsRequestData = {
Version: '2011-10-01',
Action: 'ListMatchingProducts',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
Query: 'k'
};
try {
const response = await amazonMws.products.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error products', error);
}
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "3b805a12-689a-4367-ba86-EXAMPLE91c0b"
},
"Result": {
"Products": {
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "059035342X"
}
},
"AttributeSets": {
"ItemAttributes": {
"xml:lang": "en-US",
"Author": "Rowling, J.K.",
"Binding": "Paperback",
"Brand": "Scholastic Press",
"Creator": {
"Value": "GrandPré, Mary",
"Role": "Illustrator"
},
"Edition": "1st",
"Feature": "Recommended Age: 9 years and up",
"ItemDimensions": {
"Height": {
"Value": "0.80",
"Units": "inches"
},
"Length": {
"Value": "7.50",
"Units": "inches"
},
"Width": {
"Value": "5.20",
"Units": "inches"
},
"Weight": {
"Value": "0.50",
"Units": "pounds"
}
},
"IsAutographed": "false",
"IsMemorabilia": "false",
"Label": "Scholastic Paperbacks",
"Languages": {
"Language": [
{
"Name": "english",
"Type": "Unknown"
},
{
"Name": "english",
"Type": "Original Language"
},
{
"Name": "english",
"Type": "Published"
}
]
},
"ListPrice": {
"Amount": "10.99",
"CurrencyCode": "USD"
},
"Manufacturer": "Scholastic Paperbacks",
"NumberOfItems": "1",
"NumberOfPages": "320",
"PackageDimensions": {
"Height": {
"Value": "1.00",
"Units": "inches"
},
"Length": {
"Value": "7.50",
"Units": "inches"
},
"Width": {
"Value": "5.20",
"Units": "inches"
},
"Weight": {
"Value": "0.50",
"Units": "pounds"
}
},
"PackageQuantity": "1",
"PartNumber": "9780590353427",
"ProductGroup": "Book",
"ProductTypeName": "ABIS_BOOK",
"PublicationDate": "1999-10-01",
"Publisher": "Scholastic Paperbacks",
"ReleaseDate": "1999-09-08",
"SmallImage": {
"URL": "http://ecx.images-amazon.com/images/I/51MU5VilKpL._SL75_.jpg",
"Height": {
"Value": "75",
"Units": "pixels"
},
"Width": {
"Value": "51",
"Units": "pixels"
}
},
"Studio": "Scholastic Paperbacks",
"Title": "Harry Potter and the Sorcerer's Stone (Book 1)"
}
},
"Relationships": {},
"SalesRankings": {
"SalesRank": [
{
"ProductCategoryId": "book_display_on_website",
"Rank": "401"
},
{
"ProductCategoryId": "15356791",
"Rank": "5"
},
{
"ProductCategoryId": "3153",
"Rank": "8"
},
{
"ProductCategoryId": "17468",
"Rank": "16"
}
]
}
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of products and their attributes, based on a list of ASIN values.
Description
The ListMatchingProducts operation returns a list of products and their attributes, ordered by relevancy, based on a search query that you specify. Your search query can be a phrase that describes the product or it can be a product identifier such as a GCID, UPC, EAN, ISBN, or JAN. If you have the ASIN associated with your product, use the GetMatchingProduct operation. Note that the product identifier cannot be a SellerSKU. If your query does not return any matching products, the query will be broadened using spelling correction or the removal of keywords to find matches. This operation returns a maximum of ten products and does not return non-buyable products.
GetMatchingProduct
const mwsRequestData = {
Version: '2011-10-01',
Action: 'GetMatchingProduct',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ASINList.ASIN.1': 'ASIN_1'
};
try {
const response = await amazonMws.products.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error products', error);
}
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetMatchingProduct',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ASINList.ASIN.1': 'ASIN_1'
};
amazonMws.products.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error products', error);
});
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetMatchingProduct',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ASINList.ASIN.1': 'ASIN_1'
}
amazonMws.products.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error products', error);
return;
}
//console.log('response ', JSON.stringify(response));
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "b12caada-d330-4d87-a789-EXAMPLE35872"
},
"Result": {
"ASIN": "B002KT3XRQ",
"status": "Success",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B002KT3XRQ"
}
},
"AttributeSets": {
"ItemAttributes": {
"xml:lang": "en-US",
"Binding": "Apparel",
"Brand": "Pearl iZUMi",
"Department": "mens",
"Feature": [
"Select transfer fabric sets the benchmark for moisture transfer and
four-way performance stretch",
"6-Panel anatomic design for superior, chafe-free comfort, UPF 50+ sun
protection",
"Comfortable silicone leg grippers keep shorts in place,
moisture-wicking, antimicrobial properties",
"Tour 3D Chamois is male-specific and non-chafing with padding in
key areas",
"86 percent nylon, 14% spandex, 9-Inch inseam"
],
"ItemDimensions": {
"Height": {
"Value": "2.00",
"Units": "inches"
},
"Length": {
"Value": "9.00",
"Units": "inches"
},
"Width": {
"Value": "9.00",
"Units": "inches"
}
},
"Label": "Pearl iZUMi",
"ListPrice": {
"Amount": "50.00",
"CurrencyCode": "USD"
},
"Manufacturer": "Pearl iZUMi",
"Model": "0275",
"PackageDimensions": {
"Height": {
"Value": "2.80",
"Units": "inches"
},
"Length": {
"Value": "9.75",
"Units": "inches"
},
"Width": {
"Value": "8.40",
"Units": "inches"
},
"Weight": {
"Value": "0.40",
"Units": "pounds"
}
},
"PackageQuantity": "1",
"PartNumber": "0275",
"ProductGroup": "Apparel",
"ProductTypeName": "SHORTS",
"Publisher": "Pearl iZUMi",
"SmallImage": {
"URL": "http://ecx.images-amazon.com/images/I/41ty3Sn%2BU8L._SL75_.jpg",
"Height": {
"Value": "75",
"Units": "pixels"
},
"Width": {
"Value": "58",
"Units": "pixels"
}
},
"Studio": "Pearl iZUMi",
"Title": "Pearl iZUMi Men's Quest Cycling Short"
}
},
"Relationships": {
"VariationChild": [
{
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B002KT3XQC"
}
},
"Color": "Black",
"Size": "Small"
},
{
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B002KT3XQW"
}
},
"Color": "Black",
"Size": "Medium"
},
{
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B002KT3XQM"
}
},
"Color": "Black",
"Size": "Large"
},
{
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B002KT3XR6"
}
},
"Color": "Black",
"Size": "X-Large"
},
{
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B002KT3XRG"
}
},
"Color": "Black",
"Size": "XX-Large"
}
]
},
"SalesRankings": {
"SalesRank": [
{
"ProductCategoryId": "apparel_display_on_website",
"Rank": "159"
},
{
"ProductCategoryId": "2420095011",
"Rank": "1"
},
{
"ProductCategoryId": "2611189011",
"Rank": "4"
}
]
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of products and their attributes, based on a list of ASIN values.
Description
The GetMatchingProduct operation returns a list of products and their attributes, based on a list of ASIN values that you specify. This operation returns a maximum of ten products.
GetMatchingProductForId
const mwsRequestData = {
Version: '2011-10-01',
Action: 'GetMatchingProductForId',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
IdType: 'SellerSKU',
'IdList.Id.1': 'SKU'
};
try {
const response = await amazonMws.products.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error products', error);
}
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetMatchingProductForId',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
IdType: 'SellerSKU',
'IdList.Id.1': 'SKU'
};
amazonMws.products.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error products', error);
});
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetMatchingProductForId',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
IdType: 'SellerSKU',
'IdList.Id.1': 'SKU'
};
amazonMws.products.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error products', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "7ba3245e-a213-430a-bea9-EXAMPLE38d76"
},
"Result": [
{
"Id": "9781933988665",
"IdType": "ISBN",
"status": "Success",
"Products": {
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "1933988665"
}
},
"AttributeSets": {
"ItemAttributes": {
"xml:lang": "en-US",
"Author": [
"Marmanis, Haralambos",
"Babenko, Dmitry"
],
"Binding": "Paperback",
"Edition": "1",
"ItemDimensions": {
"Height": {
"Value": "9.17",
"Units": "inches"
},
"Length": {
"Value": "7.36",
"Units": "inches"
},
"Width": {
"Value": "0.75",
"Units": "inches"
},
"Weight": {
"Value": "1.40",
"Units": "pounds"
}
},
"IsEligibleForTradeIn": "true",
"Label": "Manning Publications",
"Languages": {
"Language": [
{
"Name": "english",
"Type": "Unknown"
},
{
"Name": "english",
"Type": "Original Language"
},
{
"Name": "english",
"Type": "Published"
}
]
},
"ListPrice": {
"Amount": "44.99",
"CurrencyCode": "USD"
},
"Manufacturer": "Manning Publications",
"NumberOfItems": "1",
"NumberOfPages": "368",
"PackageDimensions": {
"Height": {
"Value": "0.80",
"Units": "inches"
},
"Length": {
"Value": "9.10",
"Units": "inches"
},
"Width": {
"Value": "7.30",
"Units": "inches"
},
"Weight": {
"Value": "1.35",
"Units": "pounds"
}
},
"ProductGroup": "Book",
"ProductTypeName": "ABIS_BOOK",
"PublicationDate": "2009-07-05",
"Publisher": "Manning Publications",
"SmallImage": {
"URL": "http://ecx.images-amazon.com/images/I/51EEz05N2HL._SL75_.jpg",
"Height": {
"Value": "75",
"Units": "pixels"
},
"Width": {
"Value": "60",
"Units": "pixels"
}
},
"Studio": "Manning Publications",
"Title": "Algorithms of the Intelligent Web"
}
},
"Relationships": {},
"SalesRankings": {
"SalesRank": [
{
"ProductCategoryId": "book_display_on_website",
"Rank": "59485"
},
{
"ProductCategoryId": "377886011",
"Rank": "32"
},
{
"ProductCategoryId": "3887",
"Rank": "66"
},
{
"ProductCategoryId": "3870",
"Rank": "82"
}
]
}
}
}
},
{
"Id": "0439708184",
"IdType": "ISBN",
"status": "Success",
"Products": {
"Product": [
{
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "059035342X"
}
},
"AttributeSets": {
"ItemAttributes": {
"xml:lang": "en-US",
"Author": "Rowling, J.K.",
"Binding": "Paperback",
"Brand": "Scholastic Press",
"Creator": {
"Value": "GrandPré, Mary",
"Role": "Illustrator"
},
"Edition": "1st",
"Feature": "Recommended Age: 9 years and up",
"ItemDimensions": {
"Height": {
"Value": "0.80",
"Units": "inches"
},
"Length": {
"Value": "7.50",
"Units": "inches"
},
"Width": {
"Value": "5.20",
"Units": "inches"
},
"Weight": {
"Value": "0.50",
"Units": "pounds"
}
},
"IsAutographed": "false",
"IsMemorabilia": "false",
"Label": "Scholastic Paperbacks",
"Languages": {
"Language": [
{
"Name": "english",
"Type": "Unknown"
},
{
"Name": "english",
"Type": "Original Language"
},
{
"Name": "english",
"Type": "Published"
}
]
},
"ListPrice": {
"Amount": "10.99",
"CurrencyCode": "USD"
},
"Manufacturer": "Scholastic Paperbacks",
"NumberOfItems": "1",
"NumberOfPages": "320",
"PackageDimensions": {
"Height": {
"Value": "1.00",
"Units": "inches"
},
"Length": {
"Value": "7.50",
"Units": "inches"
},
"Width": {
"Value": "5.20",
"Units": "inches"
},
"Weight": {
"Value": "0.50",
"Units": "pounds"
}
},
"PackageQuantity": "1",
"PartNumber": "9780590353427",
"ProductGroup": "Book",
"ProductTypeName": "ABIS_BOOK",
"PublicationDate": "1999-10-01",
"Publisher": "Scholastic Paperbacks",
"ReleaseDate": "1999-09-08",
"SmallImage": {
"URL": "http://ecx.images-amazon.com/images/I/51MU5VilKpL._SL75_.jpg",
"Height": {
"Value": "75",
"Units": "pixels"
},
"Width": {
"Value": "51",
"Units": "pixels"
}
},
"Studio": "Scholastic Paperbacks",
"Title": "Harry Potter and the Sorcerer's Stone (Book 1)"
}
},
"Relationships": {},
"SalesRankings": {
"SalesRank": [
{
"ProductCategoryId": "book_display_on_website",
"Rank": "362"
},
{
"ProductCategoryId": "15356791",
"Rank": "6"
},
{
"ProductCategoryId": "3153",
"Rank": "9"
},
{
"ProductCategoryId": "3045",
"Rank": "14"
}
]
}
},
{
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "0439708184"
}
},
"AttributeSets": {
"ItemAttributes": {
"xml:lang": "en-US",
"Author": "J.K. Rowling, Mary GrandPré",
"Binding": "Paperback",
"Label": "Scholastic Paperbacks",
"Languages": {
"Language": [
{
"Name": "english",
"Type": "Unknown"
},
{
"Name": "english",
"Type": "Published"
}
]
},
"Manufacturer": "Scholastic Paperbacks",
"NumberOfItems": "1",
"NumberOfPages": "784",
"PackageDimensions": {
"Height": {
"Value": "0.73",
"Units": "inches"
},
"Length": {
"Value": "8.43",
"Units": "inches"
},
"Width": {
"Value": "5.85",
"Units": "inches"
},
"Weight": {
"Value": "0.79",
"Units": "pounds"
}
},
"ProductGroup": "Book",
"ProductTypeName": "BOOKS_1973_AND_LATER",
"PublicationDate": "1999-09-08",
"Publisher": "Scholastic Paperbacks",
"SmallImage": {
"URL": "http://ecx.images-amazon.com/images/I/51STfI7UiCL._SL75_.jpg",
"Height": {
"Value": "75",
"Units": "pixels"
},
"Width": {
"Value": "52",
"Units": "pixels"
}
},
"Studio": "Scholastic Paperbacks",
"Title": "Harry Potter and the Sorcerer's Stone"
}
},
"Relationships": {},
"SalesRankings": {
"SalesRank": {
"ProductCategoryId": "book_display_on_website",
"Rank": "2091024"
}
}
}
]
}
}
],
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of products and their attributes, based on a list of ASIN, GCID, SellerSKU, UPC, EAN, ISBN, and JAN values.
Description
The GetMatchingProductForId operation returns a list of products and their attributes, based on a list of product identifier values that you specify. Possible product identifiers are ASIN, GCID, SellerSKU, UPC, EAN, ISBN, and JAN.
GetCompetitivePricingForASIN
const mwsRequestData = {
Version: '2011-10-01',
Action: 'GetCompetitivePricingForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ASINList.ASIN.1': 'ASIN'
};
try {
const response = await amazonMws.products.searchFor(mwsRequestData);
console.log('response ', response);
} catch (error) {
console.log('error products', error);
}
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetCompetitivePricingForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ASINList.ASIN.1': 'ASIN'
};
amazonMws.products.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error products', error);
});
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetCompetitivePricingForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ASINList.ASIN.1': 'ASIN'
};
amazonMws.products.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error products', error);
return;
}
console.log('response ', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "a8ec20c3-fc88-46e3-a128-EXAMPLE3fcdf"
},
"Result": {
"ASIN": "B002KT3XQM",
"status": "Success",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B002KT3XQM"
}
},
"CompetitivePricing": {
"CompetitivePrices": {
"CompetitivePrice": {
"belongsToRequester": "false",
"condition": "New",
"subcondition": "New",
"CompetitivePriceId": "1",
"Price": {
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": "34.27"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "34.27"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "0.00"
}
}
}
},
"NumberOfOfferListings": {
"OfferListingCount": [
{
"Value": "11",
"condition": "Any"
},
{
"Value": "1",
"condition": "Used"
},
{
"Value": "10",
"condition": "New"
}
]
}
},
"SalesRankings": {}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the current competitive price of a product, based on ASIN.
Description
The GetCompetitivePricingForASIN operation is the same as the GetCompetitivePricingForSKU operation, except that it uses a MarketplaceId and an ASIN to uniquely identify a product, and it does not return the SKUIdentifier element. If you do not have the ASIN for a product, you will first have to submit the ListMatchingProducts operation for disambiguation.
GetCompetitivePricingForSKU
const mwsRequestData = {
Version: '2011-10-01',
Action: 'GetCompetitivePricingForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'SellerSKUList.SellerSKU.1': 'SELLER_SKU'
};
try {
const response = await amazonMws.products.searchFor(mwsRequestData);
console.log('response ', response);
} catch (error) {
console.log('error products', error);
}
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetCompetitivePricingForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'SellerSKUList.SellerSKU.1': 'SELLER_SKU'
};
amazonMws.products.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error products', error);
});
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetCompetitivePricingForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'SellerSKUList.SellerSKU.1': 'SELLER_SKU'
};
amazonMws.products.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error products', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "003fc73e-bf70-4e55-8db8-EXAMPLEce417"
},
"Result": {
"SellerSKU": "SKU2468",
"status": "Success",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "1933890517"
},
"SKUIdentifier": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerId": "A1IMEXAMPLEWRC",
"SellerSKU": "SKU2468"
}
},
"CompetitivePricing": {
"CompetitivePrices": {
"CompetitivePrice": [
{
"belongsToRequester": "false",
"condition": "New",
"subcondition": "New",
"CompetitivePriceId": "1",
"Price": {
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": "40.03"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "40.03"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "0.00"
}
}
},
{
"belongsToRequester": "false",
"condition": "Used",
"subcondition": "Good",
"CompetitivePriceId": "2",
"Price": {
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": "30.50"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "30.50"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "0.00"
}
}
}
]
},
"NumberOfOfferListings": {
"OfferListingCount": [
{
"Value": "296",
"condition": "Any"
},
{
"Value": "145",
"condition": "Used"
},
{
"Value": "151",
"condition": "New"
}
]
},
"TradeInValue": {
"CurrencyCode": "USD",
"Amount": "17.05"
}
},
"SalesRankings": {
"SalesRank": [
{
"ProductCategoryId": "book_display_on_website",
"Rank": "900"
},
{
"ProductCategoryId": "271578011",
"Rank": "1"
},
{
"ProductCategoryId": "355562011",
"Rank": "8"
},
{
"ProductCategoryId": "173516",
"Rank": "25"
}
]
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the current competitive price of a product, based on SellerSKU.
Description
The GetCompetitivePricingForSKU operation returns the current competitive pricing of a product, based on the SellerSKU and MarketplaceId that you specify. Note that SellerSKU is qualified by your SellerId, which is included with every Amazon Marketplace Web Service (Amazon MWS) operation that you submit. This operation returns pricing for active offer listings based on two pricing models: New Buy Box Price and Used Buy Box Price. These pricing models are equivalent to the main Buy Box Price and the subordinate Buy Box Price, respectively, on a detail page from an Amazon marketplace website. Note that products with active offer listings might not return either of these prices. This could happen, for example, if none of the sellers with offer listings for a product are qualified for the New Buy Box or the Used Buy Box. Also note that your own price for the SellerSKU that you specify is not excluded from the response, so your price will be returned if it is the lowest listed price. The number of offer listings, the trade-in value, and the sales rankings for the SellerSKU that you specify are also returned.
GetLowestOfferListingsForSKU
const mwsRequestData = {
Version: '2011-10-01',
Action: 'GetLowestOfferListingsForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'SellerSKUList.SellerSKU.1': 'SELLER_SKU'
};
try {
const response = await amazonMws.products.searchFor(mwsRequestData);
console.log('response ', response);
} catch (error) {
console.log('error products', error);
}
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetLowestOfferListingsForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'SellerSKUList.SellerSKU.1': 'SELLER_SKU'
};
amazonMws.products.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error products', error);
});
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetLowestOfferListingsForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'SellerSKUList.SellerSKU.1': 'SELLER_SKU'
};
amazonMws.products.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error products', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "8106ed19-9a90-4820-881e-EXAMPLE0ab97"
},
"Result": {
"SellerSKU": "SKU2468",
"status": "Success",
"AllOfferListingsConsidered": "false",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "1933890517"
},
"SKUIdentifier": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerId": "A1IMEXAMPLEWRC",
"SellerSKU": "SKU2468"
}
},
"LowestOfferListings": {
"LowestOfferListing": [
{
"Qualifiers": {
"ItemCondition": "Used",
"ItemSubcondition": "Acceptable",
"FulfillmentChannel": "Merchant",
"ShipsDomestically": "True",
"ShippingTime": {
"Max": "0-2 days"
},
"SellerPositiveFeedbackRating": "95-97%"
},
"NumberOfOfferListingsConsidered": "3",
"SellerFeedbackCount": "8900",
"Price": {
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": "28.68"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "24.69"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "3.99"
}
},
"MultipleOffersAtLowestPrice": "True"
},
{
"Qualifiers": {
"ItemCondition": "Used",
"ItemSubcondition": "Good",
"FulfillmentChannel": "Amazon",
"ShipsDomestically": "True",
"ShippingTime": {
"Max": "0-2 days"
},
"SellerPositiveFeedbackRating": "90-94%"
},
"NumberOfOfferListingsConsidered": "1",
"SellerFeedbackCount": "1569694",
"Price": {
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": "30.50"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "30.50"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "0.00"
}
},
"MultipleOffersAtLowestPrice": "False"
},
{
"Qualifiers": {
"ItemCondition": "Used",
"ItemSubcondition": "Good",
"FulfillmentChannel": "Merchant",
"ShipsDomestically": "True",
"ShippingTime": {
"Max": "0-2 days"
},
"SellerPositiveFeedbackRating": "95-97%"
},
"NumberOfOfferListingsConsidered": "3",
"SellerFeedbackCount": "7732",
"Price": {
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": "30.99"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "27.00"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "3.99"
}
},
"MultipleOffersAtLowestPrice": "False"
}
]
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns pricing information for the lowest-price active offer listings for up to 20 products, based on SellerSKU.
Description
The GetLowestOfferListingsForSKU operation returns the lowest price offer listings for a specific product by item condition.
GetLowestOfferListingsForASIN
let ASINList = [ 'ASIN.1', 'ASIN.2' ];
const mwsRequestData = {
Version: '2011-10-01',
Action: 'GetLowestOfferListingsForASIN',
SellerId: mwsAccount.sellerId,
MarketplaceId: mwsAccount.marketplaceId,
ItemCondition: 'New'
};
try {
let index = 1;
for (let i in ASINList) {
mwsRequestData[ 'ASINList.ASIN.' + index ] = ASINList[ i ];
index++;
}
const response = await amazonMws.products.searchFor(mwsRequestData);
console.log('response ', response);
} catch (error) {
console.log('error products', error);
}
var ASINList = ['ASIN.1', 'ASIN.2'];
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetLowestOfferListingsForASIN',
SellerId: mwsAccount.sellerId,
MarketplaceId: mwsAccount.marketplaceId,
ItemCondition: 'New'
};
var index = 1;
for (var i in ASINList) {
mwsRequestData['ASINList.ASIN.' + index] = ASINList[i];
index++;
}
amazonMws.products.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error products', error);
});
var ASINList = ['ASIN.1', 'ASIN.2'];
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetLowestOfferListingsForASIN',
SellerId: mwsAccount.sellerId,
MarketplaceId: mwsAccount.marketplaceId,
ItemCondition: 'New'
};
var index = 1;
for (var i in ASINList) {
mwsRequestData['ASINList.ASIN.' + index] = ASINList[i];
index++;
}
amazonMws.products.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "60979901-82af-457b-8bdd-EXAMPLE28478"
},
"Result": {
"ASIN": "B002KT3XQM",
"status": "Success",
"AllOfferListingsConsidered": "true",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B002KT3XQM"
}
},
"LowestOfferListings": {
"LowestOfferListing": [
{
"Qualifiers": {
"ItemCondition": "Used",
"ItemSubcondition": "VeryGood",
"FulfillmentChannel": "Merchant",
"ShipsDomestically": "True",
"ShippingTime": {
"Max": "0-2 days"
},
"SellerPositiveFeedbackRating": "90-94%"
},
"NumberOfOfferListingsConsidered": "1",
"SellerFeedbackCount": "762",
"Price": {
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": "32.99"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "28.00"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "4.99"
}
},
"MultipleOffersAtLowestPrice": "False"
},
{
"Qualifiers": {
"ItemCondition": "New",
"ItemSubcondition": "New",
"FulfillmentChannel": "Amazon",
"ShipsDomestically": "True",
"ShippingTime": {
"Max": "0-2 days"
},
"SellerPositiveFeedbackRating": "98-100%"
},
"NumberOfOfferListingsConsidered": "1",
"SellerFeedbackCount": "181744",
"Price": {
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": "34.27"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "34.27"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "0.00"
}
},
"MultipleOffersAtLowestPrice": "False"
},
{
"Qualifiers": {
"ItemCondition": "New",
"ItemSubcondition": "New",
"FulfillmentChannel": "Amazon",
"ShipsDomestically": "True",
"ShippingTime": {
"Max": "0-2 days"
},
"SellerPositiveFeedbackRating": "95-97%"
},
"NumberOfOfferListingsConsidered": "1",
"SellerFeedbackCount": "13213",
"Price": {
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": "41.18"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "41.18"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "0.00"
}
},
"MultipleOffersAtLowestPrice": "False"
}
]
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns pricing information for the lowest-price active offer listings for up to 20 products, based on ASIN.
Description
The GetLowestOfferListingsForASIN operation is the same as the GetLowestOfferListingsForSKU operation except that it uses a MarketplaceId and an ASIN to uniquely identify a product, and it does not return the SKUIdentifier element.
GetLowestPricedOffersForSKU
const mwsRequestData = {
Version: '2011-10-01',
Action: 'GetLowestPricedOffersForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
SellerSKU: 'SELLER_SKU',
ItemCondition: 'New'
};
try {
const response = await amazonMws.products.searchFor(mwsRequestData);
console.log('response ', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetLowestPricedOffersForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
SellerSKU: 'SELLER_SKU',
ItemCondition: 'New'
};
amazonMws.products.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetLowestPricedOffersForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
SellerSKU: 'SELLER_SKU',
ItemCondition: 'New'
};
amazonMws.products.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response ', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "fd2e6c6d-0b6d-499b-9fea-074175c0547a"
},
"Result": {
"MarketplaceID": "ATVPDKIKX0DER",
"SKU": "GE Product",
"ItemCondition": "New",
"status": "Success",
"Identifier": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerSKU": "GE Product",
"ItemCondition": "New",
"TimeOfOfferChange": "2015-07-19T23:15:11.859Z"
},
"Summary": {
"TotalOfferCount": "1",
"NumberOfOffers": {
"OfferCount": {
"Value": "1",
"condition": "new",
"fulfillmentChannel": "Amazon"
}
},
"LowestPrices": {
"LowestPrice": {
"condition": "new",
"fulfillmentChannel": "Amazon",
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": "32.99"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "32.99"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "0.00"
}
}
},
"BuyBoxPrices": {
"BuyBoxPrice": {
"condition": "New",
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": "32.99"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "32.99"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "0.00"
}
}
},
"ListPrice": {
"CurrencyCode": "USD",
"Amount": "58.34"
},
"SuggestedLowerPricePlusShipping": {
"CurrencyCode": "USD",
"Amount": "32.99"
},
"BuyBoxEligibleOffers": {
"OfferCount": {
"Value": "1",
"condition": "new",
"fulfillmentChannel": "Amazon"
}
}
},
"Offers": {
"Offer": {
"MyOffer": "false",
"SubCondition": "new",
"SellerFeedbackRating": {
"SellerPositiveFeedbackRating": "100.0",
"FeedbackCount": "1"
},
"ShippingTime": {
"minimumHours": "0",
"maximumHours": "0",
"availabilityType": "NOW"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "32.99"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "0.00"
},
"IsFulfilledByAmazon": "true",
"IsBuyBoxWinner": "true",
"IsFeaturedMerchant": "true"
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns lowest priced offers for a single product, based on SellerSKU.
Description
The GetLowestPricedOffersForSKU operation returns the top 20 offers for a given MarketplaceId, SellerSKU, and ItemCondition that you specify. The top 20 offers are determined by the lowest landed price, which is the price plus shipping minus Amazon Points. If multiple sellers are charging the same landed price, the results will be returned in random order.
GetLowestPricedOffersForASIN
const mwsRequestData = {
Version: '2011-10-01',
Action: 'GetLowestPricedOffersForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
ASIN: 'ASIN',
ItemCondition: 'New'
};
try {
const response = await amazonMws.products.searchFor(mwsRequestData);
console.log('response ', response);
} catch (error) {
console.log('error products', error);
}
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetLowestPricedOffersForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
ASIN: 'ASIN',
ItemCondition: 'New'
};
amazonMws.products.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error products', error);
});
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetLowestPricedOffersForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
ASIN: 'ASIN',
ItemCondition: 'New'
};
amazonMws.products.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error products', error);
return;
}
console.log('response ', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "21534f03-e7e3-4d9a-9bea-0e15add3326d"
},
"Result": {
"MarketplaceID": "ATVPDKIKX0DER",
"ItemCondition": "New",
"ASIN": "B0002GTTRC",
"status": "Success",
"Identifier": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B0002GTTRC",
"ItemCondition": "New",
"TimeOfOfferChange": "2015-07-19T23:15:11.859Z"
},
"Summary": {
"TotalOfferCount": "0",
"NumberOfOffers": {
"OfferCount": {
"Value": "1",
"condition": "new",
"fulfillmentChannel": "Amazon"
}
},
"LowestPrices": {
"LowestPrice": {
"condition": "new",
"fulfillmentChannel": "Amazon",
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": "32.99"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "32.99"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "0.00"
}
}
},
"BuyBoxPrices": {
"BuyBoxPrice": {
"condition": "New",
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": "32.99"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "32.99"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "0.00"
}
}
},
"ListPrice": {
"CurrencyCode": "USD",
"Amount": "58.34"
},
"SuggestedLowerPricePlusShipping": {
"CurrencyCode": "USD",
"Amount": "32.99"
},
"BuyBoxEligibleOffers": {
"OfferCount": {
"Value": "1",
"condition": "new",
"fulfillmentChannel": "Amazon"
}
}
},
"Offers": {
"Offer": {
"SubCondition": "new",
"SellerFeedbackRating": {
"SellerPositiveFeedbackRating": "100.0",
"FeedbackCount": "1"
},
"ShippingTime": {
"minimumHours": "0",
"maximumHours": "0",
"availabilityType": "NOW"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "32.99"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "0.00"
},
"IsFulfilledByAmazon": "true",
"IsBuyBoxWinner": "true",
"IsFeaturedMerchant": "true"
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns lowest priced offers for a single product, based on ASIN.
Description
The GetLowestPricedOffersForASIN operation is the same as the GetLowestPricedOffersForSKU operation, except that it uses a MarketplaceId and an ASIN to uniquely identify a product, and it does not return the MyOffer element. If you do not have the ASIN for a product, you can use the ListMatchingProducts operation to search for the ASIN.
GetMyFeesEstimate
const mwsRequestData = {
Version: '2011-10-01',
Action: 'GetMyFeesEstimate',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'FeesEstimateRequestList.FeesEstimateRequest.1.MarketplaceId': 'MARKET_PLACE_ID',
'FeesEstimateRequestList.FeesEstimateRequest.1.IdType': 'ASIN',
'FeesEstimateRequestList.FeesEstimateRequest.1.IdValue': 'ASIN',
'FeesEstimateRequestList.FeesEstimateRequest.1.IsAmazonFulfilled': 'true',
'FeesEstimateRequestList.FeesEstimateRequest.1.Identifier': 'Hello',
'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.ListingPrice.CurrencyCode': 'USD',
'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.ListingPrice.Amount': '30.00',
'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.Shipping.CurrencyCode': 'USD',
'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.Shipping.Amount': '3.99',
'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.Points.PointsNumber': '0'
};
try {
const response = await amazonMws.products.search(mwsRequestData);
console.log('response ', response);
} catch (error) {
console.log('error products', error);
}
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetMyFeesEstimate',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'FeesEstimateRequestList.FeesEstimateRequest.1.MarketplaceId': 'MARKET_PLACE_ID',
'FeesEstimateRequestList.FeesEstimateRequest.1.IdType': 'ASIN',
'FeesEstimateRequestList.FeesEstimateRequest.1.IdValue': 'ASIN',
'FeesEstimateRequestList.FeesEstimateRequest.1.IsAmazonFulfilled': 'true',
'FeesEstimateRequestList.FeesEstimateRequest.1.Identifier': 'Hello',
'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.ListingPrice.CurrencyCode': 'USD',
'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.ListingPrice.Amount': '30.00',
'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.Shipping.CurrencyCode': 'USD',
'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.Shipping.Amount': '3.99',
'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.Points.PointsNumber': '0'
};
amazonMws.products.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error products', error);
});
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetMyFeesEstimate',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'FeesEstimateRequestList.FeesEstimateRequest.1.MarketplaceId': 'MARKET_PLACE_ID',
'FeesEstimateRequestList.FeesEstimateRequest.1.IdType': 'ASIN',
'FeesEstimateRequestList.FeesEstimateRequest.1.IdValue': 'ASIN',
'FeesEstimateRequestList.FeesEstimateRequest.1.IsAmazonFulfilled': 'true',
'FeesEstimateRequestList.FeesEstimateRequest.1.Identifier': 'Hello',
'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.ListingPrice.CurrencyCode': 'USD',
'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.ListingPrice.Amount': '30.00',
'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.Shipping.CurrencyCode': 'USD',
'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.Shipping.Amount': '3.99',
'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.Points.PointsNumber': '0'
};
amazonMws.products.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error products', error);
return;
}
console.log('response ', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "21534f03-e7e3-4d9a-9bea-0e15add3326d"
},
"Result": {
"FeesEstimateResultList": {
"FeesEstimateResult": {
"Status": "Success",
"FeesEstimateIdentifier": {
"MarketplaceId": "ATVPDKIKX0DER",
"IdValue": "B0002GTTRC",
"IdType": "ASIN",
"IsAmazonFulfilled": "True",
"PriceToEstimateFees": {
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "58.00"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "0.00"
},
"Points": {
"PointsNumber": "0"
}
},
"SellerInputIdentifier": "IDDDDDDDD"
},
"FeesEstimate": {
"TimeOfFeesEstimation": "2015-07-19T23:15:11.859Z",
"TotalFeesEstimate": {
"CurrencyCode": "USD",
"Amount": "10.00"
},
"FeeDetailList": {
"FeeDetail": [
{
"FeeType": "AmazonReferralFee",
"FeeAmount": {
"CurrencyCode": "USD",
"Amount": "8.70"
},
"FeePromotion": {
"CurrencyCode": "USD",
"Amount": "1.00"
},
"FinalFee": {
"CurrencyCode": "USD",
"Amount": "7.70"
}
},
{
"FeeType": "VariableClosingFee",
"FeeAmount": {
"CurrencyCode": "USD",
"Amount": "0.00"
},
"FinalFee": {
"CurrencyCode": "USD",
"Amount": "0.0"
}
},
{
"FeeType": "FulfillmentFees",
"FeeAmount": {
"CurrencyCode": "USD",
"Amount": "2.30"
},
"FinalFee": {
"CurrencyCode": "USD",
"Amount": "2.30"
},
"IncludedFeeList": {
"FeeDetail": [
{
"FeeType": "OrderHandlingFee",
"FeeAmount": {
"CurrencyCode": "USD",
"Amount": "1.00"
},
"FinalFee": {
"CurrencyCode": "USD",
"Amount": "1.00"
}
},
{
"FeeType": "PickAndPackFee",
"FeeAmount": {
"CurrencyCode": "USD",
"Amount": "0.30"
},
"FinalFee": {
"CurrencyCode": "USD",
"Amount": "0.30"
}
},
{
"FeeType": "WeightHandlingFee",
"FeeAmount": {
"CurrencyCode": "USD",
"Amount": "1.00"
},
"FinalFee": {
"CurrencyCode": "USD",
"Amount": "1.00"
}
}
]
}
}
]
}
}
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the estimated fees for a list of products.
Description
The GetMyFeesEstimate operation takes a list of products and marketplaces returns the fees for those products in those marketplaces. You can call GetMyFeesEstimate for a set of products before setting prices on those products. Your prices can then take estimated fees into account. You must specify your products by ASIN or SKU (not UPC, ISBN, etc). With each product fees request, you must include an original identifier. This identifier is included in the fees estimate so you can correlate a fees estimate with an original request.
GetMyPriceForSKU
const mwsRequestData = {
Version: '2011-10-01',
Action: 'GetMyPriceForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'SellerSKUList.SellerSKU.1': 'SELLER_SKU'
};
try {
const response = await amazonMws.products.searchFor(mwsRequestData);
console.log('response ', response);
} catch (error) {
console.log('error products', error);
}
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetMyPriceForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'SellerSKUList.SellerSKU.1': 'SELLER_SKU'
};
amazonMws.products.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error products', error);
});
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetMyPriceForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'SellerSKUList.SellerSKU.1': 'SELLER_SKU'
};
amazonMws.products.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error products', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "bc6e4601-3d74-4612-adcf-EXAMPLEf1796"
},
"Result": {
"SellerSKU": "SKU2468",
"status": "Success",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "1933890517"
},
"SKUIdentifier": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerId": "A1IMEXAMPLEWRC",
"SellerSKU": "SKU2468"
}
},
"Offers": {
"Offer": {
"BuyingPrice": {
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": "303.99"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "300.00"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "3.99"
}
},
"RegularPrice": {
"CurrencyCode": "USD",
"Amount": "300.00"
},
"FulfillmentChannel": "MERCHANT",
"ItemCondition": "Used",
"ItemSubCondition": "Acceptable",
"SellerId": "A1IMEXAMPLEWRC",
"SellerSKU": "SKU2468"
}
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns pricing information for your own active offer listings, based on SellerSKU.
Description
The GetMyPriceForSKU operation returns pricing information for your own active offer listings, based on the ASIN mapped to the SellerSKU and MarketplaceId that you specify.
GetMyPriceForASIN
const mwsRequestData = {
Version: '2011-10-01',
Action: 'GetMyPriceForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ASINList.ASIN.1': 'ASINList_ASIN_1'
};
try {
const response = await amazonMws.products.searchFor(mwsRequestData);
console.log('response ', response);
} catch (error) {
console.log('error products', error);
}
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetMyPriceForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ASINList.ASIN.1': 'ASINList_ASIN_1'
};
amazonMws.products.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error products', error);
});
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetMyPriceForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'ASINList.ASIN.1': 'ASINList_ASIN_1'
};
amazonMws.products.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error products', error);
return;
}
console.log('response ', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "a3381684-87bd-416e-9b95-EXAMPLE9c236"
},
"Result": {
"ASIN": "1933890517",
"status": "Success",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "1933890517"
}
},
"Offers": {
"Offer": {
"BuyingPrice": {
"LandedPrice": {
"CurrencyCode": "USD",
"Amount": "303.99"
},
"ListingPrice": {
"CurrencyCode": "USD",
"Amount": "300.00"
},
"Shipping": {
"CurrencyCode": "USD",
"Amount": "3.99"
}
},
"RegularPrice": {
"CurrencyCode": "USD",
"Amount": "300.00"
},
"FulfillmentChannel": "MERCHANT",
"ItemCondition": "Used",
"ItemSubCondition": "Acceptable",
"SellerId": "A1IMEXAMPLEWRC",
"SellerSKU": "SKU2468"
}
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns pricing information for your own active offer listings, based on ASIN.
Description
The GetMyPriceForASIN operation is the same as the GetMyPriceForSKU operation except that it uses a MarketplaceId and an ASIN to uniquely identify a product, and it does not return the SKUIdentifier element.
GetMatchingProductMultipleASIN
let ASINList = ['ASIN.1', 'ASIN.2'];
const data = {
Version: '2011-10-01',
Action: 'GetMatchingProduct',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID'
};
try {
let index = 1;
for (let i in ASINList) {
data['ASINList.ASIN.' + index] = ASINList[i];
index++;
}
const response = await amazonMws.products.search(data);
console.log('response', response);
} catch (error) {
console.log('error products', error);
}
var ASINList = ['ASIN.1', 'ASIN.2'];
var data = {
Version: '2011-10-01',
Action: 'GetMatchingProduct',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID'
};
var index = 1;
for (var i in ASINList) {
data['ASINList.ASIN.' + index] = ASINList[i];
index++;
}
amazonMws.products.search(data).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error products', error);
});
var ASINList = ['ASIN.1', 'ASIN.2'];
var data = {
Version: '2011-10-01',
Action: 'GetMatchingProduct',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID'
};
var index = 1;
for (var i in ASINList) {
data['ASINList.ASIN.' + index] = ASINList[i];
index++;
}
amazonMws.products.search(data, function (error, response) {
if (error) {
console.log('error products', error);
return;
}
//console.log('response ', JSON.stringify(response));
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "b12caada-d330-4d87-a789-EXAMPLE35872"
},
"Result": {
"ASIN": "B002KT3XRQ",
"status": "Success",
"Product": {
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B002KT3XRQ"
}
},
"AttributeSets": {
"ItemAttributes": {
"xml:lang": "en-US",
"Binding": "Apparel",
"Brand": "Pearl iZUMi",
"Department": "mens",
"Feature": [
"Select transfer fabric sets the benchmark for moisture transfer and
four-way performance stretch",
"6-Panel anatomic design for superior, chafe-free comfort, UPF 50+ sun
protection",
"Comfortable silicone leg grippers keep shorts in place,
moisture-wicking, antimicrobial properties",
"Tour 3D Chamois is male-specific and non-chafing with padding in
key areas",
"86 percent nylon, 14% spandex, 9-Inch inseam"
],
"ItemDimensions": {
"Height": {
"Value": "2.00",
"Units": "inches"
},
"Length": {
"Value": "9.00",
"Units": "inches"
},
"Width": {
"Value": "9.00",
"Units": "inches"
}
},
"Label": "Pearl iZUMi",
"ListPrice": {
"Amount": "50.00",
"CurrencyCode": "USD"
},
"Manufacturer": "Pearl iZUMi",
"Model": "0275",
"PackageDimensions": {
"Height": {
"Value": "2.80",
"Units": "inches"
},
"Length": {
"Value": "9.75",
"Units": "inches"
},
"Width": {
"Value": "8.40",
"Units": "inches"
},
"Weight": {
"Value": "0.40",
"Units": "pounds"
}
},
"PackageQuantity": "1",
"PartNumber": "0275",
"ProductGroup": "Apparel",
"ProductTypeName": "SHORTS",
"Publisher": "Pearl iZUMi",
"SmallImage": {
"URL": "http://ecx.images-amazon.com/images/I/41ty3Sn%2BU8L._SL75_.jpg",
"Height": {
"Value": "75",
"Units": "pixels"
},
"Width": {
"Value": "58",
"Units": "pixels"
}
},
"Studio": "Pearl iZUMi",
"Title": "Pearl iZUMi Men's Quest Cycling Short"
}
},
"Relationships": {
"VariationChild": [
{
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B002KT3XQC"
}
},
"Color": "Black",
"Size": "Small"
},
{
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B002KT3XQW"
}
},
"Color": "Black",
"Size": "Medium"
},
{
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B002KT3XQM"
}
},
"Color": "Black",
"Size": "Large"
},
{
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B002KT3XR6"
}
},
"Color": "Black",
"Size": "X-Large"
},
{
"Identifiers": {
"MarketplaceASIN": {
"MarketplaceId": "ATVPDKIKX0DER",
"ASIN": "B002KT3XRG"
}
},
"Color": "Black",
"Size": "XX-Large"
}
]
},
"SalesRankings": {
"SalesRank": [
{
"ProductCategoryId": "apparel_display_on_website",
"Rank": "159"
},
{
"ProductCategoryId": "2420095011",
"Rank": "1"
},
{
"ProductCategoryId": "2611189011",
"Rank": "4"
}
]
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of products and their attributes, based on a list of ASIN values.
Description
The GetMatchingProduct operation returns a list of products and their attributes, based on a list of ASIN values that you specify. This operation returns a maximum of ten products.
GetProductCategoriesForSKU
const mwsRequestData = {
Version: '2011-10-01',
Action: 'GetProductCategoriesForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
SellerSKU: 'SELLER_SKU'
};
try {
const response = await amazonMws.products.searchFor(mwsRequestData);
console.log('response ', response);
} catch (error) {
console.log('error products', error);
}
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetProductCategoriesForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
SellerSKU: 'SELLER_SKU'
};
amazonMws.products.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error products', error);
});
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetProductCategoriesForSKU',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
SellerSKU: 'SELLER_SKU'
};
amazonMws.products.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error products', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "e058aabd-b4c3-48ba-9bfa-EXAMPLE9a267"
},
"Result": {
"Self": [
{
"ProductCategoryId": "271578011",
"ProductCategoryName": "Project Management",
"Parent": {
"ProductCategoryId": "2675",
"ProductCategoryName": "Management & Leadership",
"Parent": {
"ProductCategoryId": "3",
"ProductCategoryName": "Business & Investing",
"Parent": {
"ProductCategoryId": "1000",
"ProductCategoryName": "Subjects",
"Parent": {
"ProductCategoryId": "283155",
"ProductCategoryName": "Subjects"
}
}
}
}
},
{
"ProductCategoryId": "684248011",
"ProductCategoryName": "Management",
"Parent": {
"ProductCategoryId": "468220",
"ProductCategoryName": "Business & Finance",
"Parent": {
"ProductCategoryId": "465600",
"ProductCategoryName": "New, Used & Rental Textbooks",
"Parent": {
"ProductCategoryId": "2349030011",
"ProductCategoryName": "Specialty Boutique",
"Parent": {
"ProductCategoryId": "283155",
"ProductCategoryName": "Specialty Boutique"
}
}
}
}
}
]
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the parent product categories that a product belongs to, based on SellerSKU.
Description
The GetProductCategoriesForSKU operation returns the product category name and identifier that a product belongs to, including parent categories back to the root for the marketplace.
GetProductCategoriesForASIN
const mwsRequestData = {
Version: '2011-10-01',
Action: 'GetProductCategoriesForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
ASIN: 'ASIN'
};
try {
const response = await amazonMws.products.searchFor(mwsRequestData);
console.log('response ', response);
} catch (error) {
console.log('error products', error);
}
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetProductCategoriesForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
ASIN: 'ASIN'
};
amazonMws.products.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error products', error);
});
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetProductCategoriesForASIN',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
ASIN: 'ASIN'
};
amazonMws.products.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error products', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "fbce5b62-67cc-4ab8-86f3-EXAMPLE22e4e"
},
"Result": {
"Self": {
"ProductCategoryId": "2420095011",
"ProductCategoryName": "Compression Shorts",
"Parent": {
"ProductCategoryId": "2419332011",
"ProductCategoryName": "Men",
"Parent": {
"ProductCategoryId": "2371051011",
"ProductCategoryName": "Clothing",
"Parent": {
"ProductCategoryId": "3403201",
"ProductCategoryName": "Bikes & Accessories",
"Parent": {
"ProductCategoryId": "2232464011",
"ProductCategoryName": "Bikes & Scooters",
"Parent": {
"ProductCategoryId": "3375301",
"ProductCategoryName": "Categories",
"Parent": {
"ProductCategoryId": "3375251",
"ProductCategoryName": "Categories"
}
}
}
}
}
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the parent product categories that a product belongs to, based on ASIN.
Description
The GetProductCategoriesForASIN operation is the same as the GetProductCategoriesForSKU operation except that it uses a MarketplaceId and an ASIN to uniquely identify a product.
GetServiceStatus
const mwsRequestData = {
Version: '2011-10-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
};
try {
const response = await amazonMws.products.searchFor(mwsRequestData);
console.log('response ', response);
} catch (error) {
console.log('error products', error);
}
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
};
amazonMws.products.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error products', error);
});
var mwsRequestData = {
Version: '2011-10-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
};
amazonMws.products.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error products', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "0a51dc17-20bf-4e0d-8ac5-5d53bd1129cf"
},
"Result": {
"Status": "GREEN",
"Timestamp": "2012-12-04T22:53:58.830Z"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the operational status of the Products API section.
Description
The GetServiceStatus operation returns the operational status of the Products API section of Amazon Marketplace Web Service (Amazon MWS). Status values are GREEN, YELLOW, and RED.
Recommendations
GetLastUpdatedTimeForRecommendations
const mwsRequestData = {
Version: '2013-04-01',
Action: 'GetLastUpdatedTimeForRecommendations',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID'
};
try {
const response = await amazonMws.recommendations.searchFor(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-04-01',
Action: 'GetLastUpdatedTimeForRecommendations',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID'
};
amazonMws.recommendations.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-04-01',
Action: 'GetLastUpdatedTimeForRecommendations',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID'
};
amazonMws.recommendations.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Checks whether there are active recommendations for each category for the given marketplace, and if there are, returns the time when recommendations were last updated for each category.
Description
The GetLastUpdatedTimeForRecommendations operation enables you to check whether there are active recommendations for you in a given recommendation category, and if there are, to check when the recommendations for that category were last updated. If the last updated timestamp returned for a category in this operation is newer than the last updated timestamp returned for a category when you last called this operation, then you should call the ListRecommendations operation again to get your latest recommendations for that category. Otherwise, there is no need to call the ListRecommendations operation because you already have the most current set of recommendations.
ListRecommendations
const mwsRequestData = {
Version: '2013-04-01',
Action: 'ListRecommendations',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'CategoryQueryList.CategoryQuery.1.FilterOptions.FilterOption.1': 'QualitySet=Defect',
'CategoryQueryList.CategoryQuery.1.FilterOptions.FilterOption.2': 'ListingStatus=Active',
'CategoryQueryList.CategoryQuery.1.RecommendationCategory': 'ListingQuality'
};
try {
const response = await amazonMws.recommendations.searchFor(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-04-01',
Action: 'ListRecommendations',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'CategoryQueryList.CategoryQuery.1.FilterOptions.FilterOption.1': 'QualitySet=Defect',
'CategoryQueryList.CategoryQuery.1.FilterOptions.FilterOption.2': 'ListingStatus=Active',
'CategoryQueryList.CategoryQuery.1.RecommendationCategory': 'ListingQuality'
};
amazonMws.recommendations.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-04-01',
Action: 'ListRecommendations',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'CategoryQueryList.CategoryQuery.1.FilterOptions.FilterOption.1': 'QualitySet=Defect',
'CategoryQueryList.CategoryQuery.1.FilterOptions.FilterOption.2': 'ListingStatus=Active',
'CategoryQueryList.CategoryQuery.1.RecommendationCategory': 'ListingQuality'
};
amazonMws.recommendations.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "d0305dfc-b83e-11e2-8aeb-c93b3EXAMPLE"
},
"Result": {},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns your active recommendations for a specific category or for all categories for a specific marketplace.
Description
The ListRecommendations operation returns the most recent recommendations for you in a given category or for all categories. To determine whether you need to check for new recommendations for a category, first call the GetLastUpdatedTimeForRecommendations operation. If the last updated timestamp returned for a category in the GetLastUpdatedTimeForRecommendations operation is newer than the previous time you called that operation, then you should call the ListRecommendations operation to get your latest recommendations. Otherwise, there is no need to call the ListRecommendations operation because you already have the most current set of recommendations.
ListRecommendationsByNextToken
const mwsRequestData = {
Version: '2013-04-01',
Action: 'ListRecommendationsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'Next_Token'
};
try {
const response = await amazonMws.recommendations.searchFor(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-04-01',
Action: 'ListRecommendationsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'Next_Token'
};
amazonMws.recommendations.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-04-01',
Action: 'ListRecommendationsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'Next_Token'
};
amazonMws.recommendations.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "b106b175-85ca-11e2-8826-c31d9EXAMPLE"
},
"Result": {
"NextToken": "AAAAAAAAEXAMPLE+13sB+=="
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the next page of recommendations using the NextToken parameter.
Description
The ListRecommendationsByNextToken operation returns the next page of recommendations using the NextToken value that was returned by your previous request to either ListRecommendations or ListRecommendationsByNextToken. If NextToken is not returned, there are no more pages to return.
GetServiceStatus
const mwsRequestData = {
Version: '2013-04-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
try {
const response = await amazonMws.recommendations.searchFor(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-04-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.recommendations.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-04-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.recommendations.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "082c41fd-2f6b-4616-a518-7db14EXAMPLE"
},
"Result": {
"Status": "GREEN",
"Timestamp": "2013-07-25T18:17:45.167Z"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the operational status of the Recommendations API section.
Description
The GetServiceStatus operation returns the operational status of the Recommendations API section of Amazon Marketplace Web Service (Amazon MWS). Status values are GREEN, YELLOW, and RED.
Reports
GetReport
const mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReport',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ReportId: 'REPORT_ID'
};
try {
const response = await amazonMws.reports.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReport',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ReportId: 'REPORT_ID'
};
amazonMws.reports.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReport',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ReportId: 'REPORT_ID'
};
amazonMws.reports.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
}
Returns the contents of a report and the Content-MD5 header for the returned report body.
Description
The GetReport operation returns the contents of a report and the Content-MD5 header for the returned report body. Reports are retained for 90 days from the time they are generated.
GetReportList
const mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportList',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
//'ReportTypeList.Type.1': 'REPORT_TYPE_LIST' //optional
};
try {
const response = await amazonMws.reports.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportList',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
//'ReportTypeList.Type.1': 'REPORT_TYPE_LIST' //optional
};
amazonMws.reports.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportList',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
//'ReportTypeList.Type.1': 'REPORT_TYPE_LIST' //optional
};
amazonMws.reports.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "fbf677c1-dcee-4110-bc88-2ba3702e331b"
},
"Result": {
"NextToken": "2YgYW55IPQhvu5hbCBwbGVhc3VyZS4=",
"HasNext": "true",
"ReportInfo": {
"ReportId": "898899473",
"ReportType": "_GET_MERCHANT_LISTINGS_DATA_",
"ReportRequestId": "2278662938",
"AvailableDate": "2009-02-10T09:22:33+00:00",
"Acknowledged": "false"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of reports that were created in the previous 90 days.
Description
The GetReportList operation returns a list of reports that were created in the previous 90 days that match the query parameters. A maximum of 100 results can be returned in one request. If there are additional results to return, HasNext is returned set to true in the response. To retrieve all the results, you can pass the value of the NextToken parameter to the GetReportListByNextToken operation iteratively until HasNext is returned set to false.
GetReportRequestList
const ReportRequestId = '10101010XXX';
const mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportRequestList',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'ReportRequestIdList.Id.1': ReportRequestId
};
try {
const response = await amazonMws.reports.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var ReportRequestId = '10101010XXX';
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportRequestList',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'ReportRequestIdList.Id.1': ReportRequestId
};
amazonMws.reports.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var ReportRequestId = '10101010XXX';
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportRequestList',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
'ReportRequestIdList.Id.1': ReportRequestId
};
amazonMws.reports.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "732480cb-84a8-4c15-9084-a46bd9a0889b"
},
"Result": {
"NextToken": "2YgYW55IPQhcm5hbCBwbGVhc3VyZS4=",
"HasNext": "true",
"ReportRequestInfo": {
"ReportRequestId": "2291326454",
"ReportType": "_GET_MERCHANT_LISTINGS_DATA_",
"StartDate": "2011-01-21T02:10:39+00:00",
"EndDate": "2011-02-13T02:10:39+00:00",
"Scheduled": "false",
"SubmittedDate": "2011-02-17T23:44:09+00:00",
"ReportProcessingStatus": "_DONE_",
"GeneratedReportId": "3538561173",
"StartedProcessingDate": "2011-02-17T23:44:43+00:00",
"CompletedDate": "2011-02-17T23:44:48+00:00"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of report requests that you can use to get the ReportRequestId for a report.
Description
The GetReportRequestList operation returns a list of report requests that match the query parameters. You can specify query parameters for report status, date range, and report type. The list contains the ReportRequestId for each report request. You can obtain ReportId values by passing the ReportRequestId values to the GetReportList operation. In the first request, a maximum of 100 report requests are returned. If there are additional report requests to return, HasNext is returned set to true in the response . To retrieve all the results, you can pass the value of the NextToken parameter to call GetReportRequestListByNextToken operation iteratively until HasNext is returned set to false.
RequestReport
const mwsRequestData = {
Version: '2009-01-01',
Action: 'RequestReport',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ReportType: '_GET_MERCHANT_LISTINGS_ALL_DATA_'
};
try {
const response = await amazonMws.reports.submit(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2009-01-01',
Action: 'RequestReport',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ReportType: '_GET_MERCHANT_LISTINGS_ALL_DATA_'
};
amazonMws.reports.submit(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2009-01-01',
Action: 'RequestReport',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
ReportType: '_GET_MERCHANT_LISTINGS_ALL_DATA_'
};
amazonMws.reports.submit(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "88faca76-b600-46d2-b53c-0c8c4533e43a"
},
"Result": {
"ReportRequestInfo": {
"ReportRequestId": "2291326454",
"ReportType": "_GET_MERCHANT_LISTINGS_DATA_",
"StartDate": "2009-01-21T02:10:39+00:00",
"EndDate": "2009-02-13T02:10:39+00:00",
"Scheduled": "false",
"SubmittedDate": "2009-02-20T02:10:39+00:00",
"ReportProcessingStatus": "_SUBMITTED_"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Creates a report request and submits the request to Amazon MWS.
Description
The RequestReport operation creates a report request. Amazon MWS processes the report request and when the report is completed, sets the status of the report request to DONE. Reports are retained for 90 days. You specify what marketplaces you want a report to cover by supplying a list of marketplace IDs to the optional MarketplaceIdList request parameter when you call the RequestReport operation. If you do not specify a marketplace ID, your home marketplace ID is used. Note that the MarketplaceIdList request parameter is not used in the Japan marketplace. The RequestReport operation has a maximum request quota of 15 and a restore rate of one request every minute.
GetReportRequestListByNextToken
const mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportRequestListByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
NextToken: 'NEXT_TOKEN'
};
try {
const response = await amazonMws.reports.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportRequestListByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
NextToken: 'NEXT_TOKEN'
};
amazonMws.reports.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportRequestListByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
NextToken: 'NEXT_TOKEN'
};
amazonMws.reports.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "732480cb-84a8-4c15-9084-a46bd9a0889b"
},
"Result": {
"NextToken": "none",
"HasNext": "false",
"ReportRequestInfo": {
"ReportRequestId": "2291326454",
"ReportType": "_GET_MERCHANT_LISTINGS_DATA_",
"StartDate": "2009-01-21T02:10:39+00:00",
"EndDate": "2009-02-13T02:10:39+00:00",
"Scheduled": "false",
"SubmittedDate": "2009-02-20T02:10:39+00:00",
"ReportProcessingStatus": "_SUBMITTED_"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of report requests using the NextToken, which was supplied by a previous request to either GetReportRequestListByNextToken or GetReportRequestList, where the value of HasNext was true in that previous request.
Description
The GetReportRequestListByNextToken operation returns a list of report requests that match the query parameters. This operation uses the NextToken, which was supplied by a previous request to either GetReportRequestListByNextToken or a request to GetReportRequestList, where the value of HasNext was true in that previous request.
GetReportRequestCount
const mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportRequestCount',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportProcessingStatusList.Status.1': 'REPORT_PROCESSING_STATUS_LIST',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1',
'ReportTypeList.Type.2': 'REPORT_TYPE_LIST_2'
};
try {
const response = await amazonMws.reports.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportRequestCount',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportProcessingStatusList.Status.1': 'REPORT_PROCESSING_STATUS_LIST',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1',
'ReportTypeList.Type.2': 'REPORT_TYPE_LIST_2'
};
amazonMws.reports.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportRequestCount',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportProcessingStatusList.Status.1': 'REPORT_PROCESSING_STATUS_LIST',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1',
'ReportTypeList.Type.2': 'REPORT_TYPE_LIST_2'
};
amazonMws.reports.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "7e155027-3741-4422-95a7-1de12703c13e"
},
"Result": {
"Count": "1276"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a count of report requests that have been submitted to Amazon MWS for processing.
Description
The GetReportRequestCount returns the total number of report requests that have been submitted to Amazon MWS for processing.
CancelReportRequests
const mwsRequestData = {
Version: '2009-01-01',
Action: 'CancelReportRequests',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportProcessingStatusList.Status.1': 'REPORT_PROCESSING_STATUS_LIST',
'ReportRequestIdList.Id.1': 'REPORT_REQUEST_ID_LIST',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1',
'ReportTypeList.Type.2': 'REPORT_TYPE_LIST_2'
};
try {
const response = await amazonMws.reports.submit(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2009-01-01',
Action: 'CancelReportRequests',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportProcessingStatusList.Status.1': 'REPORT_PROCESSING_STATUS_LIST',
'ReportRequestIdList.Id.1': 'REPORT_REQUEST_ID_LIST',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1',
'ReportTypeList.Type.2': 'REPORT_TYPE_LIST_2'
};
amazonMws.reports.submit(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2009-01-01',
Action: 'CancelReportRequests',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportProcessingStatusList.Status.1': 'REPORT_PROCESSING_STATUS_LIST',
'ReportRequestIdList.Id.1': 'REPORT_REQUEST_ID_LIST',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1',
'ReportTypeList.Type.2': 'REPORT_TYPE_LIST_2'
};
amazonMws.reports.submit(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "a720f9d6-83e9-4684-bc35-065b41ed5ca4"
},
"Result": {
"Count": "1",
"ReportRequestInfo": {
"ReportRequestId": "2291326454",
"ReportType": "_GET_MERCHANT_LISTINGS_DATA_",
"StartDate": "2009-01-21T02:10:39+00:00",
"EndDate": "2009-02-13T02:10:39+00:00",
"Scheduled": "false",
"SubmittedDate": "2009-02-20T02:10:39+00:00",
"ReportProcessingStatus": "_CANCELLED_"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Cancels one or more report requests.
Description
The CancelReportRequests operation cancels one or more report requests, returning the count of the canceled report requests and the report request information. You can cancel more than 100 report requests, but information is only returned for the first 100 report requests canceled. To return information on a greater number of canceled report requests, use the GetReportRequestList operation.
GetReportListByNextToken
const mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportListByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1',
NextToken: 'NEXT_TOKEN',
Acknowledged: 'false'
};
try {
const response = await amazonMws.reports.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportListByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1',
NextToken: 'NEXT_TOKEN',
Acknowledged: 'false'
};
amazonMws.reports.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportListByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1',
NextToken: 'NEXT_TOKEN',
Acknowledged: 'false'
};
amazonMws.reports.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "fbf677c1-dcee-4110-bc88-2ba3702e331b"
},
"Result": {
"NextToken": "none",
"HasNext": "false",
"ReportInfo": {
"ReportId": "898899473",
"ReportType": "_GET_MERCHANT_LISTINGS_DATA_",
"ReportRequestId": "2278662938",
"AvailableDate": "2009-02-10T09:22:33+00:00",
"Acknowledged": "false"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of reports using the NextToken, which was supplied by a previous request to either GetReportListByNextToken or GetReportList, where the value of HasNext was true in the previous call.
Description
The GetReportListByNextToken operation returns a list of reports that match the query parameters, using the NextToken, which was supplied by a previous call to either GetReportListByNextToken or a call to GetReportList, where the value of HasNext was true in the previous call.
GetReportCount
const mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportCount',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1'
};
try {
const response = await amazonMws.reports.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportCount',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1'
};
amazonMws.reports.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportCount',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1'
};
amazonMws.reports.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "a497aadb-5ea1-49bf-aa14-dabe914465e3"
},
"Result": {
"Count": "166"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a count of the reports, created in the previous 90 days, with a status of DONE and that are available for download.
Description
The GetReportCount operation returns a count of the reports, created in the previous 90 days, that are available for download.
ManageReportSchedule
const mwsRequestData = {
Version: '2009-01-01',
Action: 'ManageReportSchedule',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
ReportType: 'REPORT_TYPE',
Schedule: 'SCHEDULE'
};
try {
const response = await amazonMws.reports.submit(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2009-01-01',
Action: 'ManageReportSchedule',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
ReportType: 'REPORT_TYPE',
Schedule: 'SCHEDULE'
};
amazonMws.reports.submit(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2009-01-01',
Action: 'ManageReportSchedule',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
ReportType: 'REPORT_TYPE',
Schedule: 'SCHEDULE'
};
amazonMws.reports.submit(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "7ee1bc50-5a13-4db1-afd7-1386e481984e"
},
"Result": {
"Count": "1",
"ReportSchedule": {
"ReportType": "_GET_ORDERS_DATA_",
"Schedule": "_30_DAYS_",
"ScheduledDate": "2009-02-20T02:10:42+00:00"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Creates, updates, or deletes a report request schedule for a specified report type.
Description
The ManageReportSchedule operation creates, updates, or deletes a report request schedule for a particular report type. Only Order Reports can be scheduled. By using a combination of the ReportType and Schedule values, Amazon MWS determines which action you want to perform. If no combination of ReportType and Schedule exists, then a new report request schedule is created. If the ReportType is already scheduled but with a different Schedule value, then the report request schedule is updated to use the new Schedule value. If you pass in a ReportType and set the Schedule value to NEVER in the request, the report request schedule for that ReportType is deleted.
GetReportScheduleList
const mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportScheduleList',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1',
'ReportTypeList.Type.2': 'REPORT_TYPE_LIST_2'
};
try {
const response = await amazonMws.reports.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportScheduleList',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1',
'ReportTypeList.Type.2': 'REPORT_TYPE_LIST_2'
};
amazonMws.reports.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportScheduleList',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1',
'ReportTypeList.Type.2': 'REPORT_TYPE_LIST_2'
};
amazonMws.reports.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "c0464157-b74f-4e52-bd1a-4ebf4bc7e5aa"
},
"Result": {
"NextToken": {},
"HasNext": "false",
"ReportSchedule": {
"ReportType": "_GET_ORDERS_DATA_",
"Schedule": "_30_DAYS_",
"ScheduledDate": "2009-02-20T02:10:42+00:00"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of order report requests that are scheduled to be submitted to Amazon MWS for processing.
Description
The GetReportScheduleList operation returns a list of scheduled order report requests that match the query parameters. Only Order Reports can be scheduled. A maximum number of 100 results can be returned in one request.
GetReportScheduleListByNextToken
Currently this operation can never be called because the GetReportScheduleList operation cannot return more than 100 results. It is included for future compatibility.
GetReportScheduleCount
const mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportScheduleCount',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1'
};
try {
const response = await amazonMws.reports.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportScheduleCount',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1'
};
amazonMws.reports.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2009-01-01',
Action: 'GetReportScheduleCount',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportTypeList.Type.1': 'REPORT_TYPE_LIST_1'
};
amazonMws.reports.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "21e482a8-15c7-4da3-91a4-424995ed0756"
},
"Result": {
"Count": "18"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a count of order report requests that are scheduled to be submitted to Amazon MWS.
Description
The GetReportScheduleCount operation returns a count of report requests that are scheduled to be submitted to Amazon MWS. Only Order Reports can be scheduled.
UpdateReportAcknowledgements
const mwsRequestData = {
Version: '2009-01-01',
Action: 'UpdateReportAcknowledgements',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportIdList.Type.1': 'REPORT_ID_LIST_1',
'ReportIdList.Type.2': 'REPORT_ID_LIST_2',
Acknowledged: 'true'
};
try {
const response = await amazonMws.reports.submit(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2009-01-01',
Action: 'UpdateReportAcknowledgements',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportIdList.Type.1': 'REPORT_ID_LIST_1',
'ReportIdList.Type.2': 'REPORT_ID_LIST_2',
Acknowledged: 'true'
};
amazonMws.reports.submit(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2009-01-01',
Action: 'UpdateReportAcknowledgements',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
Marketplace: 'MARKET_PLACE',
'ReportIdList.Type.1': 'REPORT_ID_LIST_1',
'ReportIdList.Type.2': 'REPORT_ID_LIST_2',
Acknowledged: 'true'
};
amazonMws.reports.submit(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "42a578a7-ed92-486b-ac67-5de7464fcdfa"
},
"Result": {
"Count": "1",
"ReportInfo": {
"ReportId": "841997483",
"ReportType": "_GET_MERCHANT_LISTINGS_DATA_",
"ReportRequestId": "2234038326",
"AvailableDate": "2009-01-06T03:48:36+00:00",
"Acknowledged": "true",
"AcknowledgedDate": "2009-02-20T02:10:41+00:00"
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Updates the acknowledged status of one or more reports.
Description
The UpdateReportAcknowledgements operation is an optional request that updates the acknowledged status of one or more reports. Use this operation if you want Amazon MWS to remember the acknowledged status of your reports. To keep track of which reports you have already received, it is a good practice to acknowledge reports after you have received and stored them successfully. Then, when you submit a GetReportList request, you can specify to receive only reports that have not yet been acknowledged. To retrieve reports that have been lost, set the Acknowledged to false and then submit a GetReportList request. This action returns a list of all reports within the previous 90 days that match the query parameters.
Sellers
ListMarketplaceParticipations
const mwsRequestData = {
Version: '2011-07-01',
Action: 'ListMarketplaceParticipations',
SellerId: mwsAccount.SellerId,
MWSAuthToken: mwsAccount.MWSAuthToken
};
try {
const response = await amazonMws.sellers.search(mwsRequestData);
console.log('response', JSON.stringify(response, null, 2));
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2011-07-01',
Action: 'ListMarketplaceParticipations',
SellerId: mwsAccount.SellerId,
MWSAuthToken: mwsAccount.MWSAuthToken
};
amazonMws.sellers.search(mwsRequestData).then(function (response) {
console.log('response', JSON.stringify(response, null, 2));
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2011-07-01',
Action: 'ListMarketplaceParticipations',
SellerId: mwsAccount.SellerId,
MWSAuthToken: mwsAccount.MWSAuthToken
};
amazonMws.sellers.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', JSON.stringify(response, null, 2));
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "efeab958-74e2-45d4-9018-2323084413b5"
},
"Result": {
"NextToken": "MRgZW55IGNhcm5hbCBwbGVhc3VyZS6=",
"ListParticipations": {
"Participation": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerId": "A135KKEKJAIBJ56",
"HasSellerSuspendedListings": "No"
}
},
"ListMarketplaces": {
"Marketplace": {
"MarketplaceId": "ATVPDKIKX0DER",
"Name": "Amazon.com",
"DefaultCountryCode": "US",
"DefaultCurrencyCode": "USD",
"DefaultLanguageCode": "en_US",
"DomainName": "www.amazon.com"
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of marketplaces that the seller submitting the request can sell in, and a list of participations that include seller-specific information in that marketplace.
Description
The ListMarketplaceParticipations operation gets a list of marketplaces a seller can participate in and a list of participations that include seller-specific information in that marketplace. Note that the operation returns only those marketplaces where the seller's account is in an active state.
ListMarketplaceParticipationsByNextToken
const mwsRequestData = {
Version: '2011-07-01',
Action: 'ListMarketplaceParticipationsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'NEXT_TOKEN'
};
try {
const response = await amazonMws.sellers.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2011-07-01',
Action: 'ListMarketplaceParticipationsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'NEXT_TOKEN'
};
amazonMws.sellers.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2011-07-01',
Action: 'ListMarketplaceParticipationsByNextToken',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
NextToken: 'NEXT_TOKEN'
};
amazonMws.sellers.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "efeab958-74e2-45d4-9018-2323084413b5"
},
"Result": {
"NextToken": "MRgZW55IGNhcm5hbCBwbGVhc3VyZS6=",
"ListParticipations": {
"Participation": {
"MarketplaceId": "ATVPDKIKX0DER",
"SellerId": "A135KKEKWF1JAI6",
"HasSellerSuspendedListings": "No"
}
},
"ListMarketplaces": {
"Marketplace": {
"MarketplaceId": "ATVPDKIKX0DER",
"Name": "Amazon.com",
"DefaultCountryCode": "US",
"DefaultCurrencyCode": "USD",
"DefaultLanguageCode": "en_US",
"DomainName": "www.amazon.com"
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the next page of marketplaces and participations using the NextToken.
Description
The ListMarketplaceParticipationsByNextToken operation returns the next page of marketplaces and participations using the NextToken value that was returned by your previous request to either ListMarketplaceParticipations or ListMarketplaceParticipationsByNextToken. If NextToken is not returned, there are no more pages to return.
GetServiceStatus
const mwsRequestData = {
Version: '2011-07-01',
Action: 'GetServiceStatus',
SellerId: mwsAccount.SellerId,
MWSAuthToken: mwsAccount.MWSAuthToken
};
try {
const response = await amazonMws.sellers.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2011-07-01',
Action: 'GetServiceStatus',
SellerId: mwsAccount.SellerId,
MWSAuthToken: mwsAccount.MWSAuthToken
};
amazonMws.sellers.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2011-07-01',
Action: 'GetServiceStatus',
SellerId: mwsAccount.SellerId,
MWSAuthToken: mwsAccount.MWSAuthToken
};
amazonMws.sellers.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"Result": {
"Status": "GREEN",
"Timestamp": "2010-09-24T21:38:09.676Z"
},
"ResponseMetadata": {},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the operational status of the Sellers API section.
Description
The GetServiceStatus operation returns the operational status of the Sellers API section of Amazon Marketplace Web Service (Amazon MWS). Status values are GREEN, YELLOW, and RED.
ShipmentInvoicing
GetFBAOutboundShipmentDetail
const mwsRequestData = {
Version: '2018-09-01',
Action: 'GetFBAOutboundShipmentDetail',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
AmazonShipmentId: 'AMAZON_SHIPMENT_ID'
};
try {
const response = await amazonMws.shipmentInvoicing.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2018-09-01',
Action: 'GetFBAOutboundShipmentDetail',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
AmazonShipmentId: 'AMAZON_SHIPMENT_ID'
};
amazonMws.shipmentInvoicing.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2018-09-01',
Action: 'GetFBAOutboundShipmentDetail',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
AmazonShipmentId: 'AMAZON_SHIPMENT_ID'
};
amazonMws.shipmentInvoicing.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "88faca76-b600-46d2-b53c-0c8c4533e43a"
},
"Result": {
"ShipmentDetail": {
"PurchaseDate": "2018-04-16T14:44:38Z",
"WarehouseId": "XXXX",
"AmazonOrderId": "701-0000000-0000000",
"AmazonShipmentId": "DrLqQwqvb",
"BuyerTaxInfo": {
"TaxClassifications": {
"TaxClassification": {
"Value": ",99999999999",
"Name": "CPF"
}
}
},
"PaymentMethodDetails": {
"PaymentMethodDetail": "CreditCard"
},
"BuyerCounty": "Centro",
"BuyerName": "Fulano da Silva",
"MarketplaceId": "A2Q3Y263D00KWC",
"ShippingAddress": {
"City": "SAO PAULO",
"PostalCode": "00000-000",
"StateOrRegion": "SP",
"Phone": "11912345678",
"CountryCode": "BR",
"Name": "Beltrano da Silva",
"AddressLine1": "Rua da Consolação, 700",
"AddressLine2": "Apto 32"
},
"ShipmentItems": {
"ShipmentItem": {
"QuantityOrdered": "2",
"Title": "iPhone X Apple Cinza Espacial, 64 GB e Câmera 12 MP",
"PromotionDiscount": {
"CurrencyCode": "BRL",
"Amount": "0.00"
},
"ASIN": "B078HVJB69",
"SellerSKU": "XY-1A0O-B1CD",
"OrderItemId": "19441439621890",
"ShippingPrice": {
"CurrencyCode": "BRL",
"Amount": "30.00"
},
"GiftWrapPrice": {
"CurrencyCode": "BRL",
"Amount": "0.00"
},
"ItemPrice": {
"CurrencyCode": "BRL",
"Amount": "5099.99"
},
"ShippingDiscount": {
"CurrencyCode": "BRL",
"Amount": "0.00"
},
"SerialNumbers": {
"SerialNumber": [
"1234567890",
"1234567687"
]
}
}
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Description
The GetFBAOutboundShipmentDetail operation returns the information required to generate an invoice for the shipment of a Fulfillment by Amazon order.
SubmitFBAOutboundShipmentInvoice
const mwsRequestData = {
Version: '2018-09-01',
Action: 'SubmitFBAOutboundShipmentInvoice',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
AmazonShipmentId: 'AMAZON_SHIPMENT_ID'
};
try {
const response = await amazonMws.shipmentInvoicing.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2018-09-01',
Action: 'SubmitFBAOutboundShipmentInvoice',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
AmazonShipmentId: 'AMAZON_SHIPMENT_ID'
};
amazonMws.shipmentInvoicing.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2018-09-01',
Action: 'SubmitFBAOutboundShipmentInvoice',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
AmazonShipmentId: 'AMAZON_SHIPMENT_ID'
};
amazonMws.shipmentInvoicing.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "98bbbfc7-22fe-42cf-9ae7-7cfb1849b90f"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Description
The SubmitFBAOutboundShipmentInvoice operation submits shipment invoice data for a given shipment.
GetFBAOutboundShipmentInvoiceStatus
const mwsRequestData = {
Version: '2018-09-01',
Action: 'GetFBAOutboundShipmentInvoiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'AmazonShipmentId.Id.1': 'AMAZON_SHIPMENT_ID'
};
try {
const response = await amazonMws.shipmentInvoicing.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2018-09-01',
Action: 'GetFBAOutboundShipmentInvoiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'AmazonShipmentId.Id.1': 'AMAZON_SHIPMENT_ID'
};
amazonMws.shipmentInvoicing.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2018-09-01',
Action: 'GetFBAOutboundShipmentInvoiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'AmazonShipmentId.Id.1': 'AMAZON_SHIPMENT_ID'
};
amazonMws.shipmentInvoicing.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "98bbbfc7-22fe-42cf-9ae7-7cfb1849b90f"
},
"Result": {
"Shipments": {
"Shipment": {
"AmazonShipmentId": "DrLqQwqvb",
"InvoiceStatus": "Accepted"
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Description
The GetFBAOutboundShipmentInvoiceStatus operation gets the invoice processing status for the shipments that you specify.
GetServiceStatus
const mwsRequestData = {
Version: '2018-09-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
try {
const response = await amazonMws.shipmentInvoicing.search(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2018-09-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.shipmentInvoicing.search(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2018-09-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.shipmentInvoicing.search(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "d80c6c7b-f7c7-4fa7-bdd7-854711cb3bcc"
},
"Result": {
"Status": "GREEN",
"Timestamp": "2018-11-01421:38:09.676Z"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the operational status of the Shipment Invoicing API section.
Description
The GetServiceStatus operation returns the operational status of the Shipment Invoicing API section of Amazon Marketplace Web Service. Status values are GREEN, YELLOW, and RED.
Subscriptions
CreateSubscription
const mwsRequestData = {
Version: '2013-07-01',
Action: 'CreateSubscription',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Subscription.Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Subscription.Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Subscription.Destination.DeliveryChannel': 'DESTINATION_CHANNEL',
'Subscription.IsEnabled': 'true',
'Subscription.NotificationType': 'AnyOfferChanged'
};
try {
const response = await amazonMws.subscriptions.create(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-07-01',
Action: 'CreateSubscription',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Subscription.Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Subscription.Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Subscription.Destination.DeliveryChannel': 'DESTINATION_CHANNEL',
'Subscription.IsEnabled': 'true',
'Subscription.NotificationType': 'AnyOfferChanged'
};
amazonMws.subscriptions.create(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-07-01',
Action: 'CreateSubscription',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Subscription.Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Subscription.Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Subscription.Destination.DeliveryChannel': 'DESTINATION_CHANNEL',
'Subscription.IsEnabled': 'true',
'Subscription.NotificationType': 'AnyOfferChanged'
};
amazonMws.subscriptions.create(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "c9bb2e77-2425-4e1a-9c85-36d00EXAMPLE"
},
"Result": {},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Creates a new subscription for the specified notification type and destination.
Description
The CreateSubscription operation indicates that the specified notification type should be delivered to the specified Destination. Before you can subscribe, you must first register the Destination by calling the RegisterDestination operation.
DeleteSubscription
const mwsRequestData = {
Version: '2013-07-01',
Action: 'DeleteSubscription',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Destination.DeliveryChannel': 'DESTINATION_CHANNEL',
NotificationType: 'AnyOfferChanged'
};
try {
const response = await amazonMws.subscriptions.remove(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-07-01',
Action: 'DeleteSubscription',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Destination.DeliveryChannel': 'DESTINATION_CHANNEL',
NotificationType: 'AnyOfferChanged'
};
amazonMws.subscriptions.remove(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-07-01',
Action: 'DeleteSubscription',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Destination.DeliveryChannel': 'DESTINATION_CHANNEL',
NotificationType: 'AnyOfferChanged'
};
amazonMws.subscriptions.remove(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "2d7db8a1-8974-4541-9c9b-f882dEXAMPLE"
},
"Result": {},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Deletes the subscription for the specified notification type and destination.
Description
The DeleteSubscription operation deletes a subscription that you previously created by using the CreateSubscription operation. If you no longer want to receive a particular notification type at a Destination, call either the DeleteSubscription operation or the UpdateSubscription operation with the IsEnabled request parameter set to false. If you attempt to call this operation with a Subscription that you did not previously create, the service returns an error. If you attempt to delete a Subscription that you previously deleted, the service returns an error.
ListSubscriptions
const mwsRequestData = {
Version: '2013-07-01',
Action: 'ListSubscriptions',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID'
};
try {
const response = await amazonMws.subscriptions.searchFor(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-07-01',
Action: 'ListSubscriptions',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID'
};
amazonMws.subscriptions.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-07-01',
Action: 'ListSubscriptions',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID'
};
amazonMws.subscriptions.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "bf251d30-1409-4855-93cc-52943EXAMPLE"
},
"Result": {
"SubscriptionList": {
"member": {
"NotificationType": "AnyOfferChanged",
"IsEnabled": "true",
"Destination": {
"DeliveryChannel": "SQS",
"AttributeList": {
"member": {
"Value": ",https://sqs.us-east-1.amazonaws.com/51471EXAMPLE/mws_notifications",
"Key": "sqsQueueUrl"
}
}
}
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns a list of all your current subscriptions.
Description
The ListSubscriptions operation returns all the subscriptions that you have created by using the CreateSubscription operation.
RegisterDestination
const mwsRequestData = {
Version: '2013-07-01',
Action: 'RegisterDestination',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Destination.DeliveryChannel': 'DESTINATION_CHANNEL'
};
try {
const response = await amazonMws.subscriptions.create(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-07-01',
Action: 'RegisterDestination',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Destination.DeliveryChannel': 'DESTINATION_CHANNEL'
};
amazonMws.subscriptions.create(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-07-01',
Action: 'RegisterDestination',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Destination.DeliveryChannel': 'DESTINATION_CHANNEL'
};
amazonMws.subscriptions.create(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "b120e610-9cf0-48d7-b615-ca869EXAMPLE"
},
"Result": {},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Specifies a new destination where you want to receive notifications.
Description
The RegisterDestination operation specifies a location where you want to receive notifications and adds it to the list of registered destinations. After you register a Destination, you must create a Subscription by calling the CreateSubscription operation to begin receiving notifications.
DeregisterDestination
const mwsRequestData = {
Version: '2013-07-01',
Action: 'DeregisterDestination',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Destination.DeliveryChannel': 'DESTINATION_CHANNEL'
};
try {
const response = await amazonMws.subscriptions.remove(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-07-01',
Action: 'DeregisterDestination',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Destination.DeliveryChannel': 'DESTINATION_CHANNEL'
};
amazonMws.subscriptions.remove(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-07-01',
Action: 'DeregisterDestination',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Destination.DeliveryChannel': 'DESTINATION_CHANNEL'
};
amazonMws.subscriptions.remove(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"RegisterDestinationResponse": {
"RegisterDestinationResult": {},
"ResponseMetadata": {
"RequestId": "b120e610-9cf0-48d7-b615-ca869EXAMPLE"
}
},
"ResponseMetadata": {},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Removes an existing destination from the list of registered destinations.
Description
The DeregisterDestination operation specifies a location where you no longer want to receive notifications. Before you can call this operation, you must first delete the Subscription that is being delivered to the Destination by calling the DeleteSubscription operation. If you attempt to call this operation with a Destination that you did not previously register, the service returns an error. After calling this operation, you will have to call the RegisterDestination operation if you want to receive notifications at the Destination again.
ListRegisteredDestinations
const mwsRequestData = {
Version: '2013-07-01',
Action: 'ListRegisteredDestinations',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID'
};
try {
const response = await amazonMws.subscriptions.searchFor(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-07-01',
Action: 'ListRegisteredDestinations',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID'
};
amazonMws.subscriptions.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-07-01',
Action: 'ListRegisteredDestinations',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID'
};
amazonMws.subscriptions.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "8329b2a1-4249-43fa-b2d3-da563EXAMPLE"
},
"Result": {
"DestinationList": {
"member": {
"DeliveryChannel": "SQS",
"AttributeList": {
"member": {
"Value": ",https://sqs.us-east-1.amazonaws.com/51471EXAMPLE/mws_notifications",
"Key": "sqsQueueUrl"
}
}
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Lists all current destinations that you have registered.
Description
The ListRegisteredDestinations operation lists all the Destination objects that you have registered to receive notifications by calling the RegisterDestination operation.
SendTestNotificationToDestination
const mwsRequestData = {
Version: '2013-07-01',
Action: 'SendTestNotificationToDestination',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Destination.DeliveryChannel': 'DESTINATION_CHANNEL'
};
try {
const response = await amazonMws.subscriptions.create(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-07-01',
Action: 'SendTestNotificationToDestination',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Destination.DeliveryChannel': 'DESTINATION_CHANNEL'
};
amazonMws.subscriptions.create(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-07-01',
Action: 'SendTestNotificationToDestination',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Destination.DeliveryChannel': 'DESTINATION_CHANNEL'
};
amazonMws.subscriptions.create(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "f662dae6-bde0-4e75-a53b-741abEXAMPLE"
},
"Result": {},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Sends a test notification to an existing destination.
Description
The SendTestNotificationToDestination operation sends a test notification to the Destination that you specify. After you register a Destination, Amazon recommends that you call this operation to verify that you can receive notifications. You can also call this operation if you have not received any notifications at a Destination for a while.
GetSubscription
const mwsRequestData = {
Version: '2013-07-01',
Action: 'GetSubscription',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Destination.DeliveryChannel': 'DESTINATION_CHANNEL',
NotificationType: 'NOTIFICATION_TYPE'
};
try {
const response = await amazonMws.subscriptions.searchFor(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-07-01',
Action: 'GetSubscription',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Destination.DeliveryChannel': 'DESTINATION_CHANNEL',
NotificationType: 'NOTIFICATION_TYPE'
};
amazonMws.subscriptions.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-07-01',
Action: 'GetSubscription',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Destination.DeliveryChannel': 'DESTINATION_CHANNEL',
NotificationType: 'NOTIFICATION_TYPE'
};
amazonMws.subscriptions.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "4012b1ae-3f31-4627-83c3-1757aEXAMPLE"
},
"Result": {
"Subscription": {
"NotificationType": "AnyOfferChanged",
"IsEnabled": "true",
"Destination": {
"DeliveryChannel": "SQS",
"AttributeList": {
"member": {
"Value": ",https://sqs.us-east-1.amazonaws.com/51471EXAMPLE/mws_notifications",
"Key": "sqsQueueUrl"
}
}
}
}
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Gets the subscription for the specified notification type and destination.
Description
The GetSubscription operation returns the Subscription object for the given NotificationType and Destination.
UpdateSubscription
const mwsRequestData = {
Version: '2013-07-01',
Action: 'UpdateSubscription',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Subscription.Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Subscription.Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Subscription.Destination.DeliveryChannel': 'DESTINATION_CHANNEL',
'Subscription.IsEnabled': 'true',
'Subscription.NotificationType': 'AnyOfferChanged'
};
try {
const response = await amazonMws.subscriptions.create(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-07-01',
Action: 'UpdateSubscription',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Subscription.Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Subscription.Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Subscription.Destination.DeliveryChannel': 'DESTINATION_CHANNEL',
'Subscription.IsEnabled': 'true',
'Subscription.NotificationType': 'AnyOfferChanged'
};
amazonMws.subscriptions.create(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-07-01',
Action: 'UpdateSubscription',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN',
MarketplaceId: 'MARKET_PLACE_ID',
'Subscription.Destination.AttributeList.member.1.Key': 'DESTINATION_KEY',
'Subscription.Destination.AttributeList.member.1.Value': 'DESTINATION_VALUE',
'Subscription.Destination.DeliveryChannel': 'DESTINATION_CHANNEL',
'Subscription.IsEnabled': 'true',
'Subscription.NotificationType': 'AnyOfferChanged'
};
amazonMws.subscriptions.create(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "3263ad38-d15b-4043-b48c-cbfa2EXAMPLE"
},
"Result": {},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Updates the subscription for the specified notification type and destination.
Description
The UpdateSubscription operation changes the properties of a Subscription that you previously created. If you no longer want to receive a particular notification type at a Destination, call either the DeleteSubscription operation or the UpdateSubscription operation with the IsEnabled request parameter set to false.
GetServiceStatus
const mwsRequestData = {
Version: '2013-07-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
try {
const response = await amazonMws.subscriptions.searchFor(mwsRequestData);
console.log('response', response);
} catch (error) {
console.log('error ', error);
}
var mwsRequestData = {
Version: '2013-07-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.subscriptions.searchFor(mwsRequestData).then(function (response) {
console.log('response', response);
}).catch(function (error) {
console.log('error ', error);
});
var mwsRequestData = {
Version: '2013-07-01',
Action: 'GetServiceStatus',
SellerId: 'SELLER_ID',
MWSAuthToken: 'MWS_AUTH_TOKEN'
};
amazonMws.subscriptions.searchFor(mwsRequestData, function (error, response) {
if (error) {
console.log('error ', error);
return;
}
console.log('response', response);
});
The above command returns JSON structured like this:
{
"ResponseMetadata": {
"RequestId": "082c41fd-2f6b-4616-a518-7db14EXAMPLE"
},
"Result": {
"Status": "GREEN",
"Timestamp": "2013-07-25T18:17:45.167Z"
},
"Headers": {
"x-mws-quota-max": "",
"x-mws-quota-remaining": "",
"x-mws-quota-resetson": "",
"x-mws-timestamp": "2018-09-05T06:13:00.276Z",
"content-type": "text/xml",
"content-charset": "",
"content-length": "",
"content-md5": "",
"date": ""
},
"StatusCode": 200
}
Returns the operational status of the Subscriptions API section.
Description
The GetServiceStatus operation returns the operational status of the Subscriptions API section of Amazon Marketplace Web Service (Amazon MWS). Status values are GREEN, YELLOW, and RED.