Skip to main content
_id
string

An unique identifier for the vehicle record, often used for database or system reference.

name
string

The name of vehicle. User can define vehicle name with vehicle's license plate, vehicle brand, or something else.

assignee
string

Users's email that assigned to the vehicle. One vehicle can only be assigned by one worker.

speed
string

Assume the average speed (in km/h) of the vehicle.Speed cannot be less than 5 km/h.

fixedCost
integer

The Cost Factor value range is set from 0 to 100, with the default value being 0. A lower number signifies a higher priority for routing optimization purposes.

tags
string[]

The tag is used for route optimization purposes. Visits that have tags will be assigned to vehicles that have the same tags.

oddEven
enum<string>

Odd-even license plate restriction category for this vehicle. Used to enforce odd-even traffic restrictions during specified time windows. Accepted values are 'odd' for odd-numbered plates or 'even' for even-numbered plates.

Available options:
odd,
even
workingTime
object[]

Working hours on vehicles containing: startTime, endTime, and multiday.

breakTime
object[]

Indicates that the data inside represents the break time for the vehicle. containing: startTime, and endTime.

capacity
object[]

Capacity is used for route optimization purposes, it's dynamic based on user needs. It has minimum and maximum value as the limit for the shelter that can be accommodated by the vehicle.

hubs
object[]

Indicates that the data inside represents the break time for the vehicle. containing: startTime, and endTime.

hubId
string

Identifier for the hub that owns or manages the vehicle.

organizationId
string

Identifier for the organization or company that owns or manages the vehicle.

updatedTime
string

Timestamp represents the last time the vehicle data was updated. It includes date and time information.

createdTime
string

Timestamp represents the date and time when this vehicle data was initially created.