Geofences

You can use geofences to set restrictions when planning routes and take into account vehicle characteristics, access conditions, and terrain features. For more information, see Vehicle.

When orders are being assigned, geofence incompatibility is taken into account: both the global option and the values set for individual couriers. When planning routes, you can also cancel all limits related to geofences.

To remove restrictions for one or more orders in a route, use the ignore_zones_compatibility parameter. For more information, see Order incompatibility and geofences.

Geofences in the interface

You can manage geofences from the master data using the Planning interface. To do this:

1. Define geofences in Master data → Geofences (for more information, see Geofence master data).
2. Plan a route using an Excel file.
3. When you manage optimization settings on the Settings tab, select Consider geofences → Yes.

When planning routes, orders will be automatically assigned to zones by their coordinates.

You can also use public geofences.

Geofences in the API

You can work with geofences in the API in one of the following ways:

• Using API methods.
• Using geofences from the master data.
• Setting geofence boundaries by coordinates in the planning task.

API methods for working with geofences

API methods can be effectively used in the following situations:

• You create and edit geofences in a third-party service, update the geofence master data in RouteQ, and then use this master data for planning.
• You create and edit geofences in the RouteQ interfaceand then upload them to your corporate system using the Get company geofence or Get company geofence master data methods.

To work with geofences using the API, send a request to the mvrp resource with OAuth authorization:

curl -H "Content-Type: application/json" -H "Authorization: OAuth <your-token>" -X POST -d <request body> https://courier.yandex.ru/api/v1/vrs/add/mvrp

In the Authorization: OAuth <your-token> header, change <your-token> to the OAuth token that you received for Track & Trace.

Geofence description using coordinates

To set geofence coordinates directly in the planning task, create the zones object in the request. Each element of this item describes one geofence and contains the coordinates of the polygon vertices.

To obtain coordinates, use the tools of the [Yandex Map Constructor](https://yandex.com/map-constructor:

1. Draw a geofence using the Polygons tool (for more information, see Create an item in Yandex Map Constructor Help).

2. Click Save and continue → Export (for more information, see Exporting map items in Yandex Map Constructor Help).

3. Select GeoJSON → Download.

4. Use the geometry item in the request to form the zones item.

   Sample geofence description in a request

           "zones": [
           {
               "id": "zone1",
               "geometry": {
                   "type": "Polygon",
                   "coordinates": [
                       [
                           [
                               37.3890158054755,
                               55.8142956464218
                           ],
                           [
                               37.4755331394599,
                               55.7415407888477
                           ],
                           [
                               37.5716635105537,
                               55.7984405246533
                           ],
                           [
                               37.5847097752021,
                               55.799987651288
                           ],
                           [
                               37.3890158054755,
                               55.8142956464218
                           ]
                       ]
                   ]
               }
           }
        ]
   

To set geofences using coordinates, send a request to the mvrp resource:

curl -H "Content-Type: application/json" -X POST -d <request body> https://courier.yandex.ru/vrs/api/v1/add/mvrp?apikey=<API key>