PYTHON-AMAZON-SP-API
Amazon Selling-Partner API
A wrapper to access Amazon's Selling Partner API with an easy-to-use interface.
New Features
Async support!
- httpx-based transport for sync clients, enabling connection pooling and consistent streaming behavior.
- Async client package under
sp_api.asynciofor non-blocking calls across services.
🌟 Thank you for using python-amazon-sp-api! 🌟
This tool helps developers and businesses connect seamlessly with Amazon's vast marketplace, enabling powerful automations and data management.
If you appreciate this project and find it useful, please consider supporting its continued development:
Your support helps keep the project alive and evolving, and is greatly appreciated!
Documentation
Documentation is available here
Q & A
If you have questions, please ask them in GitHub discussions
or
Installation
pip install python-amazon-sp-api
pip install "python-amazon-sp-api[aws]" # if you want to use AWS Secret Manager Authentication.
pip install "python-amazon-sp-api[aws-caching]" # if you want to use the Cached Secrets from AWS
Usage
from sp_api.api import Orders
from sp_api.api import Reports
from sp_api.api import DataKiosk
from sp_api.api import Feeds
from sp_api.base import SellingApiException
from sp_api.base.reportTypes import ReportType
from datetime import datetime, timedelta, timezone
# DATA KIOSK API
client = DataKiosk()
res = client.create_query(query="{analytics_salesAndTraffic_2023_11_15{salesAndTrafficByAsin(startDate:\"2022-09-01\" endDate:\"2022-09-30\" aggregateBy:SKU marketplaceIds:[\"ATVPDKIKX0DER\"]){childAsin endDate marketplaceId parentAsin sales{orderedProductSales{amount currencyCode}totalOrderItems totalOrderItemsB2B}sku startDate traffic{browserPageViews browserPageViewsB2B browserPageViewsPercentage browserPageViewsPercentageB2B browserSessionPercentage unitSessionPercentageB2B unitSessionPercentage}}}}")
print(res)
# orders API
try:
res = Orders().get_orders(CreatedAfter=(datetime.now(timezone.utc) - timedelta(days=7)).isoformat())
print(res.payload) # json data
except SellingApiException as ex:
print(ex)
# report request
create_report_response = Reports().create_report(reportType=ReportType.GET_MERCHANT_LISTINGS_ALL_DATA)
# submit feed
# feeds can be submitted like explained in Amazon's docs, or simply by calling submit_feed
Feeds().submit_feed(<feed_type>, <file_or_bytes_io>, content_type='text/tsv', **kwargs)
# PII Data
Orders(restricted_data_token='<token>').get_orders(CreatedAfter=(datetime.now(timezone.utc) - timedelta(days=7)).isoformat())
# or use the shortcut
orders = Orders().get_orders(
LastUpdatedAfter=(datetime.now(timezone.utc) - timedelta(days=1)).isoformat()
)
Async Usage
import asyncio
from datetime import datetime, timedelta, timezone
from sp_api.asyncio.api import Orders, Reports
from sp_api.base.reportTypes import ReportType
async def main():
async with Orders() as orders_client:
res = await orders_client.get_orders(
LastUpdatedAfter=(datetime.now(timezone.utc) - timedelta(days=1)).isoformat()
)
print(res.payload)
async with Reports() as reports_client:
report = await reports_client.create_report(
reportType=ReportType.GET_MERCHANT_LISTINGS_ALL_DATA
)
print(report.payload)
# OR
await Reports().create_report(
reportType=ReportType.GET_MERCHANT_LISTINGS_ALL_DATA
)
if __name__ == "__main__":
asyncio.run(main())
New endpoints
You can create a new endpoint file by running make_endpoint <model_json_url>
make_endpoint https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/listings-restrictions-api-model/listingsRestrictions_2021-08-01.json
This creates a ready to use client. Please consider creating a pull request with the new code.
ADVERTISING API
You can use nearly the same client for the Amazon Advertising API. @denisneuf has built Python-Amazon-Advertising-API on top of this client. Check it out here
DISCLAIMER
We are not affiliated with Amazon
LICENSE
Base Client
The client is pretty extensible and can be used for any other API. Check it out here:
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file python_amazon_sp_api-2.1.21.tar.gz.
File metadata
- Download URL: python_amazon_sp_api-2.1.21.tar.gz
- Upload date:
- Size: 207.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.10.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bec46befad08806eab0a7e5020ba572dcd0e423831cdf80c7d35c4d9a31c5eb5
|
|
| MD5 |
557be488c83487f519d91f330cc003b7
|
|
| BLAKE2b-256 |
dee5b65630c2a905b889d89bd366abf04d69eb669bf62e15882553eace377262
|
File details
Details for the file python_amazon_sp_api-2.1.21-py3-none-any.whl.
File metadata
- Download URL: python_amazon_sp_api-2.1.21-py3-none-any.whl
- Upload date:
- Size: 350.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.10.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5c62a397dc3890884a85d132a8d42b88a6448123c51c9b24eea158a1a751f5c3
|
|
| MD5 |
b4c3ba1c30c7ae3e153b162697ff1352
|
|
| BLAKE2b-256 |
19be28dd3db2cd116560f53bcfaaccdbd4b280ad621edb187a08f763585a347a
|
