Skip to content

Commit e531635

Browse files
author
Bhushankumar L
authored
Merge pull request #76 from bhushankumarl/development
correct example for GetMyFeesEstimate API call
2 parents a789626 + b64094f commit e531635

File tree

10 files changed

+169
-42
lines changed

10 files changed

+169
-42
lines changed

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
0.0.24
2+
- Add Subscription in Typescript definition
3+
- Correct Documentation
4+
- Allow user to change response type into XML format
5+
- Allow user to change content type for request
6+
17
0.0.23
28
- Bug Fix for Feed Result charset
39

‎README.md‎

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -559,7 +559,7 @@ Originally by [Bhushankumar L](mailto:bhushankumar.lilapara@gmail.com).
559559

560560
#### Get My Fees Estimate
561561
```
562-
amazonMws.products.searchFor({
562+
amazonMws.products.search({
563563
'Version': '2011-10-01',
564564
'Action': 'GetMyFeesEstimate',
565565
'SellerId': 'SELLER_ID',
@@ -790,6 +790,44 @@ Originally by [Bhushankumar L](mailto:bhushankumar.lilapara@gmail.com).
790790
});
791791
```
792792

793+
#### Request Report Content Type
794+
```
795+
amazonMws.setContentType('application/json');
796+
797+
amazonMws.reports.submit({
798+
'Version': '2009-01-01',
799+
'Action': 'RequestReport',
800+
'SellerId': 'SELLER_ID',
801+
'MWSAuthToken': 'MWS_AUTH_TOKEN',
802+
'ReportType': '_GET_MERCHANT_LISTINGS_ALL_DATA_'
803+
}, function (error, response) {
804+
if (error) {
805+
console.log('error ', error);
806+
return;
807+
}
808+
console.log('response', response);
809+
});
810+
```
811+
812+
#### Request Report XML Response
813+
```
814+
amazonMws.setResponseFormat('XML');
815+
816+
amazonMws.reports.submit({
817+
'Version': '2009-01-01',
818+
'Action': 'RequestReport',
819+
'SellerId': 'SELLER_ID',
820+
'MWSAuthToken': 'MWS_AUTH_TOKEN',
821+
'ReportType': '_GET_MERCHANT_LISTINGS_ALL_DATA_'
822+
}, function (error, response) {
823+
if (error) {
824+
console.log('error ', error);
825+
return;
826+
}
827+
console.log('response', response);
828+
});
829+
```
830+
793831
### Sellers
794832
#### List Marketplace Participations
795833
```

‎examples/javaScript/products/getMyFeesEstimate.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ var accessSecret = process.env.AWS_SECRET_ACCESS_KEY || 'YOUR_SECRET';
66
var amazonMws = require('../../../lib/amazon-mws')(accessKey, accessSecret);
77

88
var productRequest = function () {
9-
amazonMws.products.searchFor({
9+
amazonMws.products.search({
1010
'Version': '2011-10-01',
1111
'Action': 'GetMyFeesEstimate',
1212
'SellerId': 'SELLER_ID',

‎examples/javaScript/sample/requestReportContentType.js‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
'use strict';
2+
3+
var accessKey = process.env.AWS_ACCESS_KEY_ID || 'YOUR_KEY';
4+
var accessSecret = process.env.AWS_SECRET_ACCESS_KEY || 'YOUR_SECRET';
5+
6+
var amazonMws = require('../../../lib/amazon-mws')(accessKey, accessSecret);
7+
8+
/**
9+
* This example has been written to override/set the contentType of the request.
10+
*/
11+
12+
var reportRequest = function () {
13+
amazonMws.setContentType('application/json');
14+
15+
amazonMws.reports.submit({
16+
'Version': '2009-01-01',
17+
'Action': 'RequestReport',
18+
'SellerId': 'SELLER_ID',
19+
'MWSAuthToken': 'MWS_AUTH_TOKEN',
20+
'ReportType': '_GET_MERCHANT_LISTINGS_ALL_DATA_'
21+
}, function (error, response) {
22+
if (error) {
23+
console.log('error ', error);
24+
return;
25+
}
26+
console.log('response', response);
27+
});
28+
};
29+
30+
reportRequest();

‎examples/javaScript/sample/requestReportXMLResponse.js‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
'use strict';
2+
3+
var accessKey = process.env.AWS_ACCESS_KEY_ID || 'YOUR_KEY';
4+
var accessSecret = process.env.AWS_SECRET_ACCESS_KEY || 'YOUR_SECRET';
5+
6+
var amazonMws = require('../../../lib/amazon-mws')(accessKey, accessSecret);
7+
8+
/**
9+
* This example has been written to override/set the default RESPONSE type to XML.
10+
*/
11+
12+
var reportRequest = function () {
13+
amazonMws.setResponseFormat('XML');
14+
15+
amazonMws.reports.submit({
16+
'Version': '2009-01-01',
17+
'Action': 'RequestReport',
18+
'SellerId': 'SELLER_ID',
19+
'MWSAuthToken': 'MWS_AUTH_TOKEN',
20+
'ReportType': '_GET_MERCHANT_LISTINGS_ALL_DATA_'
21+
}, function (error, response) {
22+
if (error) {
23+
console.log('error ', error);
24+
return;
25+
}
26+
console.log('response', response);
27+
});
28+
};
29+
30+
reportRequest();

‎index.d.ts‎

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@ declare class Sellers extends BaseAmazonMWS {
6464

6565
declare class Subscriptions extends BaseAmazonMWS {
6666

67+
create(params: any): Promise<any>;
68+
6769
searchFor(params: any): Promise<any>;
6870

6971
remove(params: any): Promise<any>;
@@ -72,33 +74,29 @@ declare class Subscriptions extends BaseAmazonMWS {
7274

7375
declare class AmazonMWS {
7476

75-
constructor()
76-
77-
constructor(key: string, token: string);
78-
79-
setApiKey(key: string, secret: string): void;
80-
81-
setHost(host?: string, port?: string, protocol?: string): void;
82-
8377
feeds: Feeds;
84-
8578
finances: Finances;
86-
8779
fulfillmentInboundShipment: FulfillmentInboundShipment;
88-
8980
fulfillmentInventory: FulfillmentInventory;
90-
9181
fulfillmentOutboundShipment: FulfillmentOutboundShipment;
92-
9382
merchantFulfillment: MerchantFulfillment;
94-
9583
orders: Orders;
96-
9784
products: Products;
98-
9985
reports: Reports;
100-
10186
sellers: Sellers;
87+
subscriptions: Subscriptions;
88+
89+
constructor()
90+
91+
constructor(key: string, token: string);
92+
93+
setApiKey(key: string, secret: string): void;
94+
95+
setHost(host?: string, port?: string, protocol?: string): void;
96+
97+
setResponseFormat(responseFormat: string): void;
98+
99+
setContentType(setContentType: string): void;
102100

103101
}
104102

‎lib/AmazonMwsResource.js‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,10 @@ AmazonMwsResource.prototype = {
292292
debug('responseString ', responseString);
293293
debug('contentType ', contentType);
294294
debug('statusCode ', statusCode);
295+
if (userOptions.responseType === 'XML') {
296+
debug('Inside user response as XML option');
297+
return callback.call(self, null, responseString);
298+
}
295299

296300
try {
297301
var errorResponse = {};
@@ -390,7 +394,10 @@ AmazonMwsResource.prototype = {
390394

391395
var userRaw = '';
392396
var userCharset = '';
393-
/**custom option passed by user, a better way to do this would be nice */
397+
var responseType = '';
398+
/**
399+
* Custom option passed by user, a better way to do this would be nice
400+
*/
394401
if (data.__RAW__) {
395402
userRaw = data.__RAW__;
396403
delete data.__RAW__;
@@ -399,6 +406,9 @@ AmazonMwsResource.prototype = {
399406
userCharset = data.__CHARSET__;
400407
delete data.__CHARSET__;
401408
}
409+
if (self._AmazonMws.getApiField('format') !== 'JSON') {
410+
responseType = self._AmazonMws.getApiField('format');
411+
}
402412
self.requestParams = data;
403413

404414
if (!self.requestParams.Version) {
@@ -472,6 +482,10 @@ AmazonMwsResource.prototype = {
472482
self.body = self.requestParams;
473483
}
474484

485+
if (self._AmazonMws.getApiField('contentType')) {
486+
headers['Content-Type'] = self._AmazonMws.getApiField('contentType');
487+
}
488+
475489
// Make a deep copy of the request params, assign to block scoped variable
476490
var requestParamsCopy = JSON.parse(JSON.stringify(self.requestParams));
477491
var requestParamsJSONCopy = JSON.parse(JSON.stringify(self.requestParamsJSON));
@@ -506,7 +520,8 @@ AmazonMwsResource.prototype = {
506520
req.setTimeout(timeout, self._timeoutHandler(timeout, req, callback));
507521
var userOptions = {
508522
userCharset: userCharset,
509-
userRaw: userRaw
523+
userRaw: userRaw,
524+
responseType: responseType
510525
};
511526
req.on('response', self._responseHandler(requestParamsJSONCopy, req, userOptions, callback));
512527
req.on('error', self._errorHandler(req, callback));

‎lib/amazon-mws.js‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
AmazonMws.DEFAULT_HOST = 'mws.amazonservices.com';
55
AmazonMws.DEFAULT_PORT = '443';
66
AmazonMws.DEFAULT_BASE_PATH = '/';
7-
AmazonMws.DEFAULT_RESPONSE_FORMAT = '.json';
7+
AmazonMws.DEFAULT_RESPONSE_FORMAT = 'JSON';
88
AmazonMws.DEFAULT_API_VERSION = null;
99

1010
// Use node's default timeout:
@@ -72,7 +72,7 @@ function AmazonMws(accessKey, accessSecret, version) {
7272
this._prepResources();
7373
this.setApiKey(accessKey, accessSecret);
7474
this.setApiVersion(version);
75-
this.setResponseFormat(AmazonMws.DEFAULT_RESPONSE_FORMAT);
75+
// this.setResponseFormat(AmazonMws.DEFAULT_RESPONSE_FORMAT);
7676
}
7777

7878
AmazonMws.prototype = {
@@ -99,6 +99,10 @@ AmazonMws.prototype = {
9999
this._setApiField('format', format);
100100
},
101101

102+
setContentType: function (contentType) {
103+
this._setApiField('contentType', contentType);
104+
},
105+
102106
setApiVersion: function (version) {
103107
if (version) {
104108
this._setApiField('version', version);

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "amazon-mws",
3-
"version": "0.0.23",
3+
"version": "0.0.24",
44
"description": "Amazon MWS API wrapper",
55
"keywords": [
66
"Amazon MWS",

‎test/specs/products.spec.js‎

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -85,19 +85,23 @@ describe('Products', function () {
8585
expect(options.MarketplaceId).to.be.a('string');
8686
expect(options['ASINList.ASIN.1']).to.be.a('string');
8787

88-
var response = await amazonMws.products.searchFor(options);
89-
90-
expect(response).to.be.a('object');
91-
expect(response).to.have.property('ASIN').to.be.a('string');
92-
expect(response).to.have.property('status').to.be.a('string');
93-
expect(response).to.have.property('Product').to.be.a('object');
94-
expect(response).to.have.property('ResponseMetadata').to.be.a('object');
95-
expect(response).to.have.property('ResponseMetadata').to.have.property('RequestId');
96-
expect(response).to.have.property('Headers').to.be.a('object');
97-
expect(response).to.have.property('Headers').to.have.property('x-mws-quota-max');
98-
expect(response).to.have.property('Headers').to.have.property('x-mws-quota-remaining');
99-
expect(response).to.have.property('Headers').to.have.property('x-mws-quota-resetson');
100-
expect(response).to.have.property('Headers').to.have.property('x-mws-timestamp');
88+
try {
89+
var response = await amazonMws.products.searchFor(options);
90+
expect(response).to.be.a('object');
91+
expect(response).to.have.property('ASIN').to.be.a('string');
92+
expect(response).to.have.property('status').to.be.a('string');
93+
expect(response).to.have.property('Product').to.be.a('object');
94+
expect(response).to.have.property('ResponseMetadata').to.be.a('object');
95+
expect(response).to.have.property('ResponseMetadata').to.have.property('RequestId');
96+
expect(response).to.have.property('Headers').to.be.a('object');
97+
expect(response).to.have.property('Headers').to.have.property('x-mws-quota-max');
98+
expect(response).to.have.property('Headers').to.have.property('x-mws-quota-remaining');
99+
expect(response).to.have.property('Headers').to.have.property('x-mws-quota-resetson');
100+
expect(response).to.have.property('Headers').to.have.property('x-mws-timestamp');
101+
} catch (error) {
102+
console.log('error ', error);
103+
expect(error).to.be.undefined;
104+
}
101105
});
102106

103107
it('It should NOT get my price for INVALID ASIN using GetMyPriceForASIN Action', async function () {
@@ -131,7 +135,7 @@ describe('Products', function () {
131135
expect(error).to.be.a('object');
132136
expect(error).to.have.property('Type').to.be.a('string');
133137
expect(error).to.have.property('Message').to.be.a('string');
134-
expect(error).to.have.property('Detail').to.be.a('object');
138+
// expect(error).to.have.property('Detail').to.be.a('object');
135139
expect(error).to.have.property('StatusCode').to.be.a('number');
136140
expect(error).to.have.property('RequestId').to.be.a('string');
137141
expect(error).to.have.property('Headers').to.be.a('object');
@@ -165,10 +169,12 @@ describe('Products', function () {
165169
expect(response).to.have.property('status').to.be.a('string');
166170
expect(response).to.have.property('Product').to.be.a('object');
167171
expect(response).to.have.property('Product').to.have.property('CompetitivePricing');
168-
expect(response).to.have.property('Product').to.have.property('CompetitivePricing').to.have.property('NumberOfOfferListings');
169-
expect(response).to.have.property('Product').to.have.property('CompetitivePricing').to.have.property('NumberOfOfferListings').to.have.property('OfferListingCount').to.be.a('array');
170-
expect(response.Product.CompetitivePricing.NumberOfOfferListings.OfferListingCount[0]).to.have.property('condition');
171-
expect(response.Product.CompetitivePricing.NumberOfOfferListings.OfferListingCount[0]).to.have.property('Value');
172+
if (response.Product.CompetitivePricing.NumberOfOfferListings.OfferListingCount) {
173+
expect(response).to.have.property('Product').to.have.property('CompetitivePricing').to.have.property('NumberOfOfferListings');
174+
expect(response).to.have.property('Product').to.have.property('CompetitivePricing').to.have.property('NumberOfOfferListings').to.have.property('OfferListingCount').to.be.a('array');
175+
expect(response.Product.CompetitivePricing.NumberOfOfferListings.OfferListingCount[0]).to.have.property('condition');
176+
expect(response.Product.CompetitivePricing.NumberOfOfferListings.OfferListingCount[0]).to.have.property('Value');
177+
}
172178
expect(response).to.have.property('ResponseMetadata').to.be.a('object');
173179
expect(response).to.have.property('ResponseMetadata').to.have.property('RequestId');
174180
expect(response).to.have.property('Headers').to.be.a('object');

0 commit comments

Comments
 (0)