Developers – API documentation
When the module Connection External Systems/Koppeling Externe Systemen is activated in a subscription with EasyTrans Software, the Transport Management System EasyTrans has access to the APIs and Webhooks of EasyTrans Software.
The necessary documentation of the APIs – for programming purposes – can be found here.
Order Import API and Status Update Webhooks
This document describes the fields that can be used to import orders into EasyTrans.
It also contains information about the Webhooks to send Status updates and POD information back to the system of the sender.
The document is written for two audiences:
- Customers of EasyTrans (Customer accounts)
Customers use a customer account to place orders with the carrier. A typical example is a web shop that automatically submits transport orders as soon as a purchase is made.
Customer account credentials are used for authentication in the API. These are typically the same credentials that are used to log in to the Customer Portal. You can request access to the Customer Portal by contacting your carrier. - EasyTrans users (Branch accounts)
Branches are used internally withing the company of the carrier. A branch account can place orders for multiple different customers. A typical example is the integration of the API on the website of the carrier to provide a custom quote or order page for their customers.
Branch accounts are not used by the customers of the carrier but are only for internal use.
Documentation
Download the documentation of the Order Import API. This ZIP package contains all information and examples for importing orders and retrieving status update webhooks.
You can also check out our Postman example collection.
Customer Import API
This document describes the fields that can be used to import customers and their corresponding contact persons into EasyTrans.
This API can only be used for internal EasyTrans users (Branch accounts).
Documentation
Download the necessary documentation of the Customer Import API.
You can also check out our Postman example collection.
REST API
The REST API can be used to retrieve data out of EasyTrans, such as order details, status and POD information. This documentation explains the various endpoints that are available. Including code examples for working with the API in different programming languages.
info@easytrans.nl / United Kingdom: info@easytrans.co.uk).
Note: The REST API is not active by default. A request for activation can be done by sending an email to EasyTrans Software (Netherlands/Belgium:Documentation
All documentation and examples of the REST API can be found here.