TRANXACT.AI Help

Supply Chain · Reachable by link

On the Deck

One thing on the vehicle, and where it sits. The coordinates are what make the axle calculation and the picture the same fact.

Type REST6 operationsBase path /api/scm/load-itemsPublished as /api/v1/load-items

Download specification (OpenAPI 3.1) Screen: On the Deck

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 › On the Deck 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_items · 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-itemsList on the deck

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",
      "line_no": 10,
      "stop_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "hu_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "delivery_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "purchase_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "description": "text",
      "quantity": "12.0000",
      "uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "length_mm": "1250.00"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/load-items?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/load-items/{id}Read one load item

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",
  "line_no": 10,
  "stop_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hu_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "delivery_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "purchase_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "description": "text",
  "quantity": "12.0000",
  "uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "length_mm": "1250.00"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/scm/load-items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/load-itemsCreate a load item

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
load_iduuidYesLoad
stop_iduuidNoFor stop
hu_iduuidNoHandling unit
item_iduuidNoItem
delivery_iduuidNoDelivery id
sales_order_iduuidNoSales order id
purchase_order_iduuidNoPurchase order id
package_type_iduuidNoPackage type id
descriptiontextNoDescription
quantitynumericNoQuantity
uom_iduuidNoUnit
length_mmnumericNoLength (mm)
width_mmnumericNoWidth (mm)
height_mmnumericNoHeight (mm)
weight_kgnumericNoWeight (kg)
volume_lnumericNoVolume (L)
x_mmnumericNoX mm
y_mmnumericNoY mm
z_mmnumericNoZ mm
is_rotatedbooleanNoIs rotated
stack_levelintegerNoStack level
is_stackablebooleanNoMay be stacked on
max_stack_weight_kgnumericNoMax stack weight kg
load_sequenceintegerNoLoad sequence
unload_sequenceintegerNoUnload sequence
freight_class_iduuidNoFreight class
is_hazardousbooleanNoHazardous
un_numbertextNoUN number
temperature_cnumericNoTemperature c
declared_valuenumericNoDeclared value
currencytextNoCurrency
statustextNoStatus
Allowed: planned staged loaded delivered short removed

Sample body

{
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "stop_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hu_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "delivery_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "stop_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hu_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "delivery_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "purchase_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "description": "text",
  "quantity": "12.0000",
  "uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "length_mm": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/load-items" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"load_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","stop_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","hu_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","delivery_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/scm/load-items/{id}Change a load item

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_iduuidNoFor stop
hu_iduuidNoHandling unit
item_iduuidNoItem
delivery_iduuidNoDelivery id
sales_order_iduuidNoSales order id
purchase_order_iduuidNoPurchase order id
package_type_iduuidNoPackage type id
descriptiontextNoDescription
quantitynumericNoQuantity
uom_iduuidNoUnit
length_mmnumericNoLength (mm)
width_mmnumericNoWidth (mm)
height_mmnumericNoHeight (mm)
weight_kgnumericNoWeight (kg)
volume_lnumericNoVolume (L)
x_mmnumericNoX mm
y_mmnumericNoY mm
z_mmnumericNoZ mm
is_rotatedbooleanNoIs rotated
stack_levelintegerNoStack level
is_stackablebooleanNoMay be stacked on
max_stack_weight_kgnumericNoMax stack weight kg
load_sequenceintegerNoLoad sequence
unload_sequenceintegerNoUnload sequence
freight_class_iduuidNoFreight class
is_hazardousbooleanNoHazardous
un_numbertextNoUN number
temperature_cnumericNoTemperature c
declared_valuenumericNoDeclared value
currencytextNoCurrency
statustextNoStatus
Allowed: planned staged loaded delivered short removed

Sample body

{
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "stop_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "stop_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hu_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "delivery_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "purchase_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "description": "text",
  "quantity": "12.0000",
  "uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "length_mm": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/load-items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"load_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","stop_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/scm/load-items/{id}Delete a load item

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-items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/load-items/{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-items/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 item, 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
line_nointegerread onlyLine no
stop_iduuidread, writeFor stop
hu_iduuidread, writeHandling unit
item_iduuidread, writeItem
delivery_iduuidread, writeDelivery id
sales_order_iduuidread, writeSales order id
purchase_order_iduuidread, writePurchase order id
package_type_iduuidread, writePackage type id
descriptiontextread, writeDescription
quantitynumericread, writeQuantity
uom_iduuidread, writeUnit
length_mmnumericread, writeLength (mm)
width_mmnumericread, writeWidth (mm)
height_mmnumericread, writeHeight (mm)
weight_kgnumericread, writeWeight (kg)
volume_lnumericread, writeVolume (L)
x_mmnumericread, writeX mm
y_mmnumericread, writeY mm
z_mmnumericread, writeZ mm
is_rotatedbooleanread, writeIs rotated
stack_levelintegerread, writeStack level
is_stackablebooleanread, writeMay be stacked on
max_stack_weight_kgnumericread, writeMax stack weight kg
load_sequenceintegerread, writeLoad sequence
unload_sequenceintegerread, writeUnload sequence
freight_class_iduuidread, writeFreight class
is_hazardousbooleanread, writeHazardous
un_numbertextread, writeUN number
temperature_cnumericread, writeTemperature c
declared_valuenumericread, writeDeclared value
currencytextread, writeCurrency
statustextread, writeStatus
Allowed: planned staged loaded delivered short removed
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 › On the Deck 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.