Skip to main content

Amazon selling partner api clients.

Project description

amazon-sp-api-clients

This is a package generated from amazon selling partner open api models.

The package is tested in many situations, with fully type hint supported. Enjoy it!

typehint 1

typehint 2

typehint 3

Attention

V1.0.0 changes many api, compared with v0.x.x!

注意!V1.0.0相较于v0.x.x更改了大量的API!

Features

  • ready to use;
  • provide code to generate clients, in case that amazon update models;
  • type hint;
  • orders api, feed api, report api, and all other apis;
  • automatically manage tokens.

Installation

pip install amazon-sp-api-clients

Note

For technical support, please contact panhaoyu.china@outlook.com.

Previously this lib is only open access but not open source, and now it's time to make it public to serve more developers.

If there's any bug, please fell free to open an issue or send a pr.

Usage

For saving time, I just paste part of my test code here as a demo.

For better understanding, all the fields are the same length of actual fields, and some readable information are kept.

from datetime import datetime
import amazon_sp_api_clients
endpoint = "https://sellingpartnerapi-eu.amazon.com"
marketplace_id = "XXXXXXXXXXXXXX"
refresh_token = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
role_arn = "arn:aws:iam::123456789012:role/xxxxxx"
aws_access_key = 'XXXXXXXXXXXXXXXXXXXX'
aws_secret_key = "XXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
client_id = 'amzn1.application-oa2-client.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
client_secret = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
client_config = dict(
    role_arn=role_arn,
    endpoint=endpoint,
    marketplace_id=marketplace_id,
    refresh_token=refresh_token,
    aws_access_key=aws_access_key,
    aws_secret_key=aws_secret_key,
    lwa_client_key=client_id,
    lwa_client_secret=client_secret,
)
clients = amazon_sp_api_clients.AmazonSpApiClients(**client_config)
orders = clients.orders_v0.getOrders(
    MarketplaceIds=[marketplace_id],
    CreatedAfter=datetime(2000, 1, 1).isoformat()
).payload.Orders
for order in orders:
    print(order.AmazonOrderId, order.LastUpdateDate)

Configuration

The client configuration can be set both at the initiation and as environment variables.

  • SP_API_ROLE_ARN
  • SP_API_ENDPOINT
  • SP_API_REGION
  • SP_API_MARKETPLACE_ID
  • SP_API_REFRESH_TOKEN
  • SP_API_AWS_ACCESS_KEY
  • SP_API_AWS_SECRET_KEY
  • SP_API_LWA_CLIENT_KEY
  • SP_API_LWA_CLIENT_SECRET

Build

The client is generated in the following steps:

  1. download amazon open api repository;
  2. copy open api 2 json files from the amazon repository to a single directory;
  3. convert open api 2 json files to open api 3 json files;
  4. convert open api 3 json files to py clients.

The main script of generation is the test_main python file.

When convert open api to py clients, I separated the process into 6 steps, which are defined in the swager_client_generator.stages module.

If my build is not suitable for your demand, or amazon api model updates but my build do not follow, you can clone this repo, modify the api.pyt template and build it by yourself, and please push a PR, thanks!

Acknowledgement

The auth method is partially from python-amazon-sp-api.

Note

If this library helps you, please give me a star, thanks!

如果这个库对您有用,请为我点亮Star,谢谢!

Project details


Download files

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

Source Distribution

amazon_sp_api_clients-1.9.1.tar.gz (156.4 kB view details)

Uploaded Source

Built Distribution

amazon_sp_api_clients-1.9.1-py3-none-any.whl (204.1 kB view details)

Uploaded Python 3

File details

Details for the file amazon_sp_api_clients-1.9.1.tar.gz.

File metadata

  • Download URL: amazon_sp_api_clients-1.9.1.tar.gz
  • Upload date:
  • Size: 156.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.11 Windows/10

File hashes

Hashes for amazon_sp_api_clients-1.9.1.tar.gz
Algorithm Hash digest
SHA256 81e3950afd42ca01721c7dc58ef6511dcd0f86358f623dda595f41df6fcdd052
MD5 ed535dc981657db701399a0cbbd0c0db
BLAKE2b-256 2c9c8acf511ab4c623fb69b8e9b70c4ee29c1bb4eddea065a142ddbe8189acd7

See more details on using hashes here.

File details

Details for the file amazon_sp_api_clients-1.9.1-py3-none-any.whl.

File metadata

File hashes

Hashes for amazon_sp_api_clients-1.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2bfcd1c591725ab2bfa18aa466028413fef833d107c9dfc897141e3300a42b97
MD5 102872937f2cd2be97f0cc655723e8e4
BLAKE2b-256 558b3b5e5b6c38cb581e891a769ae9f79a4c0d874c99b3c7f49aab4a3f1e4b94

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