Skip to main content

Python wrapper for the Amazon Selling-Partner API

Project description

Downloads Downloads Downloads

PYTHON-AMAZON-SP-API

Amazon Selling-Partner API

A wrapper to access Amazon's Selling Partner API with an easy-to-use interface.


🌟 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:

  • 🙌 GitHub Sponsors
  • 🌐 BTC Address: bc1q6uqgczasmnvnc5upumarugw2mksnwneg0f65ws
  • 🌐 ETH Address: 0xf59534F7a7F5410DBCD0c779Ac3bB6503bd32Ae5

Your support helps keep the project alive and evolving, and is greatly appreciated!


Documentation

Documentation is available here

Documentation Status

Q & A

If you have questions, please ask them in GitHub discussions

discussions

or

join on slack

Installation

Badge

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

# 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.utcnow() - 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.utcnow() - timedelta(days=7)).isoformat())

# or use the shortcut
orders = Orders().get_orders(
    LastUpdatedAfter=(datetime.utcnow() - timedelta(days=1)).isoformat()
)

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

License


Base Client

The client is pretty extensible and can be used for any other API. Check it out here:

API Client

Alt

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-amazon-sp-api-1.6.95.tar.gz (89.4 kB view details)

Uploaded Source

Built Distribution

python_amazon_sp_api-1.6.95-py3-none-any.whl (132.7 kB view details)

Uploaded Python 3

File details

Details for the file python-amazon-sp-api-1.6.95.tar.gz.

File metadata

  • Download URL: python-amazon-sp-api-1.6.95.tar.gz
  • Upload date:
  • Size: 89.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for python-amazon-sp-api-1.6.95.tar.gz
Algorithm Hash digest
SHA256 73959cec45de2add9c05249f56ac45d08dc34f43544bb3e9af5e58bc9743324b
MD5 e94162078229885e8572c56e0b65ebcf
BLAKE2b-256 aa7472d277bc57524edb6badc30693e1bb3148c59ee1c0744bd778b85a0fbd3f

See more details on using hashes here.

File details

Details for the file python_amazon_sp_api-1.6.95-py3-none-any.whl.

File metadata

File hashes

Hashes for python_amazon_sp_api-1.6.95-py3-none-any.whl
Algorithm Hash digest
SHA256 f84db315a4ccfbc7b9629a58ed28ba915675bcaf46a967d3643334da1d0f4c0c
MD5 fc9421ed309122a02a1b66f62853f7fc
BLAKE2b-256 58e161c357b636e81dc6a36d877ed580912550ce7a1b6847a3f051035794b049

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page