Overview of Our API Landscape
At PostNL, we provide a robust API Management Platform designed to facilitate seamless data exchange between your systems and ours. Our platform adheres to industry standards and best practices, ensuring reliable and secure integrations for all our clients.
API Integration Capabilities
Our APIs are built with a robust architecture, allowing for seamless integration and data exchange. We prioritize adherence to industry standards to ensure that our platform meets the diverse needs of our customers.
Real-Time Tracking and Status Updates
We offer comprehensive real-time tracking capabilities through our existing APIs, such as the Shipping Status API. These APIs provide customers with up-to-date information on their shipments via our website and mobile app. For those requiring push notifications, our soon-to-be-launched Event Streaming Platform will further enhance this functionality. Additionally, our current Notification Platform and webhooks are available for use. Detailed information about status update codes can be found in the technical documentation. To access this, go to the T&T status codes under the Reference data.
Automated Notifications
Our system supports automated notifications for key delivery events, such as dispatch and delivery, sent via SMS, email, and push notifications. This feature is fully implemented and operational for both PostNL and our customers. The upcoming Event Streaming Platform will further streamline this process.
Authentication and Authorization
We employ secure methods for authenticating and authorizing API requests, including the use of API keys. Each API key is validated in combination with customer-specific details, ensuring secure access to our platform. Customers can request API keys through the MijnPostNL portal or create an account if you are a new customer.
Data Formats
To provide lightweight data formats, our API's exchange data in json-format. XML can be used via our SOAP-based API's but be aware that those endpoints are deprecated. All relevant information on endpoints and applicable data-formats is available on our development-portal.
Endpoints for Key Operations
We provide a wide range of endpoints for critical operations, including order creation, tracking status updates, and returns. Comprehensive documentation for each API, including available endpoints, can be accessed via our Developer Portal.
Error Handling
We pursue best practices in error handling, assigning appropriate HTTP status codes as described in the RFC 9110. For specific business or functional error codes related to request content, our technical documentation provides detailed information. To access this, go to the Error Codes under the Refrence Data.
System Compatibility
Our APIs are designed to be compatible with various systems, provided they can access RESTful APIs using an APIKeyHeader Custom Header Signature. This ensures broad compatibility with systems like ERP (Navision) and WMS (Ceyenne, Diract).