An Enterprise plan only endpoint
This collection enables customers to programmatically initiate the Route Optimization process. The HTTP requests and responses provide flexibility for users to initiate automated optimizations, and allows for integration into other systems.
The Route Optimization workflow requires several steps to complete task assignments. The sequence of operations is roughly the following:
- Schedule Route Optimization - Set up the RO parameters
- Start Route Optimization - Start RO calculation by the engine
- Apply Optimization Results - The result will not apply unless this endpoint is called
Additionally, there is a workflow designed for pre-scheduled routes (generally this is a case where routes are scheduled and assigned ahead of time, and the route is not adjusted once started) and another for on-demand (in this use case, new tasks may be added to a route once started). Please review both and reach out to Onfleet support for guidance.
Restriction
The current restriction only disallows starting a new optimization if the user or API key has an in-progress Route Optimization.