TRANXACT.AI Help

Supply Chain · Load Building

Vehicle Types

The kinds of vehicle a plan may use. The inside dimensions are the load builder’s canvas: it draws exactly that rectangle and fits pallets into it.

Type REST6 operationsBase path /api/scm/vehicle-typesPublished as /api/v1/vehicle-types

Download specification (OpenAPI 3.1) Screen: Vehicle Types

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 › Vehicle Types 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.vehicle_types · 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/vehicle-typesList vehicle types

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",
      "code": "COD-000001",
      "name": "Example",
      "category": "text",
      "inner_length_mm": "1250.00",
      "inner_width_mm": "1250.00",
      "inner_height_mm": "1250.00",
      "door_width_mm": "1250.00",
      "door_height_mm": "1250.00",
      "max_payload_kg": "1250.00",
      "tare_weight_kg": "1250.00",
      "max_gross_kg": "1250.00",
      "max_volume_l": "1250.00",
      "max_pallets": 10
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "category": "text",
  "inner_length_mm": "1250.00",
  "inner_width_mm": "1250.00",
  "inner_height_mm": "1250.00",
  "door_width_mm": "1250.00",
  "door_height_mm": "1250.00",
  "max_payload_kg": "1250.00",
  "tare_weight_kg": "1250.00",
  "max_gross_kg": "1250.00",
  "max_volume_l": "1250.00",
  "max_pallets": 10
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
categorytextNoCategory
inner_length_mmnumericNoInside length (mm)
inner_width_mmnumericNoInside width (mm)
inner_height_mmnumericNoInside height (mm)
door_width_mmnumericNoDoor width (mm)
door_height_mmnumericNoDoor height (mm)
max_payload_kgnumericNoMaximum payload (kg)
tare_weight_kgnumericNoTare weight (kg)
max_gross_kgnumericNoMaximum gross (kg)
max_volume_lnumericNoMaximum volume (L)
max_palletsintegerNoFloor pallet positions
pallet_patterntextNoPallet pattern
Allowed: straight turned pinwheel mixed
axle_countintegerNoAxles
max_axle_weight_kgnumericNoMaximum axle weight (kg) — A trailer within its payload can still be over on the drive axle if everything heavy is at the front. This is what the builder checks.
load_fromtextNoLoaded from
Allowed: rear side top rear_and_side any
has_tail_liftbooleanNoHas a tail lift
is_temperature_controlledbooleanNoTemperature controlled
temperature_min_cnumericNoMinimum temperature (C)
temperature_max_cnumericNoMaximum temperature (C)
cost_per_kmnumericNoCost per km
cost_per_hournumericNoCost per hour
fixed_costnumericNoFixed cost a trip
currencytextNoCurrency
co2_g_per_kmnumericNoCO2 grams per km
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "category": "text",
  "inner_length_mm": "1250.00",
  "inner_width_mm": "1250.00",
  "inner_height_mm": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "category": "text",
  "inner_length_mm": "1250.00",
  "inner_width_mm": "1250.00",
  "inner_height_mm": "1250.00",
  "door_width_mm": "1250.00",
  "door_height_mm": "1250.00",
  "max_payload_kg": "1250.00",
  "tare_weight_kg": "1250.00",
  "max_gross_kg": "1250.00",
  "max_volume_l": "1250.00",
  "max_pallets": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/vehicle-types" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","category":"text","inner_length_mm":"1250.00","inner_width_mm":"1250.00","inner_height_mm":"1250.00"}'
PUT/api/scm/vehicle-types/{id}Change a vehicle type

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
nametextYesName
categorytextNoCategory
inner_length_mmnumericNoInside length (mm)
inner_width_mmnumericNoInside width (mm)
inner_height_mmnumericNoInside height (mm)
door_width_mmnumericNoDoor width (mm)
door_height_mmnumericNoDoor height (mm)
max_payload_kgnumericNoMaximum payload (kg)
tare_weight_kgnumericNoTare weight (kg)
max_gross_kgnumericNoMaximum gross (kg)
max_volume_lnumericNoMaximum volume (L)
max_palletsintegerNoFloor pallet positions
pallet_patterntextNoPallet pattern
Allowed: straight turned pinwheel mixed
axle_countintegerNoAxles
max_axle_weight_kgnumericNoMaximum axle weight (kg) — A trailer within its payload can still be over on the drive axle if everything heavy is at the front. This is what the builder checks.
load_fromtextNoLoaded from
Allowed: rear side top rear_and_side any
has_tail_liftbooleanNoHas a tail lift
is_temperature_controlledbooleanNoTemperature controlled
temperature_min_cnumericNoMinimum temperature (C)
temperature_max_cnumericNoMaximum temperature (C)
cost_per_kmnumericNoCost per km
cost_per_hournumericNoCost per hour
fixed_costnumericNoFixed cost a trip
currencytextNoCurrency
co2_g_per_kmnumericNoCO2 grams per km
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "category": "text",
  "inner_length_mm": "1250.00",
  "inner_width_mm": "1250.00",
  "inner_height_mm": "1250.00",
  "door_width_mm": "1250.00",
  "door_height_mm": "1250.00",
  "max_payload_kg": "1250.00",
  "tare_weight_kg": "1250.00",
  "max_gross_kg": "1250.00",
  "max_volume_l": "1250.00",
  "max_pallets": 10
}

Sample request

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

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/vehicle-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/vehicle-types/{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/vehicle-types/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 vehicle type, 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
codetextread, writeCode
nametextread, writeName
categorytextread, writeCategory
inner_length_mmnumericread, writeInside length (mm)
inner_width_mmnumericread, writeInside width (mm)
inner_height_mmnumericread, writeInside height (mm)
door_width_mmnumericread, writeDoor width (mm)
door_height_mmnumericread, writeDoor height (mm)
max_payload_kgnumericread, writeMaximum payload (kg)
tare_weight_kgnumericread, writeTare weight (kg)
max_gross_kgnumericread, writeMaximum gross (kg)
max_volume_lnumericread, writeMaximum volume (L)
max_palletsintegerread, writeFloor pallet positions
pallet_patterntextread, writePallet pattern
Allowed: straight turned pinwheel mixed
axle_countintegerread, writeAxles
max_axle_weight_kgnumericread, writeMaximum axle weight (kg) — A trailer within its payload can still be over on the drive axle if everything heavy is at the front. This is what the builder checks.
load_fromtextread, writeLoaded from
Allowed: rear side top rear_and_side any
has_tail_liftbooleanread, writeHas a tail lift
is_temperature_controlledbooleanread, writeTemperature controlled
temperature_min_cnumericread, writeMinimum temperature (C)
temperature_max_cnumericread, writeMaximum temperature (C)
cost_per_kmnumericread, writeCost per km
cost_per_hournumericread, writeCost per hour
fixed_costnumericread, writeFixed cost a trip
currencytextread, writeCurrency
co2_g_per_kmnumericread, writeCO2 grams per km
is_activebooleanread, writeActive
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
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 › Vehicle Types 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.