Skip to main content

Overview

Interface for the PlentyMarkets API.

Setup

Requirements

  • Python 3.7.8+

Installation

Install it directly into an activated virtual environment:

$ pip install python_plenty_api

or add it to your Poetry project:

$ poetry add plenty_api

Usage

After installation, the package can imported:

$ python
>>> import plenty_api
>>> plenty_api.__version__

Examples

import plenty_api

def main():
    # Get the bearer token and set the basic attributes for an endpoint
    plenty = plenty_api.PlentyApi(base_url='https://{your-shop}.plentymarkets-cloud01.com',  # available under setup->settings->API->data
                                  use_keyring=True,  # Save the credentials into your system wide Keyring or not
                                  data_format='json',  # Choose the output format (default JSON)
                                  debug=True)  # display the constructed endpoint before making the request

    orders = plenty.plenty_api_get_orders_by_date(start='2020-09-20',
                                                  end='2020-09-24',
                                                  date_type='payment',  # Get orders that were payed in between [start] and [end]
                                                  additional=['documents', 'locations'],  # Include additional attributes to the response
                                                  refine={'orderType': '1', 'referrerId': '1'})  # Only get orders with type 1 and from referrer 1

if __name__ == '__main__':
    main()

Contact

Author: Sebastian Fricke, Company: Panasiam, Email: sebastian.fricke.linux@gmail.com

Release files for plenty-api 0.2.11.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for plenty-api 0.2.11.0
File Size Uploaded
plenty_api-0.2.11.0.tar.gz 40.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for plenty-api 0.2.11.0
File Interpreter ABI Platform
plenty_api-0.2.11.0-py3-none-any.whl Python 3 none any Details

Total release size: 82.8 kB

Release files / plenty_api-0.2.11.0.tar.gz

Download URL plenty_api-0.2.11.0.tar.gz
Size 40.5 kB
Tags Source
SHA-256 checksum
How to use checksums
322ad05bd9131c850df6c86d387fa45af6c41867fd269af3fbf588e52d865fa2
BLAKE2b-256 checksum
How to use checksums
d88268f771610d0bc2646defcf3be34a35106644594d6f2d129d63366d73fbea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.8 CPython/3.8.10 Linux/5.15.0-10025-tuxedo

Release files / plenty_api-0.2.11.0-py3-none-any.whl

Download URL plenty_api-0.2.11.0-py3-none-any.whl
Size 42.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1b87e706180d2d2fc43a65949241a2552c825523ce6714075ada1742a0dd0a25
BLAKE2b-256 checksum
How to use checksums
c498eb56bad0ffb67b6b8b983f975a26357ebc3b462de6c93e54f61cc67f29fd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.8 CPython/3.8.10 Linux/5.15.0-10025-tuxedo

Release history Release notifications | RSS feed

This release

0.2.11.0 This release

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2

2 release files

0.1

2 release files

0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page