A Promise-based module for working with the eBay API
npm install ebay-promised --save
This module provides a succint, verbose way to build requests with the eBay API.
Currently it works in production applications with the eBay XML POST Trading API, and I have not properly fleshed out the other eBay services.
Most of the other services are GET based and query string driven.
Features
- Bluebird Promises
- Transparent pagination
- Transparent eBay compliant rate-limiting
- Reasonable response parsers
- Functionally tested vs the Sandbox API
- ergonomic chaining API with immutability
- transparently can load instance from ENV vars
- proper Error subclassing to enable verbose use of
Promise.catch
How to use this module
Readinging through the Functional Tests is a great way to familiarize yourself with some common API calls.
# Basic Setup const ebay = Ebayconst err = Ebayerrors ebay // Transforms it to a sealed Request, global config can no longer change // Pass in a field,value // Pass in another field, value // Run the request against the eBay API // Ebay can also load your credentials from `process.env` const envEbay = Ebay
Supported Calls
All calls, fields, and globals that are currently defined live in ./es6/definitions
If you find a call that is missing, feel free to open an issue so it can be addressed, or make a pull request.
Pagination
Internally ebay-promised will attempt to detect when a request is paginated and go ahead and grab the subsequent pages for you and concatenate the results.
Utility methods
Pull requests are welcome.