Vehicle functions

Vehicle Functions describe the functions a Vehicle can perform.

Supported Vehicle Functions are available via the following API request:

GET /api/beta/vehicle-functions

Example response:

{
	"vehicle_functions": [
		{
			"key": "passenger",
			"description": "Passenger transport"
		},
		{
			"key": "parcel",
			"description": "Courier service"
		}
	]
}
  • vehicle_functions - (array) List of supported vehicle functions
  • vehicle_functions[].key - (string) The Vehicle Function key that should be used in other APIs
  • vehicle_functions[].description - (string) Short human readable description of the Vehicle Function

It is recommended that your application periodically refresh any local caches of this information from this API, to ensure you are working with the most up-to-date data.

See also