Skip to content
aimrack

Vehicle

The vehicle resource.

Base/vehicle
GET/vehicle

List vehicles

Retrieve a paginated list of vehicles. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/vehicle
curl --request GET \
  --url '<your-host>/vehicle?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "kind": "string",
    "status": "string",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "updatedAt": "2026-01-01T00:00:00Z",
    "name": "Example"
  }
]
GET/vehicle

Retrieve a vehicle

Fetch a single vehicle by filtering on `id`.

Query parameters

idstring

Match on the vehicle's `id`, e.g. `eq.{id}`.

GET/vehicle
curl --request GET \
  --url '<your-host>/vehicle?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "kind": "string",
  "status": "string",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "name": "Example"
}
POST/vehicle

Create a vehicle

Create a new vehicle.

Body parameters

companyIdstringrequired

References company.id

kindstringrequired
capacityGalnumber
grossWeightLoadedLbsnumber
mpgnumber
platestring
dotNumberstring
inServiceFromdate
inServiceTodate
statusstringrequired
namestring
locationIdstring

The plant this truck runs from. Routing refuses a fleet without one.

POST/vehicle
curl --request POST \
  --url <your-host>/vehicle \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789","kind":"string","status":"string","name":"Example"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "kind": "string",
  "status": "string",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "name": "Example"
}
PATCH/vehicle

Update a vehicle

Update an existing vehicle, matched on `id`.

Body parameters

companyIdstringrequired

References company.id

kindstringrequired
capacityGalnumber
grossWeightLoadedLbsnumber
mpgnumber
platestring
dotNumberstring
inServiceFromdate
inServiceTodate
statusstringrequired
namestring
locationIdstring

The plant this truck runs from. Routing refuses a fleet without one.

PATCH/vehicle
curl --request PATCH \
  --url '<your-host>/vehicle?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "kind": "string",
  "status": "string",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "name": "Example"
}
DELETE/vehicle

Delete a vehicle

Delete a vehicle, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the vehicle to delete, e.g. `eq.{id}`.

DELETE/vehicle
curl --request DELETE \
  --url '<your-host>/vehicle?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content