TRANXACT.AI Help

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.

Type REST19 operationsBase path /api/scm/loadsPublished as /api/v1/loads

Download specification (OpenAPI 3.1) Screen: Loads

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 › 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.
Tablescm.loads · 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

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

GET/api/scm/loadsList loads

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
nametextNoName
load_typetextNoType
vehicle_type_iduuidNoVehicle type — The deck the builder draws. A load with no vehicle type has no canvas to be arranged on.
vehicle_iduuidNoVehicle
driver_iduuidNoDriver
carrier_iduuidNoCarrier
carrier_service_iduuidNoService
trailer_notextNoTrailer number
seal_notextNoSeal number
origin_place_iduuidNoFrom
destination_place_iduuidNoTo
warehouse_iduuidNoLoaded at
door_iduuidNoDoor
planned_depart_attimestamp with time zoneNoPlanned departure
planned_arrive_attimestamp with time zoneNoPlanned arrival
actual_depart_attimestamp with time zoneNoActual departure
actual_arrive_attimestamp with time zoneNoActual arrival
distance_kmnumericNoDistance (km)
planned_costnumericNoPlanned cost
actual_costnumericNoActual cost
currencytextNoCurrency
cost_center_iduuidNoCost center
notestextNoNotes

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

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
nametextNoName
load_typetextNoType
vehicle_type_iduuidNoVehicle type — The deck the builder draws. A load with no vehicle type has no canvas to be arranged on.
vehicle_iduuidNoVehicle
driver_iduuidNoDriver
carrier_iduuidNoCarrier
carrier_service_iduuidNoService
trailer_notextNoTrailer number
seal_notextNoSeal number
origin_place_iduuidNoFrom
destination_place_iduuidNoTo
warehouse_iduuidNoLoaded at
door_iduuidNoDoor
planned_depart_attimestamp with time zoneNoPlanned departure
planned_arrive_attimestamp with time zoneNoPlanned arrival
actual_depart_attimestamp with time zoneNoActual departure
actual_arrive_attimestamp with time zoneNoActual arrival
distance_kmnumericNoDistance (km)
planned_costnumericNoPlanned cost
actual_costnumericNoActual cost
currencytextNoCurrency
cost_center_iduuidNoCost center
notestextNoNotes

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

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/loads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/loads/{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/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

NameTypeDescription
idstring (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

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):

itemId*, xMm, yMm, zMm, isRotated, stackLevel, stopId

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/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

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):

allowRotation, gapMm

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/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|backhaul

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/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

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):

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_charge

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/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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
load_notextread onlyLoad no
nametextread, writeName
load_typetextread, writeType
vehicle_type_iduuidread, writeVehicle type — The deck the builder draws. A load with no vehicle type has no canvas to be arranged on.
vehicle_iduuidread, writeVehicle
driver_iduuidread, writeDriver
carrier_iduuidread, writeCarrier
carrier_service_iduuidread, writeService
trailer_notextread, writeTrailer number
seal_notextread, writeSeal number
origin_place_iduuidread, writeFrom
destination_place_iduuidread, writeTo
warehouse_iduuidread, writeLoaded at
door_iduuidread, writeDoor
planned_depart_attimestamp with time zoneread, writePlanned departure
planned_arrive_attimestamp with time zoneread, writePlanned arrival
actual_depart_attimestamp with time zoneread, writeActual departure
actual_arrive_attimestamp with time zoneread, writeActual arrival
total_weight_kgnumericread onlyTotal weight kg
total_volume_lnumericread onlyTotal volume l
pallet_countintegerread onlyPallet count
piece_countintegerread onlyPiece count
stop_countintegerread onlyStop count
distance_kmnumericread, writeDistance (km)
weight_utilization_pctnumericread onlyWeight utilization pct
volume_utilization_pctnumericread onlyVolume utilization pct
floor_utilization_pctnumericread onlyFloor utilization pct
front_axle_kgnumericread onlyFront axle kg
rear_axle_kgnumericread onlyRear axle kg
center_of_gravity_mmnumericread onlyCenter of gravity mm
is_axle_legalbooleanread onlyIs axle legal
planned_costnumericread, writePlanned cost
actual_costnumericread, writeActual cost
currencytextread, writeCurrency
cost_center_iduuidread, writeCost center
co2_kgnumericread onlyCo2 kg
planning_methodtextread onlyPlanning method
built_byuuidread onlyBuilt by
built_attimestamp with time zoneread onlyBuilt at
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 › Loads 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.