Skip to main content
POST
/
fleet
/
routes
Create a route
curl --request POST \
  --url https://api.samsara.com/fleet/routes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Bid 123",
  "stops": [
    {
      "addressId": "45934",
      "externalIds": {},
      "name": "Stop #1",
      "notes": "These are my notes",
      "ontimeWindowAfterArrivalMs": 300000,
      "ontimeWindowBeforeArrivalMs": 300000,
      "scheduledArrivalTime": "2019-06-13T19:08:25Z",
      "scheduledDepartureTime": "2019-06-13T19:08:25Z",
      "sequenceNumber": 10
    }
  ],
  "driverId": "1234",
  "externalIds": {},
  "notes": "These are my notes",
  "recomputeScheduledTimes": true,
  "settings": {
    "routeCompletionCondition": "arriveLastStop",
    "routeStartingCondition": "departFirstStop",
    "sequencingMethod": "scheduledArrivalTime"
  },
  "tagIds": [
    "123",
    "321"
  ],
  "vehicleId": "453546"
}
'
{
  "data": {
    "id": "342341",
    "actualRouteEndTime": "2019-06-13T19:08:25Z",
    "actualRouteStartTime": "2019-06-13T19:08:25Z",
    "driver": {
      "id": "45646",
      "externalIds": {},
      "name": "Driver Bob"
    },
    "externalIds": {},
    "name": "Bid 123",
    "notes": "These are my notes",
    "orgLocalTimezone": "America/Los_Angeles",
    "recurringRouteLiveSharingLinks": [
      {
        "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU",
        "name": "Name",
        "expiresAtTime": "2020-01-27T07:06:25Z"
      }
    ],
    "scheduledRouteEndTime": "2019-06-13T19:08:25Z",
    "scheduledRouteStartTime": "2019-06-13T19:08:25Z",
    "settings": {
      "routeCompletionCondition": "arriveLastStop",
      "routeStartingCondition": "departFirstStop",
      "sequencingMethod": "scheduledArrivalTime"
    },
    "stops": [
      {
        "id": "324231",
        "name": "Stop #1",
        "state": "scheduled",
        "actualArrivalTime": "2006-01-02T15:04:05+07:00",
        "actualDepartureTime": "2006-01-02T15:04:05+07:00",
        "actualDistanceMeters": 5450,
        "address": {
          "id": "494123",
          "name": "Company Office #1",
          "externalIds": {}
        },
        "documents": [
          {
            "id": "494123",
            "name": "Fuel Receipt Wichita"
          }
        ],
        "enRouteTime": "2006-01-02T15:04:05+07:00",
        "eta": "2006-01-02T15:04:05+07:00",
        "externalIds": {},
        "forms": [
          {
            "id": "41234"
          }
        ],
        "issues": [
          {
            "id": "32812"
          }
        ],
        "liveSharingUrl": "https://cloud.samsara.com/fleet/viewer/job/fleet_viewer_token",
        "locationLiveSharingLinks": [
          {
            "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU",
            "name": "Name",
            "expiresAtTime": "2020-01-27T07:06:25Z"
          }
        ],
        "notes": "These are my notes",
        "ontimeWindowAfterArrivalMs": 300000,
        "ontimeWindowBeforeArrivalMs": 300000,
        "plannedDistanceMeters": 5200,
        "scheduledArrivalTime": "2019-06-13T19:08:25Z",
        "scheduledDepartureTime": "2019-06-13T19:08:25Z",
        "sequenceNumber": 10,
        "singleUseLocation": {
          "latitude": 123.456,
          "longitude": 37.459,
          "address": "1234 Main St, San Jose, CA",
          "radiusMeters": 100
        },
        "skippedTime": "2006-01-02T15:04:05+07:00"
      }
    ],
    "tagIds": [
      "123",
      "321"
    ],
    "vehicle": {
      "externalIds": {},
      "id": "494123",
      "name": "Fleet Truck #1"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://samsara-showcase.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Name for the route

Example:

"Bid 123"

​
stops
object[]
required

List of stops along the route. For each stop, exactly one of addressId and singleUseLocation are required. Depending on the settings on your route, either a scheduledArrivalTime or scheduledDepartureTime must be specified for the first job.

Minimum array length: 2
​
driverId
string

ID of the driver. Can be either a unique Samsara ID or an external ID for the driver.

Example:

"1234"

​
externalIds
object

A map of external ids

​
notes
string

Notes about the route.

Maximum string length: 2000
Example:

"These are my notes"

​
recomputeScheduledTimes
boolean

This optional boolean parameter controls whether route schedule arrival and departure times are recalculated. When set to true, the system will automatically recompute the scheduledArrivalTime and scheduledDepartureTime for each stop along the route during route creation. This process overrides any manually provided values, with the exception of the first stop, which retains its user-defined schedule.

Example:

true

​
settings
object

An optional dictionary, only necessary to override the defaults for route start and end conditions.

​
tagIds
string[]

An array of IDs of tags to associate with this route.

Example:
["123", "321"]
​
vehicleId
string

ID of the vehicle. Can be either a unique Samsara ID or an external ID for the vehicle.

Example:

"453546"

Response

OK response.

​
data
object