/python-amazon-sp-api

Python wrapper to access the amazon selling partner API

Primary LanguagePythonMIT LicenseMIT

PYTHON-AMAZON-SP-API

Tests

Amazon Selling-Partner API

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

Q & A

If you have questions, please ask them in GitHub discussions

discussions

or

join on slack


Donate

❤️ Donate

Installation

Badge

pip install python-amazon-sp-api

Usage

from sp_api.api import Orders
from sp_api.api import Reports
from sp_api.api import Feeds
from sp_api.base import SellingApiException
from sp_api.base.reportTypes import ReportType
from datetime import datetime, timedelta

# 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     
createReportResponse = 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(self, <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(
    RestrictedResources=['buyerInfo', 'shippingAddress'],
    LastUpdatedAfter=(datetime.utcnow() - timedelta(days=1)).isoformat()
)

Documentation

Documentation is available here

Documentation Status

Consultation

Do you need help implementing? I offer consultation for everything SP-API related.

Consultation

Playground

playground

The playground is a work in progress and currently in alpha. Please report bugs in this repository

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


Quality gate

Maintainability Rating Reliability Rating Coverage

Bugs Code Smells Technical Debt

Security Rating Lines of Code Duplicated Lines (%)