Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
ebay-api
Advanced tools
Readme
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 have contributed to the module.
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.
The old eBay APIs are primarily XML-based, so this module unfortunately has to do a lot of JSON<->XML conversion.
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.)
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.
npm install ebay-api
var ebay = require('ebay-api');
(See the examples)
Sign up for an API key here: 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 and Terms when using this library.
xmlRequest(options, callback)
Makes an XML POST to an eBay API endpoints.
options
must contain:
serviceName
: e.g. 'Finding'opType
: e.g. 'findItemsAdvanced'appId
: your eBay API application IDand can optionally contain:
params
: (see examples and API documentation)reqOptions
: passed to the request module,
e.g. for additional headers
, or timeout
.xmlConverter
: function which takes the response XML and converts to JSON.
Module uses 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)for authentication, include:
devId
certId
authToken
callback
gets (error, data)
.
flatten(obj)
Simplifies the JSON format of the API responses:
{ @key:KEY, __value__:VALUE }
is flattened to its key:value pair.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.
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.
See the 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.
This module uses the debug module for internal logging.
Run your app (or node REPL) with DEBUG=ebay* ...
to see output.
FAQs
eBay API for Node and Browser
The npm package ebay-api receives a total of 4,254 weekly downloads. As such, ebay-api popularity was classified as popular.
We found that ebay-api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.