dantio / ebay-api

A TypeScript client for the eBay RESTful and Traditional API to use NodeJS or in Browser.

A TypeScript library for working with the eBay API

This API implements both Traditional (xml) and the RESTful eBay API. It supports Client credentials grant and Authorization code grant (traditional, oAuth2 and IAF).

• getItem Example
• eBay API Explorer
• eBay API Docs

Implementation status

RESTful API

API	Implemented
Sell APIs	yes
Buy APIs	Marketplace Insights API is missing
Commerce APIs	yes
Developer APIs	yes
Post Order API	yes

Traditional API

API	Implemented
Finding API	yes
Shopping API	yes
Merchandising API	no
Trading API	yes
Client Alerts API	yes
Feedback API	no

Installation

npm install @hendt/ebay-api

Tests

npm run test

️ Usage:

Browser

Check out getItem example: https://hendt.github.io/ebay-api/.

A Proxy server is required to use the API in the Browser.

For testing purpose you can use: https://ebay.hendt.workers.dev/. You can also setup your own Proxy server. We have added a example for cloudfront workers: https://github.com/hendt/ebay-api/blob/master/proxy/worker.js

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@hendt/ebay-api@latest/lib/ebay-api.min.js"></script>
<script>
 const eBay = new eBayApi({
      appId: 'appId',
      certId: 'certId',
      devId: 'devId',

      sandbox: true,
      siteId: 77,

      interceptors: {
        request: (request) => {
          // Add Proxy
          request.url = 'https://ebay.hendt.workers.dev/' + request.url;
          return request;
        }
      }
    });

eBay.buy.browse.getItem('v1|254188828753|0').then(item => {
      document.getElementById('response').value = JSON.stringify(item, null, 2)
}).catch(e => {
        document.getElementById('response').value = e.message
});
</script>

Node

import eBayApi from '@hendt/ebay-api';

const ebay = new eBayApi({
  appId: '-- or Client ID --',
  certId: '-- or Client Secret',
  devId: 'devId', // Required for traditional trading API
  sandbox: false,
  siteId: eBayApi.SiteId.EBAY_DE, // see https://developer.ebay.com/DevZone/merchandising/docs/Concepts/SiteIDToGlobalID.html
  
  ruName: '-- eBay Redirect URL name --', // Required for authorization code grant
  authToken: '--  Auth\'n Auth for traditional API (used by trading) --', // Optional - can be set to use traditional API without code grant
});

Config

Config	Description
appId	Required. App ID (Client ID) from Application Keys.
certId	Required. Cert ID (Client Secret) from Application Keys.
devId	Conditionally required. The Dev Id from Application Keys.
sandbox	Optional. Default to 'false'. If true, the Sandbox Environment will be used.
scope	Conditionally required. Default to 'https://api.ebay.com/oauth/api_scope'.
ruName	Conditionally required. The redirect_url value. More info.
authToken	Optional. The Auth'N'Auth token. The traditional authentication and authorization technology used by the eBay APIs.
marketplaceId	Conditionally required. REST HTTP Header. X-EBAY-C-MARKETPLACE-ID identifies the user's business context and is specified using a marketplace ID value.
endUserCtx	Optional – Conditionally recommended. REST HTTP Header. X-EBAY_C_ENDUSERCTX provides various types of information associated with the request.
contentLanguage	Conditionally required. REST HTTP Header. Content-Language indicates the locale preferred by the client for the response.
acceptLanguage	Optional. REST HTTP Header. 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.
interceptors	Optional. Intercept request with Axios interceptors. See example in 'Browser' usage above.
maxRequests	Max request per day. Default to '5000'.

oAuth2: Exchanging the authorization code for a User access token

Docs

// 1. Create new eBayApi instance and set the scope.
const ebay = eBayApi.fromEnv();
// Attention: appId, certId, ruName is required.

ebay.auth.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'
]);

const url = ebay.auth.oAuth2.generateAuthUrl();
// 2. Open Url and Grant Access
console.log('Open URL', url);

// 3. Get the code that is placed as query parameter in redirected page
const code = 'code'; // from www.your-website?code=XXXX

// 4. Get the token
(async () => {
  // Use async/await
  const token = await ebay.auth.oAuth2.getToken(code);
  ebay.auth.oAuth2.setCredentials(token);
 
  // Or Promise
  ebay.sell.fulfillment.getOrder('12-12345-12345').then(order => {
        console.log('order', JSON.stringify(order, null, 2));
    }).catch(e => {
        console.log('error', {error: e.message});
    });
})();

RESTful API

How to set the Scope

const ebay = new eBayApi({
  // ...
  scope: ['https://api.ebay.com/oauth/api_scope']
});

// Or:
ebay.auth.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'
]);

Examples

Buy - getItem

ebay.buy.browse.getItem('v1|382282567190|651094235351').then(a => {
    console.log(a);
}).catch(e => {
    console.log(e)
});

Post-Order - getReturn

ebay.postOrder.return.getReturn('5132021997').then(a => {
    console.log(a);
}).catch(e => {
    console.log(e)
});

Finding - findItemsIneBayStores

ebay.finding.findItemsIneBayStores({
    storeName: 'HENDT'
}, {raw: true}).then(result => {
    // Return raw XML
    console.log(result);
});

Finding - findItemsByKeywords

ebay.finding.findItemsByKeywords({
    itemFilter: {
        name: 'Seller',
        value: 'hendt_de'
    }
}).then(result => {
    console.log(result);
});

Trading - GetMyeBaySelling

ebay.trading.GetMyeBaySelling({
    SoldList: {
        Include: true,
        Pagination: {
            EntriesPerPage: 20,
            PageNumber: 1
        }
    }
}).then(data => {
    console.log(data.results)
});

Contribution:

Check here

Supported By:

hendt.de

Similar projects:

ebay-promised ebay-client ebay-node-api

📝 License:

MIT.