TRANXACT.AI Help

Supply Chain · Load Building

Vehicles

One actual vehicle, owned, leased or the carrier’s. The compliance dates sit on the master because each of them expiring grounds it.

Type REST6 operationsBase path /api/scm/vehiclesPublished as /api/v1/vehicles

Download specification (OpenAPI 3.1) Screen: Vehicles

Overview

PackageSupply Chain
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Supply Chain › Vehicles on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tablescm.vehicles · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/scm/vehiclesList vehicles

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "vehicle_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "ownership": "owned",
      "registration_no": "REG-000001",
      "vin": "text",
      "trailer_no": "TRA-000001",
      "home_location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "fixed_asset_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "current_lat": "1250.00",
      "current_lon": "1250.00"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/vehicles?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/vehicles/{id}Read one vehicles

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "vehicle_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ownership": "owned",
  "registration_no": "REG-000001",
  "vin": "text",
  "trailer_no": "TRA-000001",
  "home_location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fixed_asset_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "current_lat": "1250.00",
  "current_lon": "1250.00"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/scm/vehicles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/vehiclesCreate a vehicles

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextNoName
vehicle_type_iduuidYesType
carrier_iduuidNoCarrier
ownershiptextNoOwnership
Allowed: owned leased carrier subcontracted rented
registration_notextNoRegistration
vintextNoVIN
trailer_notextNoTrailer number
home_location_iduuidNoBased at
fixed_asset_iduuidNoFixed asset — Where finance capitalized it. A vehicle on the balance sheet should not be a second record nobody reconciles.
odometer_kmnumericNoOdometer (km)
insurance_expires_ondateNoInsurance expires
inspection_due_ondateNoInspection due
registration_expires_ondateNoRegistration expires
next_service_kmnumericNoNext service at (km)
next_service_ondateNoNext service on
statustextNoStatus
Allowed: available assigned in_transit loading unloading maintenance out_of_service retired
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "vehicle_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "name": "Example",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ownership": "owned",
  "registration_no": "REG-000001"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "vehicle_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ownership": "owned",
  "registration_no": "REG-000001",
  "vin": "text",
  "trailer_no": "TRA-000001",
  "home_location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fixed_asset_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "current_lat": "1250.00",
  "current_lon": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/vehicles" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","vehicle_type_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name":"Example","carrier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","ownership":"owned","registration_no":"REG-000001"}'
PUT/api/scm/vehicles/{id}Change a vehicles

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesCode
nametextNoName
vehicle_type_iduuidYesType
carrier_iduuidNoCarrier
ownershiptextNoOwnership
Allowed: owned leased carrier subcontracted rented
registration_notextNoRegistration
vintextNoVIN
trailer_notextNoTrailer number
home_location_iduuidNoBased at
fixed_asset_iduuidNoFixed asset — Where finance capitalized it. A vehicle on the balance sheet should not be a second record nobody reconciles.
odometer_kmnumericNoOdometer (km)
insurance_expires_ondateNoInsurance expires
inspection_due_ondateNoInspection due
registration_expires_ondateNoRegistration expires
next_service_kmnumericNoNext service at (km)
next_service_ondateNoNext service on
statustextNoStatus
Allowed: available assigned in_transit loading unloading maintenance out_of_service retired
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "vehicle_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "vehicle_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ownership": "owned",
  "registration_no": "REG-000001",
  "vin": "text",
  "trailer_no": "TRA-000001",
  "home_location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fixed_asset_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "current_lat": "1250.00",
  "current_lon": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/vehicles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","vehicle_type_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/scm/vehicles/{id}Delete a vehicles

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/scm/vehicles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/vehicles/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/vehicles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a vehicles, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode
nametextread, writeName
vehicle_type_iduuidread, writeType
carrier_iduuidread, writeCarrier
ownershiptextread, writeOwnership
Allowed: owned leased carrier subcontracted rented
registration_notextread, writeRegistration
vintextread, writeVIN
trailer_notextread, writeTrailer number
home_location_iduuidread, writeBased at
fixed_asset_iduuidread, writeFixed asset — Where finance capitalized it. A vehicle on the balance sheet should not be a second record nobody reconciles.
current_latnumericread onlyCurrent lat
current_lonnumericread onlyCurrent lon
current_speed_kphnumericread onlyCurrent speed kph
heading_degnumericread onlyHeading deg
position_attimestamp with time zoneread onlyPosition at
odometer_kmnumericread, writeOdometer (km)
fuel_level_pctnumericread onlyFuel level pct
temperature_cnumericread onlyTemperature c
insurance_expires_ondateread, writeInsurance expires
inspection_due_ondateread, writeInspection due
registration_expires_ondateread, writeRegistration expires
next_service_kmnumericread, writeNext service at (km)
next_service_ondateread, writeNext service on
statustextread, writeStatus
Allowed: available assigned in_transit loading unloading maintenance out_of_service retired
is_activebooleanread, writeActive
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Supply Chain › Vehicles for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.