Getting Started with Postnl-Ecommerce

Introduction

Install the Package

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

pip install postnl-ecommerce-sdk==1.0.6

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

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:

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

Authorization

This API uses the following authentication schemes.

• APIKeyHeader (Custom Header Signature)

List of APIs

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

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime