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 >=3.7, <= 3.11. Install the package from PyPi using the following pip command:

pip install postnl-ecommerce-sdk==1.0.5

You can also view the package at: https://pypi.python.org/pypi/postnl-ecommerce-sdk/1.0.5

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	HttpClient	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']
custom_header_authentication_credentials	CustomHeaderAuthenticationCredentials	The credential object for Custom Header Signature

The API client can be initialized as follows:

client = PostnlecommerceClient(
    custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(
        apikey='apikey'
    )
)

API calls return an ApiResponse object that includes the following fields:

Field	Description
status_code	Status code of the HTTP response
reason_phrase	Reason phrase of the HTTP response
headers	Headers of the HTTP response as a dictionary
text	The body of the HTTP response as a string
request	HTTP request info
errors	Errors, if they exist
body	The deserialized body of the HTTP response

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.

• APIKeyHeader (Custom Header Signature)

List of APIs

• Postalcodecheck
• Barcode
• Checkout
• Confirming
• Deliverydate
• Labelling
• Locations
• Shipment
• Shipping Status
• Timeframes

Classes Documentation

• Utility Classes
• HttpResponse
• HttpRequest