Depot Schema

Model

Depot

Depot = object

The depot data. All depots in the API will have this format.

Example

{
 "id": "depots/zeOCJaJCzZhpKVCVAC9o",
 "name": "Depot 1",
}

Properties

Property	Type	Description
id	DepotId	This depot's unique identifier in the API.
name	string	This depot's name.
routeOverrides	DepotRouteOverrides | null	Defaults given to routes originating from this depot.

Identifier

DepotId

DepotId = `depots/${string}`

A depot id is a string that is unique for a depot. It is used to identify the depot in the API.

Example

"depot/0xBYy4MYt4piMCSQEsts"

Type Aliases

DepotRouteOverrides

DepotRouteOverrides = object

Properties

Property	Type	Description
startTime	TimeOfDay	The default start time given to routes originating from this depot.
startAddress	DepotAddress	The location of the depot, this will be used as the default start address for routes originating from this depot.
endAddress?	DepotAddress | null	For non-round-trip routes, the end address will be used for the end stop. Optional. Default null
endTime?	TimeOfDay | null	The default end time given to routes originating from this depot. Default null
defaultTimeAtStop?	number | null	Estimated time at the stop. Default null
maxStops?	number | null	Maximum number of stops per driver. Note: Premium only feature. Default null
vehicleType?	VehicleType | null	Default vehicle type. Note: Premium only feature. Default 'car'
roadSide?	RoadSideOption | null	Default side of road. Note: Premium only feature. Default 'any'
roundTrip?	boolean | null	Return to start address at end of route. Default true

---

DepotAddress

DepotAddress = object

Properties

Property	Type	Description
address	string | null	The full address of the stop.
addressLineOne	string | null	First line of the address. Default ''
addressLineTwo	string | null	Second line of the address. Default ''
latitude	number | null	Latitude coordinate of the stop location in decimal degrees. Default null
longitude	number | null	Longitude coordinate of the stop location in decimal degrees. Default null
placeId	string | null	The identifier of the Place corresponding to this stop on Google Places. Default null
countryCode	string | null	The country code of the address.

---

RoadSideOption

RoadSideOption = "any" | "left_only" | "right_only"