Supply Chain · Load Building
Loads
One vehicle worth of freight. Utilization is the whole point: a trailer at sixty per cent is forty per cent of the freight bill spent carrying air.
/api/scm/loadsPublished as /api/v1/loadsOverview
| 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 › Loads 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.loads · 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
19 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/loadsList loads
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",
"load_no": "LOA-000001",
"name": "Example",
"load_type": "text",
"vehicle_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"vehicle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"driver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"trailer_no": "TRA-000001",
"seal_no": "SEA-000001",
"origin_place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"destination_place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/loads?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/loads/{id}Read one loads
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",
"load_no": "LOA-000001",
"name": "Example",
"load_type": "text",
"vehicle_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"vehicle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"driver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"trailer_no": "TRA-000001",
"seal_no": "SEA-000001",
"origin_place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"destination_place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/loadsCreate a loads
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | No | Name |
load_type | text | No | Type |
vehicle_type_id | uuid | No | Vehicle type — The deck the builder draws. A load with no vehicle type has no canvas to be arranged on. |
vehicle_id | uuid | No | Vehicle |
driver_id | uuid | No | Driver |
carrier_id | uuid | No | Carrier |
carrier_service_id | uuid | No | Service |
trailer_no | text | No | Trailer number |
seal_no | text | No | Seal number |
origin_place_id | uuid | No | From |
destination_place_id | uuid | No | To |
warehouse_id | uuid | No | Loaded at |
door_id | uuid | No | Door |
planned_depart_at | timestamp with time zone | No | Planned departure |
planned_arrive_at | timestamp with time zone | No | Planned arrival |
actual_depart_at | timestamp with time zone | No | Actual departure |
actual_arrive_at | timestamp with time zone | No | Actual arrival |
distance_km | numeric | No | Distance (km) |
planned_cost | numeric | No | Planned cost |
actual_cost | numeric | No | Actual cost |
currency | text | No | Currency |
cost_center_id | uuid | No | Cost center |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"load_type": "text",
"vehicle_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"vehicle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"load_no": "LOA-000001",
"name": "Example",
"load_type": "text",
"vehicle_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"vehicle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"driver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"trailer_no": "TRA-000001",
"seal_no": "SEA-000001",
"origin_place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"destination_place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/loads" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","load_type":"text","vehicle_type_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","vehicle_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/scm/loads/{id}Change a loads
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 |
|---|---|---|---|
name | text | No | Name |
load_type | text | No | Type |
vehicle_type_id | uuid | No | Vehicle type — The deck the builder draws. A load with no vehicle type has no canvas to be arranged on. |
vehicle_id | uuid | No | Vehicle |
driver_id | uuid | No | Driver |
carrier_id | uuid | No | Carrier |
carrier_service_id | uuid | No | Service |
trailer_no | text | No | Trailer number |
seal_no | text | No | Seal number |
origin_place_id | uuid | No | From |
destination_place_id | uuid | No | To |
warehouse_id | uuid | No | Loaded at |
door_id | uuid | No | Door |
planned_depart_at | timestamp with time zone | No | Planned departure |
planned_arrive_at | timestamp with time zone | No | Planned arrival |
actual_depart_at | timestamp with time zone | No | Actual departure |
actual_arrive_at | timestamp with time zone | No | Actual arrival |
distance_km | numeric | No | Distance (km) |
planned_cost | numeric | No | Planned cost |
actual_cost | numeric | No | Actual cost |
currency | text | No | Currency |
cost_center_id | uuid | No | Cost center |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"load_type": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"load_no": "LOA-000001",
"name": "Example",
"load_type": "text",
"vehicle_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"vehicle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"driver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"trailer_no": "TRA-000001",
"seal_no": "SEA-000001",
"origin_place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"destination_place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","load_type":"text"}'DELETE/api/scm/loads/{id}Delete a loads
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/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/loads/{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/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/scm/loads/{id}/planPlan
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/plan" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/loads/{id}/placePlace
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):
itemId*, xMm, yMm, zMm, isRotated, stackLevel, stopIdResponse
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/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/place" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"itemId":"value","xMm":"value","yMm":"value","zMm":"value","isRotated":"value","stackLevel":"value"}'POST/api/scm/loads/{id}/arrangeArrange
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):
allowRotation, gapMmResponse
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/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/arrange" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"allowRotation":"value","gapMm":"value"}'POST/api/scm/loads/buildBuild
Request body
The keys this action reads (* = required; "one of" lists the only values):
deliveryIds*, vehicleTypeId, warehouseId, loadType, plannedDepartAt, name; loadType one of ltl|truckload|parcel|multi_stop|milk_run|pool|cross_dock|container|backhaulResponse
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/loads/build" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"deliveryIds":"value","vehicleTypeId":"value","warehouseId":"value","loadType":"value","plannedDepartAt":"value","name;":"value"}'POST/api/scm/loads/{id}/create-freight-orderCreate freight order
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):
carrierId, carrierServiceId, tariffId, quotedAmount, quoteOptionId, direction, paymentTerms; direction one of outbound|inbound|transfer|return|third_party; paymentTerms one of prepaid|collect|third_party|prepaid_and_chargeResponse
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/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/create-freight-order" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"carrierId":"value","carrierServiceId":"value","tariffId":"value","quotedAmount":"value","quoteOptionId":"value","direction":"value"}'GET/api/scm/loads/{parentId}/stopsStops
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/stops" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/loads/{parentId}/stopsStops
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, 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/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/stops" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/loads/{parentId}/stops/{lineId}Stops
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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 PUT "https://demo.tranxact.ai/api/scm/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/stops/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/loads/{parentId}/stops/{lineId}Stops
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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 DELETE "https://demo.tranxact.ai/api/scm/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/stops/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/loads/{parentId}/itemsItems
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/items" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/loads/{parentId}/itemsItems
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, 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/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/items" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/loads/{parentId}/items/{lineId}Items
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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 PUT "https://demo.tranxact.ai/api/scm/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/loads/{parentId}/items/{lineId}Items
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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 DELETE "https://demo.tranxact.ai/api/scm/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a loads, 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 |
load_no | text | read only | Load no |
name | text | read, write | Name |
load_type | text | read, write | Type |
vehicle_type_id | uuid | read, write | Vehicle type — The deck the builder draws. A load with no vehicle type has no canvas to be arranged on. |
vehicle_id | uuid | read, write | Vehicle |
driver_id | uuid | read, write | Driver |
carrier_id | uuid | read, write | Carrier |
carrier_service_id | uuid | read, write | Service |
trailer_no | text | read, write | Trailer number |
seal_no | text | read, write | Seal number |
origin_place_id | uuid | read, write | From |
destination_place_id | uuid | read, write | To |
warehouse_id | uuid | read, write | Loaded at |
door_id | uuid | read, write | Door |
planned_depart_at | timestamp with time zone | read, write | Planned departure |
planned_arrive_at | timestamp with time zone | read, write | Planned arrival |
actual_depart_at | timestamp with time zone | read, write | Actual departure |
actual_arrive_at | timestamp with time zone | read, write | Actual arrival |
total_weight_kg | numeric | read only | Total weight kg |
total_volume_l | numeric | read only | Total volume l |
pallet_count | integer | read only | Pallet count |
piece_count | integer | read only | Piece count |
stop_count | integer | read only | Stop count |
distance_km | numeric | read, write | Distance (km) |
weight_utilization_pct | numeric | read only | Weight utilization pct |
volume_utilization_pct | numeric | read only | Volume utilization pct |
floor_utilization_pct | numeric | read only | Floor utilization pct |
front_axle_kg | numeric | read only | Front axle kg |
rear_axle_kg | numeric | read only | Rear axle kg |
center_of_gravity_mm | numeric | read only | Center of gravity mm |
is_axle_legal | boolean | read only | Is axle legal |
planned_cost | numeric | read, write | Planned cost |
actual_cost | numeric | read, write | Actual cost |
currency | text | read, write | Currency |
cost_center_id | uuid | read, write | Cost center |
co2_kg | numeric | read only | Co2 kg |
planning_method | text | read only | Planning method |
built_by | uuid | read only | Built by |
built_at | timestamp with time zone | read only | Built at |
status | text | read only | Status |
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 › Loads 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.