Supply Chain · Reachable by link
Load Stops
Where the vehicle stops, in order. The sequence decides the loading order, because the first delivery has to be at the back of the trailer.
/api/scm/load-stopsPublished as /api/v1/load-stopsOverview
| 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 › Load Stops 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.load_stops · 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/load-stopsList load stops
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",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"stop_no": 10,
"stop_type": "pickup",
"place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"address_line1": "text",
"city": "text",
"region": "text",
"postal_code": "POS-000001",
"country": "US",
"latitude": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/load-stops?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/load-stops/{id}Read one load stop
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",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"stop_no": 10,
"stop_type": "pickup",
"place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"address_line1": "text",
"city": "text",
"region": "text",
"postal_code": "POS-000001",
"country": "US",
"latitude": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/load-stops/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/load-stopsCreate a load stop
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
load_id | uuid | Yes | Load |
stop_no | integer | Yes | Stop number |
stop_type | text | No | Type Allowed: pickup delivery both cross_dock fuel rest border port customs |
place_id | uuid | No | Place |
account_id | uuid | No | Customer |
supplier_id | uuid | No | Supplier id |
warehouse_id | uuid | No | Warehouse id |
address_line1 | text | No | Address |
city | text | No | City |
region | text | No | Region |
postal_code | text | No | Postal code |
country | text | No | Country |
latitude | numeric | No | Latitude |
longitude | numeric | No | Longitude |
window_from | timestamp with time zone | No | Window from |
window_to | timestamp with time zone | No | Window to |
planned_arrive_at | timestamp with time zone | No | Planned arrival |
planned_depart_at | timestamp with time zone | No | Planned depart at |
actual_arrive_at | timestamp with time zone | No | Actual arrive at |
actual_depart_at | timestamp with time zone | No | Actual depart at |
appointment_no | text | No | Appointment number |
service_minutes | numeric | No | Minutes on site |
signed_by | text | No | Signed for by |
pod_at | timestamp with time zone | No | Proof of delivery at |
pod_notes | text | No | Delivery notes |
status | text | No | Status Allowed: planned en_route arrived working departed completed refused failed cancelled |
notes | text | No | Notes |
Sample body
{
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"stop_no": 10,
"stop_type": "pickup",
"place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"stop_no": 10,
"stop_type": "pickup",
"place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"address_line1": "text",
"city": "text",
"region": "text",
"postal_code": "POS-000001",
"country": "US",
"latitude": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/load-stops" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"load_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","stop_no":10,"stop_type":"pickup","place_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/scm/load-stops/{id}Change a load stop
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 | Yes | Load |
stop_no | integer | Yes | Stop number |
stop_type | text | No | Type Allowed: pickup delivery both cross_dock fuel rest border port customs |
place_id | uuid | No | Place |
account_id | uuid | No | Customer |
supplier_id | uuid | No | Supplier id |
warehouse_id | uuid | No | Warehouse id |
address_line1 | text | No | Address |
city | text | No | City |
region | text | No | Region |
postal_code | text | No | Postal code |
country | text | No | Country |
latitude | numeric | No | Latitude |
longitude | numeric | No | Longitude |
window_from | timestamp with time zone | No | Window from |
window_to | timestamp with time zone | No | Window to |
planned_arrive_at | timestamp with time zone | No | Planned arrival |
planned_depart_at | timestamp with time zone | No | Planned depart at |
actual_arrive_at | timestamp with time zone | No | Actual arrive at |
actual_depart_at | timestamp with time zone | No | Actual depart at |
appointment_no | text | No | Appointment number |
service_minutes | numeric | No | Minutes on site |
signed_by | text | No | Signed for by |
pod_at | timestamp with time zone | No | Proof of delivery at |
pod_notes | text | No | Delivery notes |
status | text | No | Status Allowed: planned en_route arrived working departed completed refused failed cancelled |
notes | text | No | Notes |
Sample body
{
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"stop_no": 10
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"stop_no": 10,
"stop_type": "pickup",
"place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"address_line1": "text",
"city": "text",
"region": "text",
"postal_code": "POS-000001",
"country": "US",
"latitude": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/load-stops/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"load_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","stop_no":10}'DELETE/api/scm/load-stops/{id}Delete a load stop
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/load-stops/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/load-stops/{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/load-stops/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 load stop, 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 |
load_id | uuid | read, write | Load |
stop_no | integer | read, write | Stop number |
stop_type | text | read, write | Type Allowed: pickup delivery both cross_dock fuel rest border port customs |
place_id | uuid | read, write | Place |
account_id | uuid | read, write | Customer |
supplier_id | uuid | read, write | Supplier id |
warehouse_id | uuid | read, write | Warehouse id |
address_line1 | text | read, write | Address |
city | text | read, write | City |
region | text | read, write | Region |
postal_code | text | read, write | Postal code |
country | text | read, write | Country |
latitude | numeric | read, write | Latitude |
longitude | numeric | read, write | Longitude |
window_from | timestamp with time zone | read, write | Window from |
window_to | timestamp with time zone | read, write | Window to |
planned_arrive_at | timestamp with time zone | read, write | Planned arrival |
planned_depart_at | timestamp with time zone | read, write | Planned depart at |
actual_arrive_at | timestamp with time zone | read, write | Actual arrive at |
actual_depart_at | timestamp with time zone | read, write | Actual depart at |
appointment_no | text | read, write | Appointment number |
service_minutes | numeric | read, write | Minutes on site |
distance_from_previous_km | numeric | read only | Distance from previous km |
drive_minutes_from_previous | numeric | read only | Drive minutes from previous |
weight_kg | numeric | read only | Weight kg |
volume_l | numeric | read only | Volume l |
pieces | integer | read only | Pieces |
signed_by | text | read, write | Signed for by |
pod_at | timestamp with time zone | read, write | Proof of delivery at |
pod_notes | text | read, write | Delivery notes |
status | text | read, write | Status Allowed: planned en_route arrived working departed completed refused failed cancelled |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
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 › Load Stops 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.