ebay-api 1.13.7 → 6.2.0

package/README.md

@@ -1,149 +1,543 @@
-eBay API client for Node.js
-===============
+# eBay Node API in TypeScript with Browser support
+[![Build Status](https://travis-ci.com/hendt/ebay-api.svg?branch=master)](https://travis-ci.com/hendt/ebay-api)
+[![codecov](https://codecov.io/gh/hendt/ebay-api/branch/master/graph/badge.svg?token=E67PSWIZFZ)](https://codecov.io/gh/hendt/ebay-api)
 
-[![Build Status](https://travis-ci.org/benbuckman/nodejs-ebay-api.svg)](https://travis-ci.org/benbuckman/nodejs-ebay-api)
+This eBay API implements both Traditional \(xml\) and the RESTful eBay API.
+It supports `client credentials grant` and `authorization code grant` \(Auth'N'Auth, OAuth2 and IAF\).
 
-**[Roberto Oliveros](https://www.linkedin.com/in/roberto-oliveros-99467661/) is an eBay API Ninja (as well as an expert at pretty much everything else) and will be the one making the major commits to this module going forwards. Get in touch via the link, he'll be happy to hear from you :)**
+* [API Browser Examples](https://hendt.github.io/ebay-api/)
+* [API Documentation](https://hendt.gitbook.io/ebay-api/)
 
-**A huge thank you to Ben Buckman who performed a huge amount of work on this module. Without his efforts this package wouldn't exist. [Several other people][network] have contributed to the module**
+## eBay Docs
+* [eBay API Explorer](https://developer.ebay.com/my/api_test_tool)
+* [eBay API Docs](https://developer.ebay.com/docs)
 
+## Changelog
 
-## Intro
+* `v6.2.0` is the latest release.
+* See [here](https://github.com/hendt/ebay-api/blob/master/CHANGELOG.md) for the full changelog.
 
-This module aims to support all of eBay's old APIs (Trading, Shopping, Finding, Merchandising, etc),
-with an interface that is both a) somewhat consistent across APIs and b) not too different from the underlying interface.
+## Implementation status
 
-The old eBay APIs are primarily XML-based, so this module unfortunately has to do a lot of JSON<->XML conversion.
+### RESTful API
 
-**In due course the repo will be updated and given a new home and we'll start work on some of the issues / pull requests. Please do get in touch if you're working on something and your need is urgent!** 
+| API | Implemented |
+| :--- | :--- |
+| **Buy API** | ✔ Browse API `v1.10.0`<br>✔  Deal API `v1.3.0`<br>✔ Feed API<br>✔ Marketing API<br>✔ Offer API<br>✔ Order API<br>✔ Marketplace Insights API |
+| **Commerce API** | ✔ Catalog API<br>✔ Charity API `v1.2.0`<br>✔ Identity API<br>✔ Notification API `v1.2.0`<br>✔ Taxonomy API `v1.0.0`<br>✔ Translation API `v1_beta.1.4` |
+| **Developer API** | ✔ Analytics API|
+| **Post Order API** | ✔ Cancellation API<br>✔ Case Management API<br>✔ Inquiry API<br>✔ Return API |
+| **Sell API** | ✔ Account API `v1.6.3`<br>✔ Analytics API `v1.3.0`<br>✔ Compliance API `v1.4.1`<br>✔ Feed API<br>✔ Finance API `v1.9.0`<br>✔ Fulfillment API `v1.19.10`<br>✔ Inventory API `v1.14.0`<br>✔ Listing API<br>✔ Logistics API<br>✔ Marketing API `v1.10.0`<br>✔ Metadata API<br>✔ Negotiation API `v1.1.0`<br>✔ Recommendation API `v1.1.0`|
 
+### Traditional API
 
-### Current state
+| API | Implemented |
+| :--- | :--- |
+| **Finding API** | ✔ |
+| **Shopping API** | ✔ |
+| **Merchandising API** | ✔ |
+| **Trading API** | ✔ |
+| **Client Alerts API** | ✔ |
+| **Feedback API** | ✔ |
 
-The 1.x branch is currently under active development, and there may be breaking changes between minor releases.  
-(I realize this is contrary to best practice, but the module is not yet settled enough to major-bump every time.)
+## Install
 
-**If you are using the 1.x branch, I recommend that you a) let me know your use case, b) help develop it, 
-c) watch the commit and release logs carefully.**
+```bash
+npm install ebay-api 
+yarn add ebay-api
+```
 
+## 🚀 Usage & Quick start
 
-## Usage
+Sign up for an API key here: [Developer Account](https://developer.ebay.com/signin?tab=register).
+Checkout API [examples](https://github.com/hendt/ebay-api/tree/master/examples).
 
-`npm install ebay-api`
+### NodeJS
 
-`var ebay = require('ebay-api');`
+```javascript
+import eBayApi from 'ebay-api';
+// or:
+// const eBayApi = require('ebay-api')
 
-(See the [examples][examples])
+const eBay = new eBayApi({
+  appId: '-- also called Client ID --',
+  certId: '-- also called Client Secret --',
+  sandbox: false
+});
 
+const item = await eBay.buy.browse.getItem('v1|254188828753|0');
+console.log(JSON.stringify(item, null, 2));
+```
 
-## A eBay APIs
+#### Detailed configuration example
+```javascript
+import eBayApi from 'ebay-api';
 
-[http://developer.ebay.com](http://developer.ebay.com) 
-
-Sign up for an API key here: [https://publisher.ebaypartnernetwork.com/PublisherToolsAPI](https://publisher.ebaypartnernetwork.com/PublisherToolsAPI)
-
-(You'll need a key to run the examples.)
-
-And please make sure to follow the liscence terms: eBay API [License](http://developer.ebay.com/join/licenses/individual/) and [Terms](https://www.x.com/developers/ebay/programs/affiliates/terms) when using this library.
+const eBay = new eBayApi({
+  appId: '-- also called Client ID --',
+  certId: '-- also called Client Secret --',
+  sandbox: false,
 
+  siteId: eBayApi.SiteId.EBAY_US, // required for traditional APIs, see https://developer.ebay.com/DevZone/merchandising/docs/Concepts/SiteIDToGlobalID.html
+  
+  marketplaceId:  eBayApi.MarketplaceId.EBAY_US, // defautl. required for RESTful APIs
+  acceptLanguage: eBayApi.Locale.en_US, // defautl
+  contentLanguage: eBayApi.ContentLanguage.en_US, // defautl.
 
-## Methods
+  // optional parameters, should be omitted if not used
+  devId: '-- devId --', // required for traditional Trading API
+  ruName: '-- eBay Redirect URL name --', // 'RuName' (eBay Redirect URL name) required for authorization code grant
+  
+  authToken: '--  Auth\'n\'Auth for traditional API (used by trading) --', // can be set to use traditional API without code grant
+});
+```
+
+### Browser
+Check out live example: [https://hendt.github.io/ebay-api/](https://hendt.github.io/ebay-api/).
+Because of the eBay CORS problems a Proxy server is required to use the API in the Browser.
+
+For testing purpose you can use `https://ebay.hendt.workers.dev/` url as proxy. You can also set up your own Proxy server. We have added a example for cloudfront workers: [https://github.com/hendt/ebay-api/blob/master/proxy/worker.js](https://github.com/hendt/ebay-api/blob/master/proxy/worker.js)
+
+Or use [https://github.com/Rob--W/cors-anywhere](CORS Anywhere is a NodeJS proxy) (works very well with heroku.com).
+
+
+```html
+<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/ebay-api@latest/lib/ebay-api.min.js"></script>
+<script>
+  const eBay = new eBayApi({
+    appId: 'appId',
+    certId: 'certId',
+    sandbox: false
+  });
+
+  // eBay.req.instance is AxiosInstance per default
+  eBay.req.instance.interceptors.request.use((request) => {
+      // Add Proxy
+      request.url = 'https://ebay.hendt.workers.dev/' + request.url;
+      return request;
+  });
 
-### `xmlRequest(options, callback)`
+  eBay.buy.browse.getItem('v1|254188828753|0').then(item => {
+      console.log(JSON.stringify(item, null, 2));
+  }).catch(e => {
+      console.error(e);
+  });
+</script>
+```
+
+## 🔧 eBayApi Config
+The first (required) parameter in eBayApi instance takes an object with following properties:
+
+| Name | Occurrence  | Description |
+| :--- | :--- | :--- |
+| appId | Required | App ID \(Client ID\) from  [Application Keys](https://developer.ebay.com/my/keys). |
+| certId | Required | Cert ID \(Client Secret\) from  [Application Keys](https://developer.ebay.com/my/keys). |
+| devId | Conditionally | The Dev Id from [Application Keys](https://developer.ebay.com/my/keys). |
+| sandbox | Required<br><pre>Default: `false`</pre> | If true, the [Sandbox Environment](https://developer.ebay.com/tools/sandbox) will be used. |
+| ruName | Conditionally | The redirect\_url value. [More info](https://developer.ebay.com/api-docs/static/oauth-redirect-uri.html). |
+| autoRefreshToken | Required<pre>Default: `true`</pre> | Auto refresh the token if it's expired. |
+| siteId<br><i>Traditional</i> | Required<br><pre>Default: `SiteId.EBAY_US`</pre> | eBay site to which you want to send the request (Trading API, Shopping API). |
+| authToken<br><i>Traditional</i> | Optional | The Auth'N'Auth token. The traditional authentication and authorization technology used by the eBay APIs. |
+| marketplaceId<br><i>RESTful</i> | Required<br><pre>Default: `MarketplaceId.EBAY_US`</pre> | [Docs](https://developer.ebay.com/api-docs/static/rest-request-components.html#marketpl) REST HTTP Header. X-EBAY-C-MARKETPLACE-ID identifies the user's business context and is specified using a marketplace ID value. Note that this header does not indicate a language preference or consumer location. |
+| scope<br><i>RESTful</i> | Conditionally<bre><pre>Default:<br>`['https://api.ebay.com/oauth/api_scope']` </pre> | The scopes assigned to your application allow access to different API resources and functionality. |
+| endUserCtx<br><i>RESTful</i> | Conditionally recommended<br><i>RESTful</i> | [Docs](https://developer.ebay.com/api-docs/static/rest-request-components.html#headers) X-EBAY\_C\_ENDUSERCTX provides various types of information associated with the request. |
+| contentLanguage<br><i>RESTful</i> | Conditionally required<br><pre>Default: `ContentLanguage.en_US`</pre> | [Docs](https://developer.ebay.com/api-docs/static/rest-request-components.html#headers)Content-Language indicates the locale preferred by the client for the response. |
+| acceptLanguage<br><i>RESTful</i> | Optional<pre>Default: `Locale.en_US`</pre> | [Docs](https://developer.ebay.com/api-docs/static/rest-request-components.html#headers) Accept-Language indicates the natural language the client prefers for the response. This specifies the language the client wants to use when the field values provided in the request body are displayed to consumers. |
+
+## Load config from environment
+Use `eBayApi.fromEnv()` to load data from environment variables.
+
+| Name | Value |
+| :--- | :--- |
+| appId | process.env.EBAY_APP_ID |
+| certId | process.env.EBAY_CERT_ID |
+| devId | process.env.EBAY_DEV_ID |
+| authToken | process.env.EBAY_AUTH_TOKEN |
+| siteId |  process.env.EBAY_SITE_ID |
+| marketplaceId | process.env.EBAY_MARKETPLACE_ID |
+| ruName | process.env.EBAY_RU_NAME |
+| sandbox | process.env.EBAY_SANDBOX === 'true' |
+
+## 🐞 Debug
+To see debug logs use `DEBUG=ebay:*` environment variable.
+
+## 🔑 Access token types
+See the full Documentation [here](https://developer.ebay.com/api-docs/static/oauth-token-types.html).
+
+*Client credentials grant flow* mints a new Application access token.
+*Authorization code grant flow* mints a new User access token.
+
+### User access token (authorization code grant flow)
+👉 Recommended for all API Calls.
+
+> You must employ a User token to call any interface that accesses or modifies data that is owned by the user (such as user information and account data).
+To get a User token, the users of your app must grant your application the permissions it needs to act upon their behalf. This process is called user consent. With the user consent flow, each User token contains the set of scopes for which the user has granted their permission [(eBay Token Types)](https://developer.ebay.com/api-docs/static/oauth-token-types.html).
+
+### Application access token (client credentials grant flow)
+👉 Recommended for API calls that will only request application data (`GET` method, and it's also restricted).
+
+> Application tokens are general-use tokens that give access to interfaces that return application data. For example, many GET requests require only an Application token for authorization.
+[(eBay Token Types)](https://developer.ebay.com/api-docs/static/oauth-token-types.html)
+
+If no other token is set, this token will be obtained *automatically* in the process of calling an RESTful API.
+
+### Auth'N'Auth
+👉 The "old" way. Only works with Traditional API. 
+Checkout the [Auth'N'Auth example](https://github.com/hendt/ebay-api/tree/master/examples/traditional/authNAuth.ts).
+
+You can also generate the token on eBay developer page and use it directly (see Detailed configuration example).
+
+## OAuth2: Exchanging the authorization code for a User access token
+
+[eBay Docs](https://developer.ebay.com/api-docs/static/oauth-auth-code-grant-request.html)
 
-Makes an XML POST to an eBay API endpoints.
+```javascript
+import eBayApi from 'ebay-api';
+
+// 1. Create new eBayApi instance and set the scope.
+const eBay = eBayApi.fromEnv();
+
+eBay.OAuth2.setScope([
+  'https://api.ebay.com/oauth/api_scope',
+  'https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly',
+  'https://api.ebay.com/oauth/api_scope/sell.fulfillment'
+]);
+
+// 2. Generate and open Url and Grant Access
+const url = eBay.OAuth2.generateAuthUrl();
+console.log('Open URL', url);
+```
+
+After you granted success, eBay will redirect you to your 'Auth accepted URL' and add a query parameter `code`
+
+
+### Express example
+This is how it would look like if you use `express`:
+
+```javascript
+import eBayApi from 'ebay-api';
 
-`options` must contain:
+app.get('/success', async function(req, res) {
+  // 3. Get the parameter code that is placed as query parameter in redirected page
+  const code = req.query.code; // this is provided from eBay
+  const eBay = eBayApi.fromEnv(); // or use new eBayApi()
   
-  - `serviceName`: e.g. 'Finding'
-  - `opType`: e.g. 'findItemsAdvanced'
-  - `appId`: your eBay API application ID
-
-and can optionally contain:
-
-  - `params`: (see [examples][examples] and API documentation)
-  - `reqOptions`: passed to the [request][request] module, 
-    e.g. for additional `headers`, or `timeout`.
-  - `xmlConverter`: function which takes the response XML and converts to JSON. 
-    _Module uses [xml2js](https://www.npmjs.com/package/xml2js) by default, but can be overridden._
-  - `parser`: function which takes the response data (as JSON object) and extracts items
-    (or other units depending on the query). 
-    _Module includes a default parser._
-  - `sandbox`: boolean (default false = production). May need to add additional endpoint URLs to the code as needed.
-  - `raw`: boolean, set `true` to skip parsing and return the raw XML response.
-  - `parseDepth`: how many levels down to try to parse/interpret the response.
-     _The default parser is still experimental._ Set this to 0 or 1 to let your app do all the parsing.
-     (Default: unlimited)
+  try {
+    const token = await eBay.OAuth2.getToken(code);
+    eBay.OAuth2.setCredentials(token);
+    // store this token e.g. to a session
+    req.session.token = token
+
+    // 5. Start using the API
+    const orders = await eBay.sell.fulfillment.getOrders()
+    res.send(orders);
+  } catch(e) {
+    console.error(e)
+    res.sendStatus(400)
+  }
+});
+```
+
+If token is already in session:
+
+```js
+import eBayApi from 'ebay-api';
+
+app.get('/orders/:id', async function(req, res) {
+  const id = req.params.id; 
+  const eBay = eBayApi.fromEnv(); // or use new eBayApi(...)
+  const token = req.session.token;
+  if (!token) {
+    return res.sendStatus(403);
+  }
+
+  eBay.OAuth2.setCredentials(token);
   
-_for authentication, include:_
-
-  - `devId`
-  - `certId`
-  - `authToken`
-
-`callback` gets `(error, data)`.
-
-
-## Helpers
-
-### `flatten(obj)`
-
-Simplifies the JSON format of the API responses:
-
-- Single-element arrays and objects are flatted to their key:value pair.
-- The structure of the format `{ @key:KEY, __value__:VALUE }` is flattened to its key:value pair.
-- Other weird structures (from the API itself, or the XML->JSON conversion) are simplified. _(See the code for details.)_
-
-Its purpose is to make the data easier to handle in code, and to model/query in MongoDB.
-
-Runs synchronously, returns flattened object.
-
-The default parser will `flatten()` the response to a finite depth
-(because infinite recursion on an indeterminate response size would cause an unnecessary performance hit).  
-If you want to flatten further, use this method directly.
-
-
-### `parseResponseJson(data, options, callback)`
-
-The default parser. Can be overridden (see `options` on `xmlRequest()`). 
-
-
-### `convertXmlToJson(xmlBody, options, callback)`
-
-The default XML->JS converter. Uses xml2js. Can be overridden (see `options` on `xmlRequest()`). 
-
-
-### `getLatestApiVersions(callback)`
-
-_Disabled in 1.x. Please submit a PR with a fix/refactor if you use this._
-
-Get the version numbers of the APIs that make their version available.
-
-
-## Errors
-
-The client exports and attempts to differentiate between `EbaySystemError`, `EbayRequestError`, and `EbayClientError`.
-
-An `EbayAuthenticationError` is also defined, but not yet hooked up to anything.
-
-See http://developer.ebay.com/DevZone/Shopping/docs/CallRef/types/ErrorClassificationCodeType.html
-and http://developer.ebay.com/devzone/xml/docs/Reference/ebay/Errors/ErrorMessages.htm.
-
+  // If token get's refreshed
+  eBay.OAuth2.on('refreshAuthToken', (token) => {
+    req.session.token = token;
+  });
+  
+  try {
+    // 5. Start using the API
+    const order = await eBay.sell.fulfillment.getOrder(id);
+    res.send(order);
+  } catch(e) {
+    console.error(e)
+    res.sendStatus(400)
+  }
+});
+```
+
+## RESTful API
+
+### How to set the Scope
+
+```javascript
+const eBay = new eBayApi({
+  // ...
+  scope: ['https://api.ebay.com/oauth/api_scope']
+});
+
+// Or:
+eBay.OAuth2.setScope([
+  'https://api.ebay.com/oauth/api_scope',
+  'https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly',
+  'https://api.ebay.com/oauth/api_scope/sell.fulfillment'
+]);
+```
+
+### Use apix.ebay.com or apiz.ebay.com (beta) endpoints
+For some APIs, eBay use a `apix`/`apiz` subdomain. To use these subdomains you can use `.apix`/`.apiz` before the api call like this:
+```javascript
+  eBay.buy.browse.apix.getItem() // now it will use https://apix.ebay.com
+  eBay.buy.browse.apiz.getItem() // now it will use https://apiz.ebay.com
+```
+
+In any case eBay adds a new subdomain, it's also possible to configure whatever you want:
+```javascript
+  eBay.buy.browse.api({subdomain: 'apiy'}).getItem() // now it will use https://apiy.ebay.com
+```
+
+### How to refresh the token
+If `autoRefreshToken` is set to true (default value) the token will be automatically refreshed when eBay response with `invalid access token` error.
+
+Use Event Emitter to get the token when it gets successfully refreshed.
+```javascript
+eBay.OAuth2.on('refreshAuthToken', (token) => {
+  console.log(token)
+  // Store this token in DB
+});
+
+// for client token
+eBay.OAuth2.on('refreshClientToken', (token) => {
+  console.log(token)
+  // Store this token in DB
+});
+```
+To manuel refresh the auth token use `eBay.OAuth2.refreshAuthToken()` and for the client token `eBay.OAuth2.refreshClientToken()`.
+Keep in mind that you need the 'refresh_token' value set.
+
+```javascript
+const token = await eBay.OAuth2.refreshToken();
+// will refresh Auth Token if set, otherwise the client token if set.
+```
+
+## Additional request headers
+Sometimes you want to add additional headers to the request like a GLOBAL-ID `X-EBAY-SOA-GLOBAL-ID`. 
+You have multiple options to do this.
+
+### RESTful API headers
+```javascript
+  const eBay = new eBayApi();
+
+  eBay.buy.browse.api({headers: {
+      'X-EBAY-SOA-GLOBAL-ID': 'EBAY-DE'
+  }}).getItem('v1|382282567190|651094235351').then((item) => {
+    console.log(item)
+  })
+```
+
+### Traditional API headers
+You can pass headers directly in the method call in the second parameter:
+```javascript
+eBay.trading.AddFixedPriceItem({
+  Item: {
+    Title: 'title',
+    Description: {
+      __cdata: '<div>test</div>'
+    }
+  }
+}, {
+  headers: {
+    'X-EBAY-SOA-GLOBAL-ID': 'EBAY-DE'
+  }
+})
+```
+
+### Low level: use the Axios interceptor to manipulate the request
+```javascript
+  import eBayApi from 'ebay-api';
+  const eBay = new eBayApi(/* {  your config here } */);
+
+  eBay.req.instance.interceptors.request.use((request) => {
+    // Add Header
+    request.headers['X-EBAY-SOA-GLOBAL-ID'] = 'EBAY-DE';
+    return request;
+  })
+```
+
+### Handle JSON GZIP response e.g fetchItemAspects
+You need a decompress library installed like `zlib`.
+
+```bash 
+npm install zlib # or yarn add zlib
+```
+
+```javascript
+  import eBayApi from 'ebay-api';
+  import zlib from 'zlib';
+
+  const toString = (data) => new Promise((resolve) => {
+    zlib.gunzip(data, (err, output) => {
+      if (err) throw err;
+      resolve(output.toString());
+    });
+  });
+
+  const eBay = new eBayApi(/* {  your config here } */);
+
+  try {
+    const data = await eBay.commerce.taxonomy.fetchItemAspects(/* categoryTreeId */);
+    const result = await toString(data);
+    
+    console.log(result)
+  } catch (e) {
+    console.error(e);
+  }
+```
+
+## Controlling Traditional XML request and response
+The second parameter in the traditional API has the following options:
+
+```typescript
+export type Options = {
+  raw?: boolean // return raw XML
+  parseOptions?: object // https://github.com/NaturalIntelligence/fast-xml-parser
+  useIaf?: boolean // use IAF in header instead of Bearer
+  headers?: Headers // additional Headers (key, value)
+  hook?: (xml) => BodyHeaders // hook into the request to modify the body and headers
+};
+```
+
+[Fast XML](https://github.com/NaturalIntelligence/fast-xml-parser) is used to parse the XML. You can pass the parse option to `parseOptions` parameter.
 
 ## Examples
 
-See the [examples][examples] directory.
-To run the examples, you need to add your own app key (I don't want my keys to be disabled for abuse!) - 
-you can get one [here](https://publisher.ebaypartnernetwork.com/PublisherToolsAPI).
-
-
-## Debugging
-
-This module uses the [debug](https://github.com/visionmedia/debug) module for internal logging.
-
-Run your app (or node REPL) with `DEBUG=ebay* ...` to see output. 
-
+### Trading - AddFixedPriceItem \(CDATA\)
+
+You can submit your description using CDATA if you want to use HTML or XML.
+
+```javascript
+eBay.trading.AddFixedPriceItem({
+  Item: {
+    Title: 'title',
+    Description: {
+      __cdata: '<div>test</div>'
+    }
+  }
+})
+```
+
+### Trading - ReviseFixedPriceItem (Update the price of an item)
+
+```javascript
+eBay.trading.ReviseFixedPriceItem({
+  Item: {
+    ItemID: 'itemId',
+    StartPrice: 'startPrice'
+  }
+})
+```
+
+### Buy - getItem
+
+```javascript
+eBay.buy.browse.getItem('v1|382282567190|651094235351').then(a => {
+    console.log(a);
+}).catch(e => {
+    console.log(e)
+});
+```
+
+### Post-Order - getReturn
+
+```javascript
+eBay.postOrder.return.getReturn('5132021997').then(a => {
+    console.log(a);
+}).catch(e => {
+    console.log(e)
+});
+```
+
+### Finding - findItemsByProduct \(use XML attributes and value\)
+
+```javascript
+eBay.finding.findItemsByProduct({
+  productId: {
+    '@_type': 'ReferenceID',
+    '#value': '53039031'
+  }
+})
+
+// will produce:
+// <productId type="ReferenceID">53039031</productId>
+```
+
+### Finding - findItemsIneBayStores
+
+```javascript
+eBay.finding.findItemsIneBayStores({
+    storeName: 'HENDT'
+}, {raw: true}).then(result => {
+    // Return raw XML
+    console.log(result);
+});
+```
+
+### Finding - findItemsAdvanced \(findItemsByKeywords\)
+
+```javascript
+eBay.finding.findItemsAdvanced({
+    itemFilter: [{
+        name: 'Seller',
+        value: 'hendt_de'
+    }],
+    keywords: 'katze'
+}).then(result => {
+    console.log(result);
+});
+```
+
+### Trading - GetMyeBaySelling
+
+```javascript
+eBay.trading.GetMyeBaySelling({
+    SoldList: {
+        Include: true,
+        Pagination: {
+            EntriesPerPage: 20,
+            PageNumber: 1
+        }
+    }
+}).then(data => {
+    console.log(data.results)
+});
+```
+
+## FAQ
+1. Do I need the [eBay OAuth Client](https://www.npmjs.com/package/ebay-oauth-nodejs-client) dependency?
+
+No. This library has already all authentication implemented and support also auto refreshing token.
+
+2. What does IAF mean?
+
+IAF stands for IDENTITY ASSERTION FRAMEWORK.
+The traditional API supports IAF. That means you can use the OAuth2 token with the traditional APIs.
+
+3. Is it possible to Upload Pictures directly to EPS?
+
+Yes. Checkout the [Browser](https://hendt.github.io/ebay-api/) example and [Node Example here](https://github.com/hendt/ebay-api/blob/master/examples/traditional/trading.UploadSiteHostedPictures.ts).
+
+## Contribution
+
+Check [here](https://github.com/hendt/ebay-api/blob/master/CONTRIBUTING.md)
+
+## Supported By
+
+[hendt.de](https://hendt.de)  
+[rootle.de](https://rootle.de)
+
+## 📝 License
 
-[network]: https://github.com/benbuckman/nodejs-ebay-api/network
-[examples]: https://github.com/benbuckman/nodejs-ebay-api/tree/master/examples
-[request]: https://github.com/request/request
+MIT.