Adding a task

  1. Description of the request body

When using the API to plan routes, the parameters are passed to RouteQ in the request body in JSON format. You can queue a task for processing using the /add/mvrp method. To learn more, see the page with specifications.

To send API requests using Postman, you can use the RouteQ API collection.

Description of the request body

JSON structure
{
    "depot": {
        // Describes the depot if there is only one.
    },
    "depots": [
        // Describes depots if there are more than one.
    ],
    "locations": [
        // Describes orders.
    ],
    "vehicles": [
        // Describes vehicles.
        "planned_route": {
            // Describes previously planned destinations without specifying the route list.
        }
    ],
   "options": {
        // Describes routing options.
        "incompatible_load_types": [
            // Describes incompatible order types.
         ],
        "location_groups": [
            // Describes order groups.  
         ] 
    },
    "zones": [
        // Describes geofences (if geofences from the interface aren't use).
    ]
}
Object/array Description Compliance with Excel sheets Mandatory fields*
depot

depots

Depot

The Depot and Depots objects are mutually exclusive objects. You can only use one of them at a time.

Depot or Depots
locations Order Orders
vehicles Vehicle Vehicles
planned_route Planned route Routes
options Routing options Options
incompatible_load_types Order incompatibility Incompatible_order_types
location_groups Order grouping Location_groups
zones Geofences -
Object/array Description Compliance with Excel sheets Mandatory fields*
depot

depots

Depot

The Depot and Depots objects are mutually exclusive objects. You can only use one of them at a time.

Depot or Depots
locations Order Orders
vehicles Vehicle Vehicles
planned_route Planned route Routes
options Routing options Options
incompatible_load_types Order incompatibility Incompatible_order_types
location_groups Order grouping Location_groups
zones Geofences -

* Mandatory objects/arrays of objects when using the API to plan routes. Doesn't apply to the corresponding Excel sheets.

Note.

Objects in the request body may include references to presets (predefined settings).

Contact support