Stop groups

This feature is configurable via .json input, without the need for code customization.
Available for both the Marketplace app and Platform. You can find a list of all available features here.

This how-to guide assumes you already completed the get started with vehicle routing tutorial.

Field name	Required	Data type	SI Unit	Defined on	Example	Configurable via `defaults`
`stop_groups`	No	`array` of `array` of `string`	NA	input	`{"stop_groups": [["foo", "bar"], ["baz", "roh"]]}`	➖

Stop groups allow you to define stops that have to go together on the same vehicle, without further requirements. Stop groups are used with the stop_groups feature which defines a list of groups (array of string). Each group must consist of at least 2 stops, given by their IDs.

Here is an example defining stop groups. A sample output obtained after solving the problem is also shown.

Input (JSON)
Output (JSON)

{
  "defaults": {
    "vehicles": {
      "speed": 20
    }
  },
  "stop_groups": [
    ["Fushimi Inari Taisha", "Kiyomizu-dera"],
    ["Gionmachi", "Kinkaku-ji"],
    ["Arashiyama Bamboo Forest", "Nijō Castle"]
  ],
  "stops": [
    {
      "id": "Fushimi Inari Taisha",
      "location": { "lon": 135.772695, "lat": 34.967146 }
    },
    {
      "id": "Kiyomizu-dera",
      "location": { "lon": 135.78506, "lat": 34.994857 }
    },
    {
      "id": "Nijō Castle",
      "location": { "lon": 135.748134, "lat": 35.014239 }
    },
    {
      "id": "Kyoto Imperial Palace",
      "location": { "lon": 135.762057, "lat": 35.025431 }
    },
    {
      "id": "Gionmachi",
      "location": { "lon": 135.775682, "lat": 35.002457 }
    },
    {
      "id": "Kinkaku-ji",
      "location": { "lon": 135.728898, "lat": 35.039705 }
    },
    {
      "id": "Arashiyama Bamboo Forest",
      "location": { "lon": 135.672009, "lat": 35.017209 }
    }
  ],
  "vehicles": [
    {
      "id": "v1",
      "start_location": {
        "lon": 135.772695,
        "lat": 34.967146
      }
    },
    {
      "id": "v2",
      "start_location": {
        "lon": 135.775682,
        "lat": 35.002457
      }
    },
    {
      "id": "v3",
      "start_location": {
        "lon": 135.672009,
        "lat": 35.017209
      }
    }
  ]
}

A how-to guide for using stop groups with vehicle routing.