Introduction
The Planning API is a RESTful API used to return the best possible planning for a logistics problem. It will sequence the operations and distribute them among the vehicles, taking [...]
Planning
Posts
Building requests for the Planning API
Before you can start using the API, you will need to obtain the authentication token. The following headers will be required, where the word token must be replaced by the token obt [...]
List of parameters
Mandatory parameters are denoted with “*“, the others are optional. The list of parameters is described separately by the groups they belong to: startDate The parameter [...]
How to receive the current status of the problem via webhook?
The Planning API works asynchronously . This means that when a problem is sent, an ID is returned and through this ID it will be possible to consult the current state of processing [...]
Rejected operations
When an operation cannot be fulfilled for some reason, it will be returned inside rejectOperations. The possible reasons for the rejection are detailed at possibleCausesOfRejectOpe [...]
Example 1 – Operations with a single vehicle
Description of the problem In this example, we have a request for the Planning API to solve a logistics problem involving 1 vehicle and 2 operations, starting from the distribution [...]
Example 2 – Multi-vehicle operations
In this example, we have a request to solve a logistics problem for a company with a fleet of 4 vehicles, 2 of which are VUC type trucks and the other 2 are VUC ¾ type trucks, and [...]
Status Codes – Planning
Below is the table with the status codes for each endpoint available in the Planning API: Code Method Endpoint Description 201 POST https://api.maplink.global/planning/v1/problems [...]
Error messages – Planning
The following table shows all the error messages that can be returned by the API in the response body: Error code Message Description VALIDATION_FAILED or VALIDATION_ERROR { messag [...]
