Supply Chain · Units & Packaging
Handling Units
The actual, physical, numbered thing on the floor: pallet, carton, container. They nest, and the weight of a parent is the sum of everything under it — maintained rather than typed, because a pallet whose weight is a guess is a pallet that overloads an axle.
/api/scm/handling-unitsPublished as /api/v1/handling-unitsOverview
| 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 › Handling Units 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.handling_units · 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
13 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/handling-unitsList handling units
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",
"hu_no": "HU-000001",
"sscc": "text",
"package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_hu_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tare_weight_kg": "1250.00",
"net_weight_kg": "1250.00",
"gross_weight_kg": "1250.00",
"volume_l": "1250.00",
"length_mm": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/handling-units?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/handling-units/{id}Read one handling unit
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",
"hu_no": "HU-000001",
"sscc": "text",
"package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_hu_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tare_weight_kg": "1250.00",
"net_weight_kg": "1250.00",
"gross_weight_kg": "1250.00",
"volume_l": "1250.00",
"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/handling-units/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/handling-unitsCreate a handling unit
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
sscc | text | No | SSCC |
package_type_id | uuid | Yes | Package type |
parent_hu_id | uuid | No | Inside handling unit |
warehouse_id | uuid | No | Warehouse |
bin_id | uuid | No | Bin |
location_id | uuid | No | Location id |
tare_weight_kg | numeric | No | Tare weight (kg) |
length_mm | numeric | No | Length (mm) |
width_mm | numeric | No | Width (mm) |
height_mm | numeric | No | Height (mm) |
status | text | No | Status Allowed: planned open packed staged loaded shipped received unpacked emptied cancelled |
hu_type | text | No | Direction Allowed: inbound outbound internal returnable fixed |
receipt_id | uuid | No | Receipt id |
delivery_id | uuid | No | For delivery |
is_dangerous_goods | boolean | No | Dangerous goods |
seal_no | text | No | Seal number |
temperature_c | numeric | No | Temperature (C) |
external_ref | text | No | Reference over there |
notes | text | No | Notes |
Sample body
{
"package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sscc": "text",
"parent_hu_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"hu_no": "HU-000001",
"sscc": "text",
"package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_hu_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tare_weight_kg": "1250.00",
"net_weight_kg": "1250.00",
"gross_weight_kg": "1250.00",
"volume_l": "1250.00",
"length_mm": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/handling-units" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"package_type_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","sscc":"text","parent_hu_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","bin_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/scm/handling-units/{id}Change a handling unit
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 |
|---|---|---|---|
sscc | text | No | SSCC |
package_type_id | uuid | Yes | Package type |
parent_hu_id | uuid | No | Inside handling unit |
warehouse_id | uuid | No | Warehouse |
bin_id | uuid | No | Bin |
location_id | uuid | No | Location id |
tare_weight_kg | numeric | No | Tare weight (kg) |
length_mm | numeric | No | Length (mm) |
width_mm | numeric | No | Width (mm) |
height_mm | numeric | No | Height (mm) |
status | text | No | Status Allowed: planned open packed staged loaded shipped received unpacked emptied cancelled |
hu_type | text | No | Direction Allowed: inbound outbound internal returnable fixed |
receipt_id | uuid | No | Receipt id |
delivery_id | uuid | No | For delivery |
is_dangerous_goods | boolean | No | Dangerous goods |
seal_no | text | No | Seal number |
temperature_c | numeric | No | Temperature (C) |
external_ref | text | No | Reference over there |
notes | text | No | Notes |
Sample body
{
"package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sscc": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"hu_no": "HU-000001",
"sscc": "text",
"package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_hu_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tare_weight_kg": "1250.00",
"net_weight_kg": "1250.00",
"gross_weight_kg": "1250.00",
"volume_l": "1250.00",
"length_mm": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/handling-units/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"package_type_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","sscc":"text"}'DELETE/api/scm/handling-units/{id}Delete a handling unit
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/handling-units/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/handling-units/{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/handling-units/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/handling-units/packPack
Request body
The keys this action reads (* = required; "one of" lists the only values):
packageTypeId*, warehouseId, binId, huType, deliveryId, receiptId, sealNo, huNo, notes; huType one of inbound|outbound|internal|returnable|fixed; contents*: [{ itemId, childHuId, netWeightKg, volumeL, quantity, uomId, lotNo, serialId, expiryDate }]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/handling-units/pack" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"packageTypeId":"value","warehouseId":"value","binId":"value","huType":"value","deliveryId":"value","receiptId":"value"}'POST/api/scm/handling-units/{id}/nestNest
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):
parentHuIdResponse
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/handling-units/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/nest" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"parentHuId":"value"}'GET/api/scm/handling-units/{id}/contentsContents
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/handling-units/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contents" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/handling-units/{parentId}/contentsContents
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/handling-units/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contents" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/handling-units/{parentId}/contentsContents
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/handling-units/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contents" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/handling-units/{parentId}/contents/{lineId}Contents
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/handling-units/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/handling-units/{parentId}/contents/{lineId}Contents
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/handling-units/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a handling unit, 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 |
hu_no | text | read only | Hu no |
sscc | text | read, write | SSCC |
package_type_id | uuid | read, write | Package type |
parent_hu_id | uuid | read, write | Inside handling unit |
warehouse_id | uuid | read, write | Warehouse |
bin_id | uuid | read, write | Bin |
location_id | uuid | read, write | Location id |
tare_weight_kg | numeric | read, write | Tare weight (kg) |
net_weight_kg | numeric | read only | Net weight kg |
gross_weight_kg | numeric | read only | Gross weight kg |
volume_l | numeric | read only | Volume l |
length_mm | numeric | read, write | Length (mm) |
width_mm | numeric | read, write | Width (mm) |
height_mm | numeric | read, write | Height (mm) |
status | text | read, write | Status Allowed: planned open packed staged loaded shipped received unpacked emptied cancelled |
hu_type | text | read, write | Direction Allowed: inbound outbound internal returnable fixed |
receipt_id | uuid | read, write | Receipt id |
delivery_id | uuid | read, write | For delivery |
load_id | uuid | read only | Load id |
freight_order_id | uuid | read only | Freight order id |
is_dangerous_goods | boolean | read, write | Dangerous goods |
seal_no | text | read, write | Seal number |
temperature_c | numeric | read, write | Temperature (C) |
packed_at | timestamp with time zone | read only | Packed at |
packed_by | uuid | read only | Packed by |
label_printed_at | timestamp with time zone | read only | Label printed at |
external_ref | text | read, write | Reference over there |
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 › Handling Units 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.