Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

Wrapper for the API

Project description

A Python wrapper for the API. Currently rather incomplete, as it offers only those methods required for my own projects so far.

Open API

Instantiate the API:

>>> from bol.openapi.api import OpenAPI
>>> api = OpenAPI('api_key')

Invoke a method:

>>> data = api.catalog.products((['1004004011187773', '1004004011231766'])

JSON data is returned “as is”:

>>> data['products'][0]['ean']

Plaza API

Instantiate the API:

>>> from bol.plaza.api import PlazaAPI
>>> api = PlazaAPI('public_key', 'private_key', test=True)

Invoke a method:

>>> open_orders =

Fields are derived 1:1 from the API XML, including CamelCase conventions:

>>> open_orders[0].Buyer.BillingDetails.Streetname

Fields are properly typed:

>>> open_orders[0].Paid
>>> open_orders[0].OpenOrderItems[0].TransactionFee
>>> open_orders[0].DateTimeDropShipper
datetime.datetime(2014, 2, 10, 12, 7, 7)

Access the underlying XML:

>>> from xml.etree import ElementTree
>>> ElementTree.tostring(open_orders[0].Buyer.BillingDetails.xml)
'<ns0:BillingDetails xmlns:ns0=""><ns0:SalutationCode>02</ns0:SalutationCode><ns0:FirstName>Jans</ns0:FirstName><ns0:Surname>Janssen</ns0:Surname><ns0:Streetname>Billingstraat</ns0:Streetname><ns0:Housenumber>1</ns0:Housenumber><ns0:HousenumberExtended>a</ns0:HousenumberExtended><ns0:AddressSupplement>Onder de brievanbus huisnummer 1</ns0:AddressSupplement><ns0:ZipCode>5000 ZZ</ns0:ZipCode><ns0:City>Amsterdam</ns0:City><ns0:CountryCode>NL</ns0:CountryCode><ns0:Email></ns0:Email><ns0:Telephone>67890</ns0:Telephone><ns0:Company></ns0:Company></ns0:BillingDetails>'

Running the tests

First, make sure that you have tox installed on your system:

pip install tox

Then, just run the tox:


Project details

Download files

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

Files for python-bol-api, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size python-bol-api-0.3.0.tar.gz (4.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page