CodeFactor 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.

New Features

Async support!

  • httpx-based transport for sync clients, enabling connection pooling and consistent streaming behavior.
  • Async client package under sp_api.asyncio for 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

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, 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

License

Base Client

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

API Client

Alt

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.1.20)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for saleweaver from gravatar.com saleweaver

Credits

Author: Michael Primke

License

MIT

Requires

Python >=3.10

Provides Extra

aws-caching aws

Report project as malware

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-2.1.17.tar.gz (207.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_amazon_sp_api-2.1.17-py3-none-any.whl (350.8 kB view details)

Uploaded Python 3

File details

Details for the file python_amazon_sp_api-2.1.17.tar.gz.

File metadata

  • Download URL: python_amazon_sp_api-2.1.17.tar.gz
  • Upload date:
  • Size: 207.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.10.20

File hashes

Hashes for python_amazon_sp_api-2.1.17.tar.gz
Algorithm Hash digest
SHA256 2fc33049366dd60839cbe872e178a0fe339648dc15ce10a84d78e45f74f9e4ec
MD5 42217e4aeb7557d19a7df9a0db6608b7
BLAKE2b-256 5e70e1fc2664abd60527fcd16a3d2bda5b546e913411a1f6161f205fface3afa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_amazon_sp_api-2.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 c96893bec1bb5ddef3a4a5f06ceafde5afcee5491ccbf1f4f2c2d240c3b4b3e1
MD5 e936f48f664f13cdb7116e562c133733
BLAKE2b-256 0697573076952547b4c32b8e4b1c65cf3a1673580d886fc6b3e417f970324ae4

See more details on using hashes here.

Release history Release notifications | RSS feed

2.1.20

2.1.19

2.1.18

This release

2.1.17

2.1.16

2.1.15

2.1.14

2.1.13

2.1.12

2.1.11

2.1.10

2.1.9

2.1.8

2.1.7

2.1.6

2.1.5

2.1.4

2.1.3

2.0.15

2.0.14

2.0.13

2.0.12

2.0.11

2.0.10

2.0.9

2.0.8

2.0.7

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

1.9.60

1.9.59

1.9.58

1.9.57

1.9.56

1.9.55

1.9.54

1.9.53

1.9.52

1.9.51

1.9.50

1.9.49

1.9.48

1.9.47

1.9.46

1.9.40

1.9.39

1.9.38

1.9.37

1.9.36

1.9.35

1.9.34

1.9.33

1.9.32

1.9.31

1.9.30

1.9.29

1.9.28

1.9.27

1.9.26

1.9.25

1.9.24

1.9.23

1.9.22

1.9.21

1.9.20

1.9.18

1.9.17

1.9.16

1.9.15

1.9.14

1.9.13

1.9.12

1.9.11

1.9.10

1.9.9

1.9.8

1.9.7

1.9.6

1.9.5

1.9.4

1.9.3

1.9.2

1.9.1

1.8.22

1.8.21

1.8.20

1.8.19

1.8.17

1.8.16

1.8.15

1.8.14

1.8.13

1.8.3

1.8.2

1.8.1

1.7.15

1.7.14

1.7.13

1.7.12

1.7.11

1.7.10

1.7.9

1.7.8

1.7.7

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.6.104

1.6.103

1.6.102

1.6.101

1.6.100

1.6.99

1.6.98

1.6.97

1.6.96

1.6.95

1.6.94

1.6.93

1.6.92

1.6.91

1.6.90

1.6.89

1.6.88

1.6.87

1.6.86

1.6.85

1.6.84

1.6.83

1.6.82

1.6.81

1.6.80

1.6.79

1.6.78

1.6.77

1.6.76

1.6.75

1.6.74

1.6.73

1.6.72

1.6.71

1.6.70

1.6.69

1.6.68

1.6.67

1.6.66

1.6.65

1.6.64

1.6.63

1.6.62

1.6.61

1.6.60

1.6.59

1.6.58

1.6.57

1.6.56

1.6.55

1.6.54

1.6.53

1.6.52

1.6.51

1.6.50

1.6.49

1.6.48

1.6.47

1.6.46

1.6.45

1.6.44

1.6.43

1.6.42

1.6.41

1.6.40

1.6.37

1.6.35

1.6.34

1.6.33

1.6.32

1.6.31

1.6.30

1.6.29

1.6.28

1.6.27

1.6.26

1.6.25

1.6.24

1.6.23

1.6.22

1.6.21

1.6.20

1.6.19

1.6.18

1.6.17

1.6.16

1.6.15

1.6.13

1.6.12

1.6.11

1.6.10

1.6.9

1.6.8

1.6.6

1.6.5

1.6.4

1.6.3

1.6.0

1.5.3

1.5.2

1.5.1

1.5.0

1.4.3

1.4.0

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.1

1.1.0

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

0.19.0

0.18.10

0.18.9

0.18.8

0.18.7

0.18.6

0.18.5

0.18.4

0.18.3

0.18.2

0.18.0

0.17.5

0.17.4

0.17.3

0.17.2

0.17.1

0.17.0

0.16.0

0.15.0

0.14.3

0.14.2

0.14.1

0.14.0

0.13.7

0.13.6

0.13.5

0.13.4

0.13.3

0.13.2

0.13.1

0.13.0

0.12.4

0.12.3

0.12.2

0.12.1

0.12.0

0.11.1

0.11.0

0.10.4

0.10.3

0.10.2

0.10.1

0.10.0

0.9.4

0.9.2

0.9.0

0.8.5

0.8.4

0.8.3

0.8.2

0.8.1

0.8.0

0.7.4

0.7.3

0.7.2

0.7.1

0.7.0

0.6.8

0.6.6

0.6.4

0.6.3

0.6.2

0.6.1

0.6.0

0.5.3

0.5.2

0.5.1

0.5.0

0.4.8

0.4.7

0.4.6

0.4.5

0.4.2

0.4.1

0.4.0

0.3.6

0.3.5

0.3.4

0.3.3

0.3.2

0.3.1

0.3.0

0.2.5

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.10

0.1.9

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.28

0.0.27

0.0.26

0.0.25

0.0.24

0.0.23

0.0.22

0.0.21

0.0.19

0.0.18

0.0.17

0.0.16

0.0.15

0.0.14

0.0.13

0.0.12

0.0.9

0.0.8

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

0.0.1

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page