TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/scm/load-stopsPublished as /api/v1/load-stops

Download specification (OpenAPI 3.1) Screen: Load Stops

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

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

GET/api/scm/load-stopsList load stops

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

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

FieldTypeRequiredDescription
load_iduuidYesLoad
stop_nointegerYesStop number
stop_typetextNoType
Allowed: pickup delivery both cross_dock fuel rest border port customs
place_iduuidNoPlace
account_iduuidNoCustomer
supplier_iduuidNoSupplier id
warehouse_iduuidNoWarehouse id
address_line1textNoAddress
citytextNoCity
regiontextNoRegion
postal_codetextNoPostal code
countrytextNoCountry
latitudenumericNoLatitude
longitudenumericNoLongitude
window_fromtimestamp with time zoneNoWindow from
window_totimestamp with time zoneNoWindow to
planned_arrive_attimestamp with time zoneNoPlanned arrival
planned_depart_attimestamp with time zoneNoPlanned depart at
actual_arrive_attimestamp with time zoneNoActual arrive at
actual_depart_attimestamp with time zoneNoActual depart at
appointment_notextNoAppointment number
service_minutesnumericNoMinutes on site
signed_bytextNoSigned for by
pod_attimestamp with time zoneNoProof of delivery at
pod_notestextNoDelivery notes
statustextNoStatus
Allowed: planned en_route arrived working departed completed refused failed cancelled
notestextNoNotes

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

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
load_iduuidYesLoad
stop_nointegerYesStop number
stop_typetextNoType
Allowed: pickup delivery both cross_dock fuel rest border port customs
place_iduuidNoPlace
account_iduuidNoCustomer
supplier_iduuidNoSupplier id
warehouse_iduuidNoWarehouse id
address_line1textNoAddress
citytextNoCity
regiontextNoRegion
postal_codetextNoPostal code
countrytextNoCountry
latitudenumericNoLatitude
longitudenumericNoLongitude
window_fromtimestamp with time zoneNoWindow from
window_totimestamp with time zoneNoWindow to
planned_arrive_attimestamp with time zoneNoPlanned arrival
planned_depart_attimestamp with time zoneNoPlanned depart at
actual_arrive_attimestamp with time zoneNoActual arrive at
actual_depart_attimestamp with time zoneNoActual depart at
appointment_notextNoAppointment number
service_minutesnumericNoMinutes on site
signed_bytextNoSigned for by
pod_attimestamp with time zoneNoProof of delivery at
pod_notestextNoDelivery notes
statustextNoStatus
Allowed: planned en_route arrived working departed completed refused failed cancelled
notestextNoNotes

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
load_iduuidread, writeLoad
stop_nointegerread, writeStop number
stop_typetextread, writeType
Allowed: pickup delivery both cross_dock fuel rest border port customs
place_iduuidread, writePlace
account_iduuidread, writeCustomer
supplier_iduuidread, writeSupplier id
warehouse_iduuidread, writeWarehouse id
address_line1textread, writeAddress
citytextread, writeCity
regiontextread, writeRegion
postal_codetextread, writePostal code
countrytextread, writeCountry
latitudenumericread, writeLatitude
longitudenumericread, writeLongitude
window_fromtimestamp with time zoneread, writeWindow from
window_totimestamp with time zoneread, writeWindow to
planned_arrive_attimestamp with time zoneread, writePlanned arrival
planned_depart_attimestamp with time zoneread, writePlanned depart at
actual_arrive_attimestamp with time zoneread, writeActual arrive at
actual_depart_attimestamp with time zoneread, writeActual depart at
appointment_notextread, writeAppointment number
service_minutesnumericread, writeMinutes on site
distance_from_previous_kmnumericread onlyDistance from previous km
drive_minutes_from_previousnumericread onlyDrive minutes from previous
weight_kgnumericread onlyWeight kg
volume_lnumericread onlyVolume l
piecesintegerread onlyPieces
signed_bytextread, writeSigned for by
pod_attimestamp with time zoneread, writeProof of delivery at
pod_notestextread, writeDelivery notes
statustextread, writeStatus
Allowed: planned en_route arrived working departed completed refused failed cancelled
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
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 › Load Stops 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.