Supply Chain · Freight Management
Freight Orders
The instruction to a carrier: collect here, deliver there, these stops in this order. Tendered, accepted, refused, offered to the next one down.
/api/scm/freight-ordersPublished as /api/v1/freight-ordersOverview
| 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 › Freight Orders 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.freight_orders · 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
17 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/freight-ordersList freight orders
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",
"freight_order_no": "FRE-000001",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"transport_lane_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tariff_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"direction": "outbound",
"mode": "text",
"incoterm": "text",
"payment_terms": "text",
"bill_to_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bol_no": "BOL-000001"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/freight-orders?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/freight-orders/{id}Read one freight order
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",
"freight_order_no": "FRE-000001",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"transport_lane_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tariff_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"direction": "outbound",
"mode": "text",
"incoterm": "text",
"payment_terms": "text",
"bill_to_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bol_no": "BOL-000001"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/freight-ordersCreate a freight order
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
load_id | uuid | No | Load |
carrier_id | uuid | No | Carrier |
carrier_service_id | uuid | No | Service |
transport_lane_id | uuid | No | Lane |
tariff_id | uuid | No | Tariff |
direction | text | No | Direction Allowed: outbound inbound transfer return third_party |
mode | text | No | Mode |
incoterm | text | No | Incoterm |
payment_terms | text | No | Who pays — Prepaid, collect and third party are three different receivables, and getting it wrong bills the wrong party. |
bill_to_account_id | uuid | No | Bill to |
bol_no | text | No | Bill of lading |
pro_no | text | No | Carrier number |
tracking_no | text | No | Tracking number |
pickup_no | text | No | Collection number |
customer_ref | text | No | Customer reference |
requested_pickup_at | timestamp with time zone | No | Requested collection |
pickup_at | timestamp with time zone | No | Collected |
requested_delivery_at | timestamp with time zone | No | Requested delivery |
promised_delivery_at | timestamp with time zone | No | Promised delivery |
delivered_at | timestamp with time zone | No | Delivered |
quoted_amount | numeric | No | Quoted |
currency | text | No | Currency |
cost_center_id | uuid | No | Cost center |
declared_value | numeric | No | Declared value |
is_hazardous | boolean | No | Dangerous goods |
is_temperature_controlled | boolean | No | Temperature controlled |
temperature_min_c | numeric | No | Minimum temperature (C) |
temperature_max_c | numeric | No | Maximum temperature (C) |
special_instructions | text | No | Special instructions |
notes | text | No | Notes |
Sample body
{
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"transport_lane_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"freight_order_no": "FRE-000001",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"transport_lane_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tariff_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"direction": "outbound",
"mode": "text",
"incoterm": "text",
"payment_terms": "text",
"bill_to_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bol_no": "BOL-000001"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/freight-orders" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"load_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","carrier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","carrier_service_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","transport_lane_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/scm/freight-orders/{id}Change a freight order
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 |
|---|---|---|---|
load_id | uuid | No | Load |
carrier_id | uuid | No | Carrier |
carrier_service_id | uuid | No | Service |
transport_lane_id | uuid | No | Lane |
tariff_id | uuid | No | Tariff |
direction | text | No | Direction Allowed: outbound inbound transfer return third_party |
mode | text | No | Mode |
incoterm | text | No | Incoterm |
payment_terms | text | No | Who pays — Prepaid, collect and third party are three different receivables, and getting it wrong bills the wrong party. |
bill_to_account_id | uuid | No | Bill to |
bol_no | text | No | Bill of lading |
pro_no | text | No | Carrier number |
tracking_no | text | No | Tracking number |
pickup_no | text | No | Collection number |
customer_ref | text | No | Customer reference |
requested_pickup_at | timestamp with time zone | No | Requested collection |
pickup_at | timestamp with time zone | No | Collected |
requested_delivery_at | timestamp with time zone | No | Requested delivery |
promised_delivery_at | timestamp with time zone | No | Promised delivery |
delivered_at | timestamp with time zone | No | Delivered |
quoted_amount | numeric | No | Quoted |
currency | text | No | Currency |
cost_center_id | uuid | No | Cost center |
declared_value | numeric | No | Declared value |
is_hazardous | boolean | No | Dangerous goods |
is_temperature_controlled | boolean | No | Temperature controlled |
temperature_min_c | numeric | No | Minimum temperature (C) |
temperature_max_c | numeric | No | Maximum temperature (C) |
special_instructions | text | No | Special instructions |
notes | text | No | Notes |
Sample body
{
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"freight_order_no": "FRE-000001",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"transport_lane_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tariff_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"direction": "outbound",
"mode": "text",
"incoterm": "text",
"payment_terms": "text",
"bill_to_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bol_no": "BOL-000001"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"load_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","carrier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/scm/freight-orders/{id}Delete a freight order
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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/freight-orders/{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/freight-orders/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/freight-orders/{id}/tenderTender
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):
response, carrierId, noteResponse
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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tender" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"response":"value","carrierId":"value","note":"value"}'POST/api/scm/freight-orders/{id}/trackTrack
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):
eventType, eventCode, description, occurredAt, city, region, country, latitude, longitude, signedBy, source, exceptionCode; eventType one of booked|picked_up|departed|arrived|in_transit|customs_hold|customs_cleared|out_for_delivery|delivered|exception|delayed|refused|returned|lost|damaged|geofence_enter|geofence_exit|position; source one of carrier_api|webhook|edi|telematics|geofence|manual|driver_app|emailResponse
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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/track" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"eventType":"value","eventCode":"value","description":"value","occurredAt":"value","city":"value","region":"value"}'GET/api/scm/freight-orders/{id}/trackingTracking
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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tracking" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/freight-orders/{parentId}/linesLines
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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/freight-orders/{parentId}/linesLines
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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/freight-orders/{parentId}/lines/{lineId}Lines
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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/freight-orders/{parentId}/lines/{lineId}Lines
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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/freight-orders/{parentId}/chargesCharges
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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/charges" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/freight-orders/{parentId}/chargesCharges
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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/charges" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/freight-orders/{parentId}/charges/{lineId}Charges
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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/charges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/freight-orders/{parentId}/charges/{lineId}Charges
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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/charges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a freight order, 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 |
freight_order_no | text | read only | Freight order no |
load_id | uuid | read, write | Load |
carrier_id | uuid | read, write | Carrier |
carrier_service_id | uuid | read, write | Service |
transport_lane_id | uuid | read, write | Lane |
tariff_id | uuid | read, write | Tariff |
direction | text | read, write | Direction Allowed: outbound inbound transfer return third_party |
mode | text | read, write | Mode |
incoterm | text | read, write | Incoterm |
payment_terms | text | read, write | Who pays — Prepaid, collect and third party are three different receivables, and getting it wrong bills the wrong party. |
bill_to_account_id | uuid | read, write | Bill to |
bol_no | text | read, write | Bill of lading |
pro_no | text | read, write | Carrier number |
tracking_no | text | read, write | Tracking number |
pickup_no | text | read, write | Collection number |
customer_ref | text | read, write | Customer reference |
requested_pickup_at | timestamp with time zone | read, write | Requested collection |
pickup_at | timestamp with time zone | read, write | Collected |
requested_delivery_at | timestamp with time zone | read, write | Requested delivery |
promised_delivery_at | timestamp with time zone | read, write | Promised delivery |
delivered_at | timestamp with time zone | read, write | Delivered |
quoted_amount | numeric | read, write | Quoted |
accrued_amount | numeric | read only | Accrued amount |
invoiced_amount | numeric | read only | Invoiced amount |
currency | text | read, write | Currency |
cost_center_id | uuid | read, write | Cost center |
total_weight_kg | numeric | read only | Total weight kg |
chargeable_weight_kg | numeric | read only | Chargeable weight kg |
total_volume_l | numeric | read only | Total volume l |
piece_count | integer | read only | Piece count |
declared_value | numeric | read, write | Declared value |
is_hazardous | boolean | read, write | Dangerous goods |
is_temperature_controlled | boolean | read, write | Temperature controlled |
temperature_min_c | numeric | read, write | Minimum temperature (C) |
temperature_max_c | numeric | read, write | Maximum temperature (C) |
special_instructions | text | read, write | Special instructions |
tendered_at | timestamp with time zone | read only | Tendered at |
tender_response_at | timestamp with time zone | read only | Tender response at |
tender_attempts | integer | read only | Tender attempts |
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 › Freight Orders 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.