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

Download files

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

Source Distribution

plenty_api-0.2.11.0.tar.gz (40.5 kB view details)

Uploaded Source

Built Distribution

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

plenty_api-0.2.11.0-py3-none-any.whl (42.3 kB view details)

Uploaded Python 3

File details

Details for the file plenty_api-0.2.11.0.tar.gz.

File metadata

  • Download URL: plenty_api-0.2.11.0.tar.gz
  • Upload date:
  • Size: 40.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.8.10 Linux/5.15.0-10025-tuxedo

File hashes

Hashes for plenty_api-0.2.11.0.tar.gz
Algorithm Hash digest
SHA256 322ad05bd9131c850df6c86d387fa45af6c41867fd269af3fbf588e52d865fa2
MD5 1f5cd1c4e500f416efce556124988e5b
BLAKE2b-256 d88268f771610d0bc2646defcf3be34a35106644594d6f2d129d63366d73fbea

See more details on using hashes here.

File details

Details for the file plenty_api-0.2.11.0-py3-none-any.whl.

File metadata

  • Download URL: plenty_api-0.2.11.0-py3-none-any.whl
  • Upload date:
  • Size: 42.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.8.10 Linux/5.15.0-10025-tuxedo

File hashes

Hashes for plenty_api-0.2.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1b87e706180d2d2fc43a65949241a2552c825523ce6714075ada1742a0dd0a25
MD5 20725121863266b7d08d665be6d33932
BLAKE2b-256 c498eb56bad0ffb67b6b8b983f975a26357ebc3b462de6c93e54f61cc67f29fd

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.2.11.0 This release

2 files

0.2.10.1

2 files

0.2.10.0

2 files

0.2.9.1

2 files

0.2.9

2 files

0.2.8.4

2 files

0.2.8.2

2 files

0.2.8.1

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2

2 files

0.1

2 files

0.0

2 files

Supported by

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