Skip to main content

Getting Started with Postnl-Ecommerce

Introduction

PostNL Ecommerce APIs

Explore our technical documentation, test your integration and go live with PostNL service.

Start using PostNL APIs for e-commerce processes

To get to know the PostNL APIs better, read all about it in our API overview. Learn everything you need to about our API's before embarking on integration with PostNL.

To connect to PostNL, you can request an API key via Mijn PostNL portal. Choose your APIs and build your integration. Explore our guides, examples, and resources to guide you through each phase of integration and start testing. Ensure that you can make successful test calls towards all endpoints used in the solution.

Contact our integrations team to have your test calls reviewed and gain access to our API production environment. Once everything is configured and validated, you'll be ready to go live and start using the PostNL service.

For help contact us via our support form: Need help? Submit a case | PostNL.

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install apimatic-pnl-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/apimatic-pnl-sdk/1.0.0

Test the SDK

You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands

pip install -r test-requirements.txt pytest

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
environment Environment The API environment.
Default: Environment.PRODUCTION_SERVER
http_client_instance Union[Session, HttpClientProvider] The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 60
max_retries int The number of times to retry an endpoint call if it fails.
Default: 3
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ["GET", "PUT"]
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
custom_header_authentication_credentials CustomHeaderAuthenticationCredentials The credential object for Custom Header Signature

The API client can be initialized as follows:

Code-Based Client Initialization

from postnlecommerce.configuration import Environment
from postnlecommerce.http.auth.custom_header_authentication import CustomHeaderAuthenticationCredentials
from postnlecommerce.postnlecommerce_client import PostnlecommerceClient

client = PostnlecommerceClient(
    custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(
        apikey='apikey'
    ),
    environment=Environment.PRODUCTION_SERVER
)

Environment-Based Client Initialization

from postnlecommerce.postnlecommerce_client import PostnlecommerceClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = PostnlecommerceClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name Description
PRODUCTION_SERVER Default Production server
NON_PRODUCTION_SERVER Sandbox environment for testing

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for apimatic-pnl-sdk 1.0.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 apimatic-pnl-sdk 1.0.0
File Size Uploaded Provenance Actions
apimatic_pnl_sdk-1.0.0.tar.gz 89.7 kB Without provenance Details for apimatic_pnl_sdk-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for apimatic-pnl-sdk 1.0.0
File Interpreter ABI Platform Actions
apimatic_pnl_sdk-1.0.0-py3-none-any.whl Python 3 none any Details for apimatic_pnl_sdk-1.0.0-py3-none-any.whl

Total release size: 311.3 kB

Release files / apimatic_pnl_sdk-1.0.0.tar.gz

Download URL apimatic_pnl_sdk-1.0.0.tar.gz
Size 89.7 kB
Tags Source
SHA-256 checksum
How to use checksums
02c186f12494526f6d3061841f977865b71a8d322096ca08c482c6039600fbd3
BLAKE2b-256 checksum
How to use checksums
f9f9f0f40aa5fb128809f1cad036fab90d1ab6d7abb4d6561c4bba862e52d58f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / apimatic_pnl_sdk-1.0.0-py3-none-any.whl

Download URL apimatic_pnl_sdk-1.0.0-py3-none-any.whl
Size 221.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
69990e7631e4993721d9fca69c9791b0187bbb3ce28cd99b792d0026aaf387c3
BLAKE2b-256 checksum
How to use checksums
e378a4d1d1940757fd5d84daaca83e3f7f246867b57302db536d9d7765b0b2b4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for apimatic-pnl-sdk 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

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