Supply Chain · Units & Packaging
Package Types
The pallets, cartons, totes, drums and containers goods are shipped in — with the outside dimensions and the tare weight that make a load plan arithmetic rather than an opinion.
/api/scm/package-typesPublished as /api/v1/package-typesOverview
| 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 › Package Types 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.package_types · 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/package-typesList package types
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",
"code": "COD-000001",
"name": "Example",
"category": "text",
"hierarchy_level": 10,
"length_mm": "1250.00",
"width_mm": "1250.00",
"height_mm": "1250.00",
"inner_length_mm": "1250.00",
"inner_width_mm": "1250.00",
"inner_height_mm": "1250.00",
"tare_weight_kg": "1250.00",
"max_payload_kg": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/package-types?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/package-types/{id}Read one package type
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",
"code": "COD-000001",
"name": "Example",
"category": "text",
"hierarchy_level": 10,
"length_mm": "1250.00",
"width_mm": "1250.00",
"height_mm": "1250.00",
"inner_length_mm": "1250.00",
"inner_width_mm": "1250.00",
"inner_height_mm": "1250.00",
"tare_weight_kg": "1250.00",
"max_payload_kg": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/package-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/package-typesCreate a package type
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
category | text | No | Category |
hierarchy_level | integer | No | Packing level — 1 is the innermost unit and 5 is a conveyance. A case goes on a pallet goes in a container, and an instruction that inverts that is caught by comparing these. |
length_mm | numeric | No | Outside length (mm) |
width_mm | numeric | No | Outside width (mm) |
height_mm | numeric | No | Outside height (mm) |
inner_length_mm | numeric | No | Inside length (mm) — Leave blank on an open pallet, where the load is not constrained by walls. |
inner_width_mm | numeric | No | Inside width (mm) |
inner_height_mm | numeric | No | Inside height (mm) |
tare_weight_kg | numeric | No | Tare weight (kg) |
max_payload_kg | numeric | No | Maximum payload (kg) |
max_volume_l | numeric | No | Maximum volume (L) |
is_stackable | boolean | No | May be stacked when loaded |
max_stack | integer | No | How many high |
is_nestable | boolean | No | Nests when empty — What makes a stack of empties take less room than a stack of fulls — the difference between a return leg that pays and one that does not. |
nested_height_mm | numeric | No | Added height of each empty (mm) |
is_returnable | boolean | No | Returnable |
deposit_amount | numeric | No | Deposit |
currency | text | No | Currency |
material | text | No | Made of Allowed: cardboard wood plastic metal composite glass textile paper other |
is_recyclable | boolean | No | Recyclable |
hu_managed | boolean | No | Gets its own number and history |
sscc_prefix | text | No | SSCC prefix |
un_approved | boolean | No | UN approved for dangerous goods — A marked drum may carry dangerous goods and an unmarked one may not. That is a refusal rather than a warning. |
un_marking | text | No | UN marking |
iso_container_type | text | No | ISO container type — 22G1, 45R1. What a shipping line asks for. |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"code": "COD-000001",
"name": "Example",
"category": "text",
"hierarchy_level": 10,
"length_mm": "1250.00",
"width_mm": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"category": "text",
"hierarchy_level": 10,
"length_mm": "1250.00",
"width_mm": "1250.00",
"height_mm": "1250.00",
"inner_length_mm": "1250.00",
"inner_width_mm": "1250.00",
"inner_height_mm": "1250.00",
"tare_weight_kg": "1250.00",
"max_payload_kg": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/package-types" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","category":"text","hierarchy_level":10,"length_mm":"1250.00","width_mm":"1250.00"}'PUT/api/scm/package-types/{id}Change a package type
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 |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
category | text | No | Category |
hierarchy_level | integer | No | Packing level — 1 is the innermost unit and 5 is a conveyance. A case goes on a pallet goes in a container, and an instruction that inverts that is caught by comparing these. |
length_mm | numeric | No | Outside length (mm) |
width_mm | numeric | No | Outside width (mm) |
height_mm | numeric | No | Outside height (mm) |
inner_length_mm | numeric | No | Inside length (mm) — Leave blank on an open pallet, where the load is not constrained by walls. |
inner_width_mm | numeric | No | Inside width (mm) |
inner_height_mm | numeric | No | Inside height (mm) |
tare_weight_kg | numeric | No | Tare weight (kg) |
max_payload_kg | numeric | No | Maximum payload (kg) |
max_volume_l | numeric | No | Maximum volume (L) |
is_stackable | boolean | No | May be stacked when loaded |
max_stack | integer | No | How many high |
is_nestable | boolean | No | Nests when empty — What makes a stack of empties take less room than a stack of fulls — the difference between a return leg that pays and one that does not. |
nested_height_mm | numeric | No | Added height of each empty (mm) |
is_returnable | boolean | No | Returnable |
deposit_amount | numeric | No | Deposit |
currency | text | No | Currency |
material | text | No | Made of Allowed: cardboard wood plastic metal composite glass textile paper other |
is_recyclable | boolean | No | Recyclable |
hu_managed | boolean | No | Gets its own number and history |
sscc_prefix | text | No | SSCC prefix |
un_approved | boolean | No | UN approved for dangerous goods — A marked drum may carry dangerous goods and an unmarked one may not. That is a refusal rather than a warning. |
un_marking | text | No | UN marking |
iso_container_type | text | No | ISO container type — 22G1, 45R1. What a shipping line asks for. |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"category": "text",
"hierarchy_level": 10,
"length_mm": "1250.00",
"width_mm": "1250.00",
"height_mm": "1250.00",
"inner_length_mm": "1250.00",
"inner_width_mm": "1250.00",
"inner_height_mm": "1250.00",
"tare_weight_kg": "1250.00",
"max_payload_kg": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/package-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/scm/package-types/{id}Delete a package type
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/package-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/package-types/{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/package-types/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 package type, 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 |
code | text | read, write | Code |
name | text | read, write | Name |
category | text | read, write | Category |
hierarchy_level | integer | read, write | Packing level — 1 is the innermost unit and 5 is a conveyance. A case goes on a pallet goes in a container, and an instruction that inverts that is caught by comparing these. |
length_mm | numeric | read, write | Outside length (mm) |
width_mm | numeric | read, write | Outside width (mm) |
height_mm | numeric | read, write | Outside height (mm) |
inner_length_mm | numeric | read, write | Inside length (mm) — Leave blank on an open pallet, where the load is not constrained by walls. |
inner_width_mm | numeric | read, write | Inside width (mm) |
inner_height_mm | numeric | read, write | Inside height (mm) |
tare_weight_kg | numeric | read, write | Tare weight (kg) |
max_payload_kg | numeric | read, write | Maximum payload (kg) |
max_volume_l | numeric | read, write | Maximum volume (L) |
is_stackable | boolean | read, write | May be stacked when loaded |
max_stack | integer | read, write | How many high |
is_nestable | boolean | read, write | Nests when empty — What makes a stack of empties take less room than a stack of fulls — the difference between a return leg that pays and one that does not. |
nested_height_mm | numeric | read, write | Added height of each empty (mm) |
is_returnable | boolean | read, write | Returnable |
deposit_amount | numeric | read, write | Deposit |
currency | text | read, write | Currency |
material | text | read, write | Made of Allowed: cardboard wood plastic metal composite glass textile paper other |
is_recyclable | boolean | read, write | Recyclable |
hu_managed | boolean | read, write | Gets its own number and history |
sscc_prefix | text | read, write | SSCC prefix |
un_approved | boolean | read, write | UN approved for dangerous goods — A marked drum may carry dangerous goods and an unmarked one may not. That is a refusal rather than a warning. |
un_marking | text | read, write | UN marking |
iso_container_type | text | read, write | ISO container type — 22G1, 45R1. What a shipping line asks for. |
is_active | boolean | read, write | Active |
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 › Package Types 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.