Skip to content

Commit 2d61b55

Browse files
authored
Added api details in readme (#109)
* v2.7.7 * updated api details
1 parent d389d49 commit 2d61b55

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

README.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,11 @@ The intent is to simplify the request process by handling the tedious logic. It'
1414

1515
* [Installation](#installation)
1616
* [Usage](#usage)
17+
* [API Details](#api-details)
1718
* [Examples](#examples)
1819
* [Starter Guide](#starter-guide)
1920
* [Test](#test)
2021
* [Issues](#issues)
21-
* [Contribution](#contribution)
22-
* [LICENSE](#license)
2322

2423

2524
## 🚚 Installation
@@ -46,6 +45,38 @@ let ebay = new eBay({
4645

4746
Check out the [Starter Guide](https://pajaydev.github.io/ebay-node-api) documentation with examples to get started.
4847

48+
## API details
49+
50+
### Without Auth flow
51+
52+
HTTP Method | Methods | Description | Usage | Offical doc
53+
----------- | ------------------ | ----------- | ---------------- | --------------------------------
54+
GET | findItemsByKeywords | Searches for items on eBay by a keyword query.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L21) | [doc](https://developer.ebay.com/devzone/finding/callref/finditemsbykeywords.html)
55+
GET | findCompletedItems | 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.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L40) | [doc](https://developer.ebay.com/devzone/finding/callref/findCompletedItems.html)
56+
GET | findItemsByProduct | Searches for items on eBay using specific eBay product values.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L55) | [doc](https://developer.ebay.com/devzone/finding/callref/finditemsbykeywords.html)
57+
GET | findItemsAdvanced | Searches items on eBay by category or keyword or both.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L65) | [doc](https://developer.ebay.com/devzone/finding/callref/findItemsAdvanced.html)
58+
GET | getSingleItem | Retrieves publicly visible details about one listing on eBay.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L40) | [doc](https://developer.ebay.com/Devzone/shopping/docs/CallRef/GetSingleItem.html)
59+
GET | getMultipleItems | Retrieves publicly available data for one or more listings.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/shopping.js#L49) | [doc](https://developer.ebay.com/Devzone/shopping/docs/CallRef/GetMultipleItems.html)
60+
GET | getShippingCosts | Retrieve estimated shipping cost to ship an active item to a specified destination country and postal code.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L40) | [doc]( https://developer.ebay.com/devzone/shopping/docs/callref/GetShippingCosts.html)
61+
GET | getItemStatus | Get item status for given item ids.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/shopping.js#L28) | [doc](https://developer.ebay.com/Devzone/shopping/docs/CallRef/GetItemStatus.html)
62+
GET | getUserDetails | Get User Profile.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/shopping.js#L19) | [doc](https://developer.ebay.com/Devzone/shopping/docs/CallRef/GetUserProfile.html)
63+
64+
65+
### With Auth flow
66+
67+
HTTP Method | Methods | Description | Usage | Offical doc
68+
----------- | ------------------ | ----------- | ---------------- | --------------------------------
69+
GET | searchItems | Searches for eBay items by various query parameters and retrieves summaries of the items. You can search by keyword, category, eBay product ID (ePID), or GTIN, charity ID, or a combination of these.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/searchApi.js#L17) | [doc](https://developer.ebay.com/api-docs/buy/browse/resources/item_summary/methods/search)
70+
GET | getItem | Retrieve the complete details of a specific item.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/browseApi.js#L16) | [doc](https://developer.ebay.com/api-docs/buy/browse/resources/item/methods/getItem)
71+
GET | getItemsByItemGroup | Retrieve all the individual items in a group.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/browseApi.js#L55) | [doc](https://developer.ebay.com/api-docs/buy/browse/resources/item/methods/getItemsByItemGroup#uri.item_group_id)
72+
GET | getItemByLegacyId | Returns the RESTful item ID, which can then be used in any of other Buy API methods.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L21) | [doc](https://developer.ebay.com/devzone/finding/callref/finditemsbykeywords.html)
73+
GET | searchByImage | Returns the RESTful item ID, which can then be used in any of other Buy API methods.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/searchApi.js#L93) | [doc](https://developer.ebay.com/api-docs/buy/browse/resources/search_by_image/methods/searchByImage)
74+
GET | getMostWatchedItems | Retrieves data for items with the highest watch counts for the entire site or for a specific category.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/merchandisingApi.js#L15) | [doc](https://developer.ebay.com/DevZone/merchandising/docs/CallRef/getSimilarItems.html)
75+
GET | getSimilarItems | Retrieves recommended similar items for a specified item. | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/searchApi.js#L93) | [doc](https://developer.ebay.com/api-docs/buy/browse/resources/search_by_image/methods/searchByImage)
76+
GET | getItemAspectsForCategory | Retrieve an array of aspects that are appropriate for describing items in a specified category.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L40) | [doc](https://developer.ebay.com/api-docs/commerce/taxonomy/resources/methods)
77+
GET | getDefaultCategoryTreeId | Retrieve the default category tree reference for a specific eBay marketplace.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L40) | [doc](https://developer.ebay.com/api-docs/commerce/taxonomy/resources/methods)
78+
GET | getCategoryTree | Retrieve the complete category tree for category id.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L40) | [doc](https://developer.ebay.com/api-docs/commerce/taxonomy/resources/methods)
79+
4980
## Examples
5081

5182
```javascript

0 commit comments

Comments
 (0)