IcyPalm / python-postnl-api

Python wrapper for the PostNL API, a way to track packages using their online portal.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

python-postnl-api

(Unofficial) Python wrapper for the PostNL API (Dutch Postal Services), which can be used to track packages and letter deliveries. You can use your jouw.postnl.nl credentials to use the API.

Quick test

When installed:

python -m postnl_api.test_postnl_api USERNAME PASSWORD

Or running directly:

test_postnl_api.py USERNAME PASSWORD

Code Example

from postnl_api import PostNL_API

# Login using your jouw.postnl.nl credentials
postnl = PostNL_API('email@domain.com', 'password')

# Get relevant deliveries
print("Getting relevant deliveries")
rel_deliveries = postnl.get_relevant_deliveries()
for delivery in rel_deliveries:
    print(delivery.debug_string)

# Get relevant deliveries
print("Getting all deliveries")
all_deliveries = postnl.get_deliveries()
for delivery in all_deliveries:
    print(delivery.debug_string)

# Get relevant deliveries
print("Getting all distributions (sent packages)")
distributions = postnl.get_distributions()
for distribution in distributions:
    print(distribution.debug_string)

# Get letters
print("Getting all letters, if that function is turned on")
letters = postnl.get_letters()
for letter in letters:
    print(letter.debug_string)

Miscellaneous

This blogpost describes the process of figuring out the API endpoints and shows how this can be done for other API's.

Changelog

See the CHANGELOG file.

Contributors

License

MIT

About

Python wrapper for the PostNL API, a way to track packages using their online portal.

License:MIT License


Languages

Language:Python 100.0%