---
metadata:
- name: generator
content: Diplodoc Platform v5.19.6
alternate:
- https://docs.routeq.com/doc/en/vrp/add-task.md
title: RouteQ — integration with the API — request structure
---
> **Documentation Index:** Fetch the complete configuration index at https://docs.routeq.com/doc/en/llms.txt
# Adding a task
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 [specifications](https://yandex.ru/routing/doc/en/vrp/redoc/index.html#operation/addMVRPTask).
{% include [postman-collection](_includes/postman-collection-c7a3adefee03.md) %}
## Description of the request body {#request-structure}
{% cut "JSON structure" %}
```json
{
"depot": {
// Describes the depot (if it's the only depot).
},
"depots": [
// Describes depots (if there are multiple depots).
],
"locations": [
// Describes orders.
],
"vehicles": [
// Describes vehicles.
"planned_route": {
// Describes previously planned destinations without specifying the visit sequence.
}
],
"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 used).
]
}
```
{% endcut %}
#|
||**Object/array** | **Description** | **Compliance with Excel sheets** | **Required** ||
||`depot`
`depots` | [Depot](https://docs.routeq.com/doc/en/vrp/properties-of-depot.md)
**Depot** and **Depots** are mutually exclusive objects. You can only use one of them at a time. | [Depot or Depots](https://docs.routeq.com/doc/en/vrp/excel-fill-guide.md#depot-depots) | ||
||`locations` | [Order](https://docs.routeq.com/doc/en/vrp/properties-of-orders.md) | [Orders](https://docs.routeq.com/doc/en/vrp/excel-fill-guide.md#orders) | ||
||`vehicles` | [Vehicle](https://docs.routeq.com/doc/en/vrp/properties-of-vehicles.md) | [Vehicles](https://docs.routeq.com/doc/en/vrp/excel-fill-guide.md#vehicles) | ||
||`planned_route` | [Planned route](https://docs.routeq.com/doc/en/vrp/properties-of-vehicles-routes.md#planned-route) | [Routes](https://docs.routeq.com/doc/en/vrp/excel-fill-guide.md#routes) | ||
||`options` | [Routing options](https://docs.routeq.com/doc/en/vrp/routing-options_index-page.md) | [Options](https://docs.routeq.com/doc/en/vrp/excel-fill-guide.md#options) | ||
||`incompatible_load_types` | [Order incompatibility](https://docs.routeq.com/doc/en/vrp/properties-of-orders.md) | [Incompatible_order_types](https://docs.routeq.com/doc/en/vrp/excel-fill-guide.md#incompatible-order-types) | ||
||`location_groups` | [Order grouping](https://docs.routeq.com/doc/en/vrp/grouping-locations.md) | [Location_groups](https://docs.routeq.com/doc/en/vrp/excel-fill-guide.md#location-groups) | ||
||`zones` | [Geofences](https://docs.routeq.com/doc/en/vrp/geozones.md) | - | ||
|#
\* Mandatory objects/arrays of objects when using the API to plan routes. Doesn't apply to the corresponding Excel sheets.
{% note info %}
Objects in the request body may reference your [presets](https://docs.routeq.com/doc/en/vrp/presets.md) (predefined settings).
{% endnote %}
Minimum set of parameters for each object:
- Depots `depots`:
- Identifier `id`.
- Coordinates `point.lat` and `point.lon`.
- Time window `time_window` or multiple time windows `time_windows` if the depot operates with breaks.
- Orders `locations`:
- Identifier `id`.
- Coordinates `point.lat` and `point.lon`.
- Time window for completing an order `time_window` or multiple time windows `time_windows`.
- Strictness of time window `hard_window`.
- Order handling time (time to complete an order) `service_duration_s`.
- Couriers and vehicles `vehicles`:
- Identifier `id`.
- Transportation method (on foot, public transport, car, or truck) `routing_mode`.
- Requirement to return to the depot after completing the route `return_to_depot`.
- Parameters of the planning algorithm `options`:
- Time zone `time_zone`.
## Stopping a task {#stop-planning}
To stop a planning task that's still in progress, send a request using the [/cancel/mvrp](https://yandex.ru/routing/doc/en/vrp/redoc/index.html#operation/postMVRPTaskCancel) method.
In the request, specify:
* `id`: Task ID.
* `apikey`: The API key specified in the company settings. For more information about API keys, see [API key](https://docs.routeq.com/doc/en/vrp/authorization.md#api-key).
**Request:**
```
curl -X POST https://courier.yandex.ru/vrs/api/v1/cancel/mvrp/{task-id}?apikey= -H "Content-Type: application/json" -H "Authorization: OAuth "
```
{% include [warehouse-feedback](_includes/feedback-81845556eeea.md) %}