TRANXACT.AI Help

Supply Chain · Freight Management

Routes

The drawn line and the plan behind it. Sequencing the stops is nearest-neighbour with time windows pulling a stop forward: crude, fast, and typically within a fifth of optimal on a delivery round.

Type REST7 operationsBase path /api/scm/transport-routesPublished as /api/v1/transport-routes

Download specification (OpenAPI 3.1) Screen: Routes

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 › Routes 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.transport_routes · 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

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

GET/api/scm/transport-routesList routes

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",
      "route_no": "ROU-000001",
      "name": "Example",
      "route_type": "delivery",
      "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "vehicle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "driver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "is_recurring": true,
      "recurrence": "text",
      "route_date": "2026-10-30",
      "planned_start_at": "2026-10-30T09:00:00Z",
      "planned_end_at": "2026-10-30T09:00:00Z",
      "actual_start_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "route_no": "ROU-000001",
  "name": "Example",
  "route_type": "delivery",
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "vehicle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "driver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_recurring": true,
  "recurrence": "text",
  "route_date": "2026-10-30",
  "planned_start_at": "2026-10-30T09:00:00Z",
  "planned_end_at": "2026-10-30T09:00:00Z",
  "actual_start_at": "2026-10-30T09:00:00Z"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
nametextYesName
route_typetextNoType
Allowed: delivery collection milk_run shuttle line_haul backhaul service
load_iduuidNoLoad
vehicle_iduuidNoVehicle
driver_iduuidNoDriver
is_recurringbooleanNoRuns again
recurrencetextNoHow often
route_datedateNoDate
planned_start_attimestamp with time zoneNoPlanned start
planned_end_attimestamp with time zoneNoPlanned end
actual_start_attimestamp with time zoneNoActual start
actual_end_attimestamp with time zoneNoActual end
distance_kmnumericNoDistance (km)
drive_minutesnumericNoDriving minutes
service_minutesnumericNoMinutes on site
optimizationtextNoSequenced by
Allowed: none shortest fastest least_cost balanced time_windows manual
planned_costnumericNoPlanned cost
actual_costnumericNoActual cost
currencytextNoCurrency
co2_kgnumericNoCO2 (kg)
notestextNoNotes

Sample body

{
  "name": "Example",
  "route_type": "delivery",
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "vehicle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "driver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "route_no": "ROU-000001",
  "name": "Example",
  "route_type": "delivery",
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "vehicle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "driver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_recurring": true,
  "recurrence": "text",
  "route_date": "2026-10-30",
  "planned_start_at": "2026-10-30T09:00:00Z",
  "planned_end_at": "2026-10-30T09:00:00Z",
  "actual_start_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/transport-routes" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","route_type":"delivery","load_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","vehicle_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","driver_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/scm/transport-routes/{id}Change a transport route

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
nametextYesName
route_typetextNoType
Allowed: delivery collection milk_run shuttle line_haul backhaul service
load_iduuidNoLoad
vehicle_iduuidNoVehicle
driver_iduuidNoDriver
is_recurringbooleanNoRuns again
recurrencetextNoHow often
route_datedateNoDate
planned_start_attimestamp with time zoneNoPlanned start
planned_end_attimestamp with time zoneNoPlanned end
actual_start_attimestamp with time zoneNoActual start
actual_end_attimestamp with time zoneNoActual end
distance_kmnumericNoDistance (km)
drive_minutesnumericNoDriving minutes
service_minutesnumericNoMinutes on site
optimizationtextNoSequenced by
Allowed: none shortest fastest least_cost balanced time_windows manual
planned_costnumericNoPlanned cost
actual_costnumericNoActual cost
currencytextNoCurrency
co2_kgnumericNoCO2 (kg)
notestextNoNotes

Sample body

{
  "name": "Example",
  "route_type": "delivery"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "route_no": "ROU-000001",
  "name": "Example",
  "route_type": "delivery",
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "vehicle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "driver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_recurring": true,
  "recurrence": "text",
  "route_date": "2026-10-30",
  "planned_start_at": "2026-10-30T09:00:00Z",
  "planned_end_at": "2026-10-30T09:00:00Z",
  "actual_start_at": "2026-10-30T09:00:00Z"
}

Sample request

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

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/transport-routes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/transport-routes/{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/transport-routes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/scm/transport-routes/{id}/optimizeOptimize

Path parameters

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

No body is required.

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/transport-routes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/optimize" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a transport route, 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
route_notextread onlyRoute no
nametextread, writeName
route_typetextread, writeType
Allowed: delivery collection milk_run shuttle line_haul backhaul service
load_iduuidread, writeLoad
vehicle_iduuidread, writeVehicle
driver_iduuidread, writeDriver
is_recurringbooleanread, writeRuns again
recurrencetextread, writeHow often
route_datedateread, writeDate
planned_start_attimestamp with time zoneread, writePlanned start
planned_end_attimestamp with time zoneread, writePlanned end
actual_start_attimestamp with time zoneread, writeActual start
actual_end_attimestamp with time zoneread, writeActual end
stop_countintegerread onlyStop count
distance_kmnumericread, writeDistance (km)
drive_minutesnumericread, writeDriving minutes
service_minutesnumericread, writeMinutes on site
polylinejsonbread onlyPolyline
optimizationtextread, writeSequenced by
Allowed: none shortest fastest least_cost balanced time_windows manual
planned_costnumericread, writePlanned cost
actual_costnumericread, writeActual cost
currencytextread, writeCurrency
co2_kgnumericread, writeCO2 (kg)
statustextread onlyStatus
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 › Routes 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.