TRANXACT.AI Help

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.

Type REST13 operationsBase path /api/scm/handling-unitsPublished as /api/v1/handling-units

Download specification (OpenAPI 3.1) Screen: Handling Units

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

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

GET/api/scm/handling-unitsList handling units

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

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

FieldTypeRequiredDescription
sscctextNoSSCC
package_type_iduuidYesPackage type
parent_hu_iduuidNoInside handling unit
warehouse_iduuidNoWarehouse
bin_iduuidNoBin
location_iduuidNoLocation id
tare_weight_kgnumericNoTare weight (kg)
length_mmnumericNoLength (mm)
width_mmnumericNoWidth (mm)
height_mmnumericNoHeight (mm)
statustextNoStatus
Allowed: planned open packed staged loaded shipped received unpacked emptied cancelled
hu_typetextNoDirection
Allowed: inbound outbound internal returnable fixed
receipt_iduuidNoReceipt id
delivery_iduuidNoFor delivery
is_dangerous_goodsbooleanNoDangerous goods
seal_notextNoSeal number
temperature_cnumericNoTemperature (C)
external_reftextNoReference over there
notestextNoNotes

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

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
sscctextNoSSCC
package_type_iduuidYesPackage type
parent_hu_iduuidNoInside handling unit
warehouse_iduuidNoWarehouse
bin_iduuidNoBin
location_iduuidNoLocation id
tare_weight_kgnumericNoTare weight (kg)
length_mmnumericNoLength (mm)
width_mmnumericNoWidth (mm)
height_mmnumericNoHeight (mm)
statustextNoStatus
Allowed: planned open packed staged loaded shipped received unpacked emptied cancelled
hu_typetextNoDirection
Allowed: inbound outbound internal returnable fixed
receipt_iduuidNoReceipt id
delivery_iduuidNoFor delivery
is_dangerous_goodsbooleanNoDangerous goods
seal_notextNoSeal number
temperature_cnumericNoTemperature (C)
external_reftextNoReference over there
notestextNoNotes

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

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

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):

parentHuId

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/nest" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"parentHuId":"value"}'
GET/api/scm/handling-units/{id}/contentsContents

Path parameters

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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
hu_notextread onlyHu no
sscctextread, writeSSCC
package_type_iduuidread, writePackage type
parent_hu_iduuidread, writeInside handling unit
warehouse_iduuidread, writeWarehouse
bin_iduuidread, writeBin
location_iduuidread, writeLocation id
tare_weight_kgnumericread, writeTare weight (kg)
net_weight_kgnumericread onlyNet weight kg
gross_weight_kgnumericread onlyGross weight kg
volume_lnumericread onlyVolume l
length_mmnumericread, writeLength (mm)
width_mmnumericread, writeWidth (mm)
height_mmnumericread, writeHeight (mm)
statustextread, writeStatus
Allowed: planned open packed staged loaded shipped received unpacked emptied cancelled
hu_typetextread, writeDirection
Allowed: inbound outbound internal returnable fixed
receipt_iduuidread, writeReceipt id
delivery_iduuidread, writeFor delivery
load_iduuidread onlyLoad id
freight_order_iduuidread onlyFreight order id
is_dangerous_goodsbooleanread, writeDangerous goods
seal_notextread, writeSeal number
temperature_cnumericread, writeTemperature (C)
packed_attimestamp with time zoneread onlyPacked at
packed_byuuidread onlyPacked by
label_printed_attimestamp with time zoneread onlyLabel printed at
external_reftextread, writeReference over there
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
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 › Handling Units 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.