Getting Started with Postnl-Ecommerce

Introduction

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "postnl/postnl-ecommerce-sdk:1.0.5"

Or add it to the composer.json file manually as given below:

"require": {
    "postnl/postnl-ecommerce-sdk": "1.0.5"
}

You can also view the package at: https://packagist.org/packages/postnl/postnl-ecommerce-sdk#1.0.5

Test the SDK

Unit tests in this SDK can be run using PHPUnit.

1. First install the dependencies using composer including the require-dev dependencies.
2. Run vendor\bin\phpunit --verbose from commandline to execute tests. If you have installed PHPUnit globally, run tests using phpunit --verbose instead.

You can change the PHPUnit test configuration in the phpunit.xml file.

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:

$client = PostnlEcommerceClientBuilder::init()
    ->customHeaderAuthenticationCredentials(
        CustomHeaderAuthenticationCredentialsBuilder::init(
            'apikey'
        )
    )
    ->environment(Environment::PRODUCTION_SERVER)
    ->build();

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
• Shipment
• Shipping Status
• Timeframes

Classes Documentation

• ApiException
• ApiResponse
• HttpRequest
• HttpResponse