Skip to content

Commit b98fd1c

Browse files
committed
update readme and version bump
1 parent 2ed96c3 commit b98fd1c

File tree

2 files changed

+40
-28
lines changed

2 files changed

+40
-28
lines changed

README.md

Lines changed: 36 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ The intent is to simplify the request process by handling the tedious logic. It'
1818
* [Usage](#usage)
1919
* [Examples](#examples)
2020
* [Getting Access Token](#getaccesstoken)
21+
* [Finding Api(findItemsByKeywords, findItemsByCategory, findCompletedItems, getVersion)](#finding-api)
2122
* [Fetch Items By Keyword](#fetchitemsbykeyword)
2223
* [Get Items By Category](#getitemsbycategory)
2324
* [Get Single Item](#getitem)
@@ -71,7 +72,7 @@ If you using Sandbox environment, make sure to provide `env` variable in options
7172

7273
## Example
7374

74-
## GetAccessToken
75+
### GetAccessToken
7576

7677
```javascript
7778
const Ebay = require('ebay-node-api');
@@ -92,35 +93,44 @@ ebay.getAccessToken().then((data) => {
9293
});
9394
```
9495

95-
## FetchItemsByKeyword
96+
### Finding Api
9697
```javascript
97-
const Ebay = require('ebay-node-api');
98-
99-
let ebay = new Ebay({
100-
clientID: '-- Client APP ID ----',
101-
limit: 6
98+
//This call searches for items on eBay using specific eBay category ID numbers
99+
ebay.findItemsByCategory(10181).then((data) => {
100+
console.log(data);
101+
}, (error) => {
102+
console.log(error);
102103
});
104+
105+
//This call searches for items on eBay by a keyword query (keywords).
103106
ebay.findItemsByKeywords('iphone').then((data) => {
104-
console.log(data); // fetches top 6 results in form of JSON.
107+
console.log(data);
105108
}, (error) => {
106109
console.log(error);
107110
});
108-
```
109111

110-
## GetItemsByCategory
111-
```javascript
112-
let ebay = new Ebay({
113-
clientID: '-- Client APP ID ----',
114-
limit: 6
115-
});
116-
ebay.findItemsByCategory(10181).then((data) => {
112+
// 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.
113+
ebay.findCompletedItems({
114+
keywords: 'Garmin nuvi 1300 Automotive GPS Receiver',
115+
categoryId: '156955',
116+
sortOrder: 'PricePlusShippingLowest', //https://developer.ebay.com/devzone/finding/callref/extra/fndcmpltditms.rqst.srtordr.html
117+
Condition: 3000,
118+
SoldItemsOnly: true,
119+
entriesPerPage: 2
120+
}).then((data) => {
117121
console.log(data);
118122
}, (error) => {
119123
console.log(error);
120124
});
121-
```
122125

123-
## GetItem
126+
ebay.getVersion().then((data) => {
127+
console.log(data.version);
128+
}, (error) => {
129+
console.log(error);
130+
});
131+
132+
```
133+
### GetItem
124134
```javascript
125135
// Get access token and pass it to this method
126136
ebay.getAccessToken()
@@ -133,7 +143,7 @@ ebay.getAccessToken()
133143
});
134144
```
135145

136-
## GetItemByLegacyId
146+
### GetItemByLegacyId
137147
```javascript
138148
ebay.getAccessToken()
139149
.then((data) => {
@@ -149,7 +159,7 @@ ebay.getAccessToken()
149159
```
150160

151161

152-
## GetItemsByGroupId
162+
### GetItemsByGroupId
153163
```javascript
154164
ebay.getAccessToken()
155165
.then((data) => {
@@ -163,7 +173,7 @@ ebay.getAccessToken()
163173
});
164174
```
165175

166-
## SearchItemsByKeyword
176+
### SearchItemsByKeyword
167177
```javascript
168178
ebay.getAccessToken()
169179
.then((data) => {
@@ -178,7 +188,7 @@ ebay.getAccessToken()
178188
});
179189
```
180190

181-
## SearchItemsByFreeShipping
191+
### SearchItemsByFreeShipping
182192
```javascript
183193
ebay.getAccessToken()
184194
.then((data) => {
@@ -195,7 +205,7 @@ ebay.getAccessToken()
195205
});
196206
```
197207

198-
## SearchItemsByFilter
208+
### SearchItemsByFilter
199209
```javascript
200210

201211
ebay.getAccessToken()
@@ -213,7 +223,7 @@ ebay.getAccessToken()
213223
});
214224
```
215225

216-
## MerchandisingApi
226+
### MerchandisingApi
217227
```javascript
218228

219229
ebay.getMostWatchedItems({
@@ -238,7 +248,7 @@ ebay.getSimilarItems({
238248
// JSON format of similar items.
239249
});
240250
```
241-
## TaxonomyApi
251+
### TaxonomyApi
242252

243253
```javascript
244254
ebay.getAccessToken()
@@ -269,7 +279,7 @@ ebay.getAccessToken()
269279
});
270280
});
271281
```
272-
## ShoppingApi
282+
### ShoppingApi
273283
```javascript
274284

275285
ebay.getAllCategories('1234').then((data) => {

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ebay-node-api",
3-
"version": "2.5.7",
3+
"version": "2.6.0",
44
"description": "Ebay node api client",
55
"main": "./src/index.js",
66
"homepage": "https://github.com/pajaydev/ebay-node-api",
@@ -16,7 +16,9 @@
1616
"Searching",
1717
"products",
1818
"Browse",
19-
"Category"
19+
"Category",
20+
"FindingApi",
21+
"node-api"
2022
],
2123
"license": "MIT",
2224
"repository": {

0 commit comments

Comments
 (0)