Operations

Vehicle

Fleet vehicle.

Schemas: VehicleDto

{
  "id": "id_8f2a1c",
  "name": "Example",
  "status": "active",
  "registrationNumber": "string",
  "seats": 1,
  "payloadKg": 1,
  "inspectionDate": "2026-09-01T08:00:00Z",
  "collectionId": "string",
  "collectionName": "Example",
  "showInPlanner": true,
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}

Generated from the schema

A vehicle of the delivery fleet, with its registration, seats, payload, inspection date and collection. The cost per kilometer and the fixed cost are not part of the public contract. Vehicles are bounded to the subscription that owns the key.

Attributes

idstring

Unique vehicle identifier.

namestring

Vehicle name.

statusstring

Operational status: active (available), maintenance (in the workshop) or inactive (out of service).

Available options: active, maintenance, inactive

registrationNumberstring | null

Registration number; null if not recorded.

seatsnumber | null

Seats, including the driver seat; null if not recorded.

payloadKgnumber | null

Payload in kilograms; null if not recorded.

inspectionDatestring<date-time> | null

Date of the next technical inspection in ISO 8601 UTC; null if not recorded.

collectionIdstring | null

Identifier of the collection it belongs to; null if it is in none.

collectionNamestring | null

Collection path; null if not applicable.

showInPlannerboolean

true if it appears in the planner of the account.

createdAtstring<date-time> | null

Creation date in ISO 8601 UTC; null if not recorded.

updatedAtstring<date-time> | null

Last modification date in ISO 8601 UTC; null if not recorded.

Values

status: active, maintenance, inactive

Returned by

GET /api/v1/vehicles — List vehicles
GET /api/v1/vehicles/{vehicleId} — Get a vehicle

Modified by

POST /api/v1/vehicles — Create a vehicle
PATCH /api/v1/vehicles/{vehicleId} — Update a vehicle

Was this page helpful?