/amazon-orders

A CLI and library for interacting with Amazon order history

Primary LanguagePythonMIT LicenseMIT

amazon-orders - a python library

Version Python Versions Coverage Build Docs GitHub License

amazon-orders is an unofficial library that provides a command line interface alongside a programmatic API that can be used to interact with Amazon.com's consumer-facing website.

This works by parsing website data from Amazon.com. A period build validates functionality to ensure its stability, but as Amazon provides no official API to use, this package may break at any time. This package only supports the English version of the website.

Installation

amazon-orders is available on PyPI and can be installed using pip:

pip install amazon-orders

That's it! amazon-orders is now available as a Python package is available from the command line.

Basic Usage

Execute amazon-orders from the command line with:

amazon-orders --username <AMAZON_EMAIL> --password <AMAZON_PASSWORD> history

Or use amazon-orders programmatically:

from amazonorders.session import AmazonSession
from amazonorders.orders import AmazonOrders

amazon_session = AmazonSession("<AMAZON_EMAIL>",
                               "<AMAZON_PASSWORD>")
amazon_session.login()

amazon_orders = AmazonOrders(amazon_session)
orders = amazon_orders.get_order_history(year=2023)

for order in orders:
    print(f"{order.order_number} - {order.grand_total}")

Documentation

For more advanced usage, amazon-orders's official documentation is available at http://amazon-orders.readthedocs.io.

Contributing

If you would like to get involved, be sure to review the Contribution Guide.

Want to contribute financially? If you've found amazon-orders useful, sponsorship would also be greatly appreciated!