Getting Started with PostNL Ecommerce APIs

Introduction

Collection of PostNL API's for ecommerce processes

Install the Package

Run the following command from your project directory to install the package from npm:

npm install sdksio-postnl-ecommerce-apis-sdk@1.0.0

For additional package details, see the Npm page for the sdksio-postnl-ecommerce-apis-sdk@1.0.0 npm.

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
timeout	number	Timeout for API calls. Default: 0
httpClientOptions	Partial<HttpClientOptions>	Stable configurable http client options.
unstableHttpClientOptions	any	Unstable configurable http client options.
apikey	StringEnum

HttpClientOptions

Parameter	Type	Description
timeout	number	Timeout in milliseconds.
httpAgent	any	Custom http agent to be used when performing http requests.
httpsAgent	any	Custom https agent to be used when performing http requests.
retryConfig	Partial<RetryConfiguration>	Configurations to retry requests.

RetryConfiguration

Parameter	Type	Description
maxNumberOfRetries	number	Maximum number of retries. Default: 0
retryOnTimeout	boolean	Whether to retry on request timeout. Default: true
retryInterval	number	Interval before next retry. Used in calculation of wait time for next request in case of failure. Default: 1
maximumRetryWaitTime	number	Overall wait time for the requests getting retried. Default: 0
backoffFactor	number	Used in calculation of wait time for next request in case of failure. Default: 2
httpStatusCodesToRetry	number[]	Http status codes to retry against. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
httpMethodsToRetry	HttpMethod[]	Http methods to retry against. Default: ['GET', 'PUT']

The API client can be initialized as follows:

const client = new Client({
  timeout: 0,
  environment: Environment.Production,
  apikey: 'apikey',
});

Environments

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

Fields

Name	Description
production	Default
environment2	-

Authorization

This API uses Custom Header Signature.

List of APIs

• Postalcodecheck
• Track Trace
• Checkout
• Deliverydate
• Locations
• Timeframes
• Labelling
• Barcode
• Confirming

Classes Documentation

• ApiResponse
• ApiError