Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/starsprung/amazon-order-reports-api
https://github.com/starsprung/amazon-order-reports-api
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/starsprung/amazon-order-reports-api
- Owner: starsprung
- License: mit
- Created: 2020-12-26T08:00:23.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-07T23:48:50.000Z (over 2 years ago)
- Last Synced: 2024-03-14T15:26:57.297Z (8 months ago)
- Language: TypeScript
- Size: 1.87 MB
- Stars: 18
- Watchers: 2
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# amazon-order-reports-api
Scrapes orders and refunds from Amazon.com.
There's no offical API to retrieve these, so this library uses [Puppeteer](https://github.com/puppeteer/puppeteer/) internally to access them. As this isn't an officially supported API, it may break at any time. Puppeteer comes with some other caveats, notably when running in Docker. See [Puppeteer's troubleshooting section](https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md) if you run into issues.
This library has only been tested on Amazon.com with the language set to English. It's unknown if it will work in other regions/languages.
## Installation
```
npm i amazon-order-reports-api
```
## Usage
```
import { AmazonOrderReportsApi } from 'amazon-order-reports-api';
(async () => {
const api = new AmazonOrderReportsApi({
username: '[email protected]',
password: 'password1234',
// Or use otpFn
otpSecret: 'USJF YSN7 87YR PP4D AN78 FAAF 81D8 1PU9 JJRF QP87 9UDM IO3W SJRY'
});
for await (const item of api.getItems({
startDate: new Date('2020-10-01'),
endDate: new Date('2020-12-31')
})) {
console.log(item);
}
for await (const refund of api.getRefunds({
startDate: new Date('2020-10-01'),
endDate: new Date('2020-12-31')
})) {
console.log(refund);
}
await api.stop();
})();
```
## API
API docs are available on the [docs site](https://docs.starsprung.com/amazon-order-reports-api/)
## Email notifications
As a side effect of generating an order report, Amazon will send an email notification that the order report is ready. This can generate a large volume of emails if reports are retrieved frequently. In many mail providers, an e-mail filter can be used to delete or move these emails. E.g. in Gmail:
```
from:([email protected]) subject:(Your order history report)
```