Modern, full featured nodejs Amazon MWS API in ~150 lines of code
npm install @ericblade/mws-simple javascript
let mws = require('mws-simple')({
accessKeyId: YOUR ACCESS KEY,
secretAccessKey: YOUR ACCESS KEY,
merchantId: YOUR MERCHANT ID
});
`
$3
Of the required parameters, AWSAccessKeyId, SellerId, Signature, SignatureMethod, SignatureVersion, and Timestamp will be taken care of but most can be overridden. This leaves Action, MWSAuthToken (for web applications and third-party developer authorizations only), and Version required to be populated.
Add the query parameters to query as needed for your specific Action.
If the API has an endpoint as specified in the documentation, put the endpoint in path.
For uploading data to MWS, populate feedContent with a buffer of data.
#### Invoke request with your request object
##### [Callback]
``
mws.request(requestObj, function (err, {res, headers}) {
....
});
``
##### [Promise]
``
mws.request(requestObj)
.then(({result, headers}) => {
....
})
.catch(error => {
....
});
``
##### Check your error, response, and headers
Note that there are two arguments that should be used for the callback:
- err: any error information returned
- result object:
- res: the response information
- headers: any headers returned from the call
If you receive an error, you will not likely receive anything other than undefined or null for res.
Most requests should supply headers. Headers that a developer may be particularly interested in are
for throttling information -- per the MWS API throttling documentation,
https://docs.developer.amazonservices.com/en_UK/dev_guide/DG_Throttling.html
for functions that have Hourly Request Quotas (Products, Reports, Feeds), you will receive throttle
information in the headers: x-mws-quota-max, x-mws-quota-remaining, x-mws-quota-resetsOn
(note that it seems that either the documentation is wrong, or some layer inbetween is changing
the names to all lower-case, so x-mws-quota-resetsOn is actually x-mws-quota-resetson)
Examples
$3
` javascript
let date = new Date();
date.setDate(date.getDate() - 1);
// create object with path and query
let listOrders = {
path: '/Orders/2013-09-01',
query: {
Action: 'ListOrders',
CreatedAfter: date.toISOString(),
'MarketplaceId.Id.1': 'ATVPDKIKX0DER',
'OrderStatus.Status.1': 'Unshipped',
'OrderStatus.Status.2': 'PartiallyShipped',
Version: '2013-09-01'
}
}
// Callback:
mws.request(listOrders, function(e, {result, headers}) {
console.log(JSON.stringify(headers));
console.log(JSON.stringify(result));
});
// Promise:
mws.request(listOrders)
.then(({result, headers}) => {
console.log(JSON.stringify(headers));
console.log(JSON.stringify(result));
});
`
$3
` javascript
let submitFeed = {
feedContent: require('fs').readFileSync('amazon-shipments.tab'),
path: '/Feeds/2009-01-01',
query: {
Action: 'SubmitFeed',
Version: '2009-01-01',
'MarketplaceIdList.Id.1': 'ATVPDKIKX0DER',
FeedType: '_POST_FLAT_FILE_FULFILLMENT_DATA_'
}
};
// Callback
mws.request(submitFeed, function(e, {result, headers}) {
});
// Promise
mws.request(submitFeed)
.then(({result, headers}) => {
...
});
`
$3
` javascript
const query = {
path: '/Test/TestErrorCall',
query: {
Action: 'TestForError',
Version: '2018-02-14',
},
};
// Callback
mws.request(query, (err, {result, headers}) => {
if (err instanceOf(mws.ServerError)) {
console.warn('** Server Error', err.message, err.code, err.body);
} else if (err) {
console.warn('** Other Error', err);
} else {
console.log('* Result', result);
}
});
// Promise
mws.request(query)
.catch(err => {
if (err instanceof mws.ServerError) {
console.warn('** Server Error', err.message, err.code, err.body);
} else if (err) {
console.warn('** Other Error', err);
} else {
console.log('* Result', result);
}
});
`
Contributing
Yes, please! ;-)
$3
There is a small set of mocha tests in test/test.js. Any changes that you make, please run the
tests to ensure that everything still works. As the tests actually hit the Amazon MWS servers, you
need to supply your authorization credentials to the tests. You can place them in test/keys.json,
like
``javascript
{
"accessKeyId": "AKIA....",
"secretAccessKey": "POF...",
"merchantId": "A3..."
}
``
then run ``npm test``` to run the tests.