Dashboard – Car rental vehicles (v1)

Base path

/api/v1/workspace/:workspaceId/carrental

Actual path: /v1/workspace/:workspaceId/carrental/...

All endpoints below require workspace JWT and staff permission carrental.manage.

Endpoints

Method	Path	Description
GET	/:workspaceId/carrental/vehicles	List vehicles (query: status, branchId, categoryId, page, limit).
POST	/:workspaceId/carrental/vehicles	Create vehicle (body: branchId, categoryId, brand, model, year, plateNumber, color, transmission, fuelType, seats, dailyPrice, specs).
GET	/:workspaceId/carrental/vehicles/:id	Get vehicle by ID.
PATCH	/:workspaceId/carrental/vehicles/:id	Update vehicle.
DELETE	/:workspaceId/carrental/vehicles/:id	Delete vehicle.
POST	/:workspaceId/carrental/vehicles/:id/photos	Upload vehicle photo (multipart, field photo).

List vehicles – Response 200

{
  "items": [{ "id": "...", "brand": "Toyota", "model": "Corolla", "year": 2023, "dailyPrice": 150, "status": "AVAILABLE", ... }],
  "total": 10,
  "page": 1,
  "limit": 20
}

Create vehicle – Request body

Field	Type	Required	Description
branchId	string	Yes	Branch ID.
categoryId	string	Yes	Vehicle category ID.
brand	string	Yes	Brand name.
model	string	Yes	Model name.
year	number	Yes	Year (≥1900).
plateNumber	string	Yes	Plate number.
color	string	Yes	Color.
transmission	string	Yes	AUTO or MANUAL.
fuelType	string	Yes	GAS, HYBRID, or ELECTRIC.
seats	number	Yes	Number of seats (≥1).
dailyPrice	number	Yes	Daily price (≥0).
specs	object	No	e.g. doors, bags, features.

Common errors

• 400: Validation failed.
• 401: Unauthorized.
• 403: Forbidden – no carrental.manage.
• 404: Vehicle or workspace not found.
• 500: Server error.