Supply Chain · Load Building
Drivers
Who drives. The hours are the point: a driver out of hours is a load that does not go, and scheduling a run that breaks the rules is the most expensive mistake a transport planner can make.
/api/scm/driversPublished as /api/v1/driversOverview
| Package | Supply Chain |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Supply Chain › Drivers 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. |
| Table | scm.drivers · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The 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/driversList drivers
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"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",
"first_name": "Example",
"last_name": "Example",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"phone": "+1 555 0100",
"email": "someone@example.com",
"licence_no": "LIC-000001",
"licence_class": "text",
"licence_expires_on": "2026-10-30",
"cpc_expires_on": "2026-10-30",
"adr_certified": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/drivers?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/drivers/{id}Read one drivers
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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",
"first_name": "Example",
"last_name": "Example",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"phone": "+1 555 0100",
"email": "someone@example.com",
"licence_no": "LIC-000001",
"licence_class": "text",
"licence_expires_on": "2026-10-30",
"cpc_expires_on": "2026-10-30",
"adr_certified": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/drivers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/driversCreate a drivers
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
first_name | text | Yes | First name |
last_name | text | Yes | Last name |
employee_id | uuid | No | Employee |
carrier_id | uuid | No | Carrier |
phone | text | No | Telephone |
email | text | No | |
licence_no | text | No | License number |
licence_class | text | No | License class |
licence_expires_on | date | No | License expires |
cpc_expires_on | date | No | Driver qualification expires |
adr_certified | boolean | No | Certified for dangerous goods |
adr_expires_on | date | No | Dangerous goods certificate expires |
medical_expires_on | date | No | Medical expires |
max_daily_drive_hours | numeric | No | Maximum driving hours a day |
max_weekly_drive_hours | numeric | No | Maximum driving hours a week |
home_location_id | uuid | No | Based at |
cost_per_hour | numeric | No | Cost an hour |
currency | text | No | Currency |
status | text | No | Status Allowed: available driving resting on_leave training unavailable terminated |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"code": "COD-000001",
"first_name": "Example",
"last_name": "Example",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"phone": "+1 555 0100",
"email": "someone@example.com"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"first_name": "Example",
"last_name": "Example",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"phone": "+1 555 0100",
"email": "someone@example.com",
"licence_no": "LIC-000001",
"licence_class": "text",
"licence_expires_on": "2026-10-30",
"cpc_expires_on": "2026-10-30",
"adr_certified": true
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/drivers" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","first_name":"Example","last_name":"Example","employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","carrier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","phone":"+1 555 0100","email":"someone@example.com"}'PUT/api/scm/drivers/{id}Change a drivers
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
first_name | text | Yes | First name |
last_name | text | Yes | Last name |
employee_id | uuid | No | Employee |
carrier_id | uuid | No | Carrier |
phone | text | No | Telephone |
email | text | No | |
licence_no | text | No | License number |
licence_class | text | No | License class |
licence_expires_on | date | No | License expires |
cpc_expires_on | date | No | Driver qualification expires |
adr_certified | boolean | No | Certified for dangerous goods |
adr_expires_on | date | No | Dangerous goods certificate expires |
medical_expires_on | date | No | Medical expires |
max_daily_drive_hours | numeric | No | Maximum driving hours a day |
max_weekly_drive_hours | numeric | No | Maximum driving hours a week |
home_location_id | uuid | No | Based at |
cost_per_hour | numeric | No | Cost an hour |
currency | text | No | Currency |
status | text | No | Status Allowed: available driving resting on_leave training unavailable terminated |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"code": "COD-000001",
"first_name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"first_name": "Example",
"last_name": "Example",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"phone": "+1 555 0100",
"email": "someone@example.com",
"licence_no": "LIC-000001",
"licence_class": "text",
"licence_expires_on": "2026-10-30",
"cpc_expires_on": "2026-10-30",
"adr_certified": true
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/drivers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","first_name":"Example"}'DELETE/api/scm/drivers/{id}Delete a drivers
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/drivers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/drivers/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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/drivers/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 drivers, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
code | text | read, write | Code |
first_name | text | read, write | First name |
last_name | text | read, write | Last name |
employee_id | uuid | read, write | Employee |
carrier_id | uuid | read, write | Carrier |
phone | text | read, write | Telephone |
email | text | read, write | |
licence_no | text | read, write | License number |
licence_class | text | read, write | License class |
licence_expires_on | date | read, write | License expires |
cpc_expires_on | date | read, write | Driver qualification expires |
adr_certified | boolean | read, write | Certified for dangerous goods |
adr_expires_on | date | read, write | Dangerous goods certificate expires |
medical_expires_on | date | read, write | Medical expires |
max_daily_drive_hours | numeric | read, write | Maximum driving hours a day |
max_weekly_drive_hours | numeric | read, write | Maximum driving hours a week |
hours_driven_today | numeric | read only | Hours driven today |
hours_driven_week | numeric | read only | Hours driven week |
last_rest_ended_at | timestamp with time zone | read only | Last rest ended at |
home_location_id | uuid | read, write | Based at |
cost_per_hour | numeric | read, write | Cost an hour |
currency | text | read, write | Currency |
status | text | read, write | Status Allowed: available driving resting on_leave training unavailable terminated |
is_active | boolean | read, write | Active |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Supply Chain › Drivers for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.