Skip to main content
Help us improve Python packaging – donate today!

Wrapper for the bol.com API

Project Description

https://badge.fury.io/py/python-bol-api.png https://travis-ci.org/pennersr/python-bol-api.png

A Python wrapper for the bol.com 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']
u'0093155141650'

Plaza API

Instantiate the API:

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

Invoke a method:

>>> open_orders = api.orders.list()

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

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

Fields are properly typed:

>>> open_orders[0].Paid
True
>>> open_orders[0].OrderItems[0].TransactionFee
Decimal('19.12')
>>> 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="http://plazaapi.bol.com/services/xsd/plazaapiservice-1.0.xsd"><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>dontemail@me.net</ns0:Email><ns0:Telephone>67890</ns0:Telephone><ns0:Company>Bol.com</ns0:Company></ns0:BillingDetails>'

Create a shipment:

>>> from bol.plaza.api import TransporterCode
>>> status = api.shipments.create(
    order_item_id=item.order_item.item_id,
    date_time=datetime.now(),
    expected_delivery_date=None,
    shipment_reference="some-ref-123",
    transporter_code=TransporterCode.GLS,
    track_and_trace="5678901234")
>>> status.eventType
"CONFIRM_SHPMENT"

Running the tests

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

pip install tox

Then, just run the tox:

tox

Release history Release notifications

This version
History Node

0.6.0

History Node

0.5.0

History Node

0.4.0

History Node

0.3.0

History Node

0.2.0

History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
python-bol-api-0.6.0.tar.gz (6.3 kB) Copy SHA256 hash SHA256 Source None Jun 21, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page