Vehicle object

Internal vehicle object with comprehensive details for system administration and operations

_id

string

required

Unique identifier for the vehicle (MongoDB ObjectId)

Example:

"65c1f68ea735b522d370ea22"

organizationId

string

required

Organization identifier that owns this vehicle

Example:

"65c1f4eeca7c4816d94587b2"

hubId

string

required

Hub identifier where vehicle is assigned

Example:

"65c1f68ea735b522d370ea25"

name

string

required

Vehicle name or identifier

Example:

"Truck-01"

status

enum<string>

required

Current vehicle status

Available options:

active,

inactive,

maintenance,

assigned

Example:

"active"

inputType

string

The input type of the component (e.g., string, number, date, etc.)

licensePlate

string

Vehicle license plate number

Example:

"B 1234 XYZ"

capacity

object

Vehicle capacity constraints

Show child attributes

capacity.weight

number

Maximum weight capacity in kg

Example:

1000

capacity.volume

number

Maximum volume capacity in cubic meters

Example:

10.5

assigneeId

string

ID of assigned driver/operator

Example:

"65c1f68ea735b522d370ea26"

assignee

object

Assigned driver information

Show child attributes

assignee.id

string

Driver user ID

assignee.name

string

Driver full name

assignee.email

string

Driver email address

tags

string[]

Vehicle classification tags

Example:

["refrigerated", "express"]

workingHours

object

Vehicle operating hours configuration

Show child attributes

workingHours.start

string

Daily start time

Example:

"08:00"

workingHours.end

string

Daily end time

Example:

"17:00"

workingHours.timezone

string

Timezone for working hours

Example:

"Asia/Jakarta"

coordinates

object

Current vehicle location

Show child attributes

coordinates.latitude

number<float>

Latitude coordinate

Example:

-6.2088

coordinates.longitude

number<float>

Longitude coordinate

Example:

106.8456

createdBy

string

Email of user who created this vehicle record

Example:

"admin@mile.app"

updatedBy

string

Email of user who last updated this vehicle

Example:

"admin@mile.app"

createdTime

string<date-time>

ISO 8601 timestamp when vehicle was created

Example:

"2024-02-06T08:15:30.000000Z"

updatedTime

string<date-time>

ISO 8601 timestamp when vehicle was last updated

Example:

"2024-02-06T14:20:15.000000Z"

internalNotes

string

Internal administrative notes (not visible to public API)

Example:

"Vehicle requires weekly maintenance check"

auditLog

object[]

Internal audit trail for vehicle changes

Show child attributes

auditLog.action

string

auditLog.timestamp

string<date-time>

auditLog.userId

string

auditLog.changes

object

systemMetadata

object

Internal system metadata for debugging and monitoring

Show child attributes

systemMetadata.lastSyncTime

string<date-time>

systemMetadata.dataVersion

integer

systemMetadata.migrationStatus

string

failedCode

enum<string>

Vehicle Module business failedCode that indicate specific failure conditions or business rule violations during vehicle module operations. These codes help identify the failed operation of vehicle-related and provide standardized failure identification across the system.

Possible values:

vehic-032: Invalid state/condition - Vehicle state transition invalid
vehic-033: Vehicle not found - Vehicle record does not exist
vehic-035: Access forbidden - User lacks vehicle permission
vehic-036: Invalid hub assignment - Vehicle assigned to invalid hub
vehic-037: Invalid assignee - Invalid driver/user assignment
vehic-040: Limit exceeded - Vehicle limit exceeded

Available options:

vehic-032,

vehic-033,

vehic-035,

vehic-036,

vehic-037,

vehic-040

Getting Started

Webhook

Task

Routing

Flow

Data

Setting

File

Billing

Dashboard

Authentication

Reference

Internal Tools

Objects