adding extra params to findItemsByKeyword

Author: pajaydev

demo/findingApi.js

@@ -11,15 +11,22 @@ ebay.findItemsByCategory(10181).then((data) => {
     console.log(error);
 });
 
-ebay.findItemsByKeywords('iphone').then((data) => {
+// refer here for filtering the items 
+// https://developer.ebay.com/devzone/finding/callref/finditemsbykeywords.html#control
+ebay.findItemsByKeywords({
+    keywords: 'iphone',
+    sortOrder: 'PricePlusShippingLowest', //https://developer.ebay.com/devzone/finding/callref/extra/fndcmpltditms.rqst.srtordr.html
+    Condition: 3000,
+    SoldItemsOnly: false
+}).then((data) => {
     console.log(data);
 }, (error) => {
     console.log(error);
 });
 
 //https://developer.ebay.com/devzone/finding/callref/findCompletedItems.html
-/* This call searches for items whose listings are completed and are no longer available for 
-sale by category (using categoryId), by keywords (using keywords), or a combination of the two. 
+/* This call searches for items whose listings are completed and are no longer available for
+sale by category (using categoryId), by keywords (using keywords), or a combination of the two.
 Keyword queries search the title and subtitle of the item; they do not search descriptions. */
 
 ebay.findCompletedItems({

demo/searchApi.js

@@ -13,7 +13,7 @@ let ebay = new Ebay({
 });
 
 
-// //Search for Items by Keyword.
+// // //Search for Items by Keyword.
 ebay.getAccessToken()
     .then((data) => {
         ebay.searchItems({
@@ -63,7 +63,8 @@ ebay.getAccessToken()
         ebay.searchItems({
             keyword: 'drone',
             limit: 3,
-            filter: { maxDeliveryCost: 0 }
+            filter: { maxDeliveryCost: 0 },
+            aspect_filter: { categoryId: 179697, conditionDistributions: '{NEW}' } // docs to provide aspect_filter https://developer.ebay.com/api-docs/buy/browse/resources/item_summary/methods/search#h2-input
         }).then((data) => {
             console.log(data);
             // Data is in format of JSON

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ebay-node-api",
-  "version": "2.7.2",
+  "version": "2.7.4",
   "description": "Ebay node api client",
   "main": "./src/index.js",
   "homepage": "https://github.com/pajaydev/ebay-node-api",
@@ -40,4 +40,4 @@
     "nock": "^9.2.3",
     "sinon": "^4.4.5"
   }
-}
+}

src/buy-api.js

@@ -60,7 +60,7 @@ const searchItems = function (searchConfig) {
     queryParam = queryParam + (searchConfig.sort ? '&sort=' + searchConfig.sort : '');
     if (searchConfig.fieldgroups !== undefined) queryParam = queryParam + '&fieldgroups=' + searchConfig.fieldgroups;
     if (searchConfig.filter !== undefined) queryParam = queryParam + '&filter=' + encodeURLQuery(makeString(searchConfig.filter, { quotes: 'no', braces: 'false' }));
-    queryParam = queryParam + (searchConfig.aspect_filter ? '&aspect_filter='+ encodeURLQuery(makeString(searchConfig.aspect_filter, { quotes: 'no', braces: 'false' })) : '');
+    queryParam = queryParam + (searchConfig.aspect_filter ? '&aspect_filter=' + encodeURLQuery(makeString(searchConfig.aspect_filter, { quotes: 'no', braces: 'false' })) : '');
     this.options.contentType = 'application/json';
     return new Promise((resolve, reject) => {
         makeRequest(this.options, `/buy/browse/v1/item_summary/search?${(queryParam)}`, 'GET', auth).then((result) => {

src/findingApi.js

@@ -5,21 +5,15 @@ const { getRequest } = require('./request');
 
 const findItemsByKeywords = function (options) {
     if (!options) {
-        throw new Error('Keyword is missing, Keyword is required');
+        throw new Error('INVALID_REQUEST_PARMS --> Keyword is missing, Keyword is required');
     }
     this.options.operationName = 'findItemsByKeywords';
     this.options.param = 'keywords';
     // support only keyword string.
     if (!options.keywords) {
         this.options.name = options;
     }
-    else {
-        this.options.name = encodeURIComponent(options.keywords);
-        this.options.sortOrder = options.sortOrder;
-        this.options.pageNumber = options.pageNumber;
-        this.options.limit = options.limit;
-    }
-
+    this.options.additionalParam = constructAdditionalParams(options);
     const url = urlObject.buildSearchUrl(this.options);
     return getRequest(url).then((data) => {
         return JSON.parse(data).findItemsByKeywordsResponse;
@@ -29,7 +23,7 @@ const findItemsByKeywords = function (options) {
 };
 
 const findItemsByCategory = function (categoryID) {
-    if (!categoryID) throw new Error('Category ID is null or invalid');
+    if (!categoryID) throw new Error('INVALID_REQUEST_PARMS --> Category ID is null or invalid');
     this.options.name = categoryID;
     this.options.operationName = 'findItemsByCategory';
     this.options.param = 'categoryId';
@@ -47,7 +41,7 @@ const findItemsByCategory = function (categoryID) {
  * @param {Object} options
  */
 const findCompletedItems = function (options) {
-    if (!options) throw new Error('Keyword or category ID are required.');
+    if (!options) throw new Error('INVALID_REQUEST_PARMS --> Keyword or category ID are required.');
     if (!options.keywords && !options.categoryId) throw new Error('Keyword or category ID are required.');
     if (options.keywords) {
         options.keywords = encodeURIComponent(options.keywords);
@@ -77,8 +71,8 @@ const getVersion = function () {
  * @param {Object} options
  */
 const findItemsByProduct = function (options) {
-    if (!options) throw new Error('Please enter the Valid input.');
-    if (!options.productId) throw new Error('Product ID is required.');
+    if (!options) throw new Error('INVALID_REQUEST_PARMS --> Please enter the Valid input.');
+    if (!options.productId) throw new Error('INVALID_REQUEST_PARMS --> Product ID is required.');
     this.options.operationName = 'findItemsByProduct';
     this.options.additionalParam = constructAdditionalParams(options);
     let url = urlObject.buildSearchUrl(this.options);
@@ -90,6 +84,12 @@ const findItemsByProduct = function (options) {
     );
 };
 
+
+/**
+ * Constructs query param based on some logic to support filter and aspect_filter params.
+ * output will be keywords=iphone&itemFilter(0).name=Condition&itemFilter(0).value=3000&itemFilter(1).name=FreeShippingOnly&itemFilter(1).value=true&itemFilter(2).name=SoldItemsOnly&itemFilter(2).value=true
+ * @param {Object} options
+ */
 const constructAdditionalParams = (options) => {
     let params = '';
     let count = 0;