TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/scm/package-typesPublished as /api/v1/package-types

Download specification (OpenAPI 3.1) Screen: Package Types

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 › 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.
Tablescm.package_types · 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/package-typesList package types

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

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

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
categorytextNoCategory
hierarchy_levelintegerNoPacking 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_mmnumericNoOutside length (mm)
width_mmnumericNoOutside width (mm)
height_mmnumericNoOutside height (mm)
inner_length_mmnumericNoInside length (mm) — Leave blank on an open pallet, where the load is not constrained by walls.
inner_width_mmnumericNoInside width (mm)
inner_height_mmnumericNoInside height (mm)
tare_weight_kgnumericNoTare weight (kg)
max_payload_kgnumericNoMaximum payload (kg)
max_volume_lnumericNoMaximum volume (L)
is_stackablebooleanNoMay be stacked when loaded
max_stackintegerNoHow many high
is_nestablebooleanNoNests 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_mmnumericNoAdded height of each empty (mm)
is_returnablebooleanNoReturnable
deposit_amountnumericNoDeposit
currencytextNoCurrency
materialtextNoMade of
Allowed: cardboard wood plastic metal composite glass textile paper other
is_recyclablebooleanNoRecyclable
hu_managedbooleanNoGets its own number and history
sscc_prefixtextNoSSCC prefix
un_approvedbooleanNoUN 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_markingtextNoUN marking
iso_container_typetextNoISO container type — 22G1, 45R1. What a shipping line asks for.
is_activebooleanNoActive
notestextNoNotes

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

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
codetextYesCode
nametextYesName
categorytextNoCategory
hierarchy_levelintegerNoPacking 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_mmnumericNoOutside length (mm)
width_mmnumericNoOutside width (mm)
height_mmnumericNoOutside height (mm)
inner_length_mmnumericNoInside length (mm) — Leave blank on an open pallet, where the load is not constrained by walls.
inner_width_mmnumericNoInside width (mm)
inner_height_mmnumericNoInside height (mm)
tare_weight_kgnumericNoTare weight (kg)
max_payload_kgnumericNoMaximum payload (kg)
max_volume_lnumericNoMaximum volume (L)
is_stackablebooleanNoMay be stacked when loaded
max_stackintegerNoHow many high
is_nestablebooleanNoNests 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_mmnumericNoAdded height of each empty (mm)
is_returnablebooleanNoReturnable
deposit_amountnumericNoDeposit
currencytextNoCurrency
materialtextNoMade of
Allowed: cardboard wood plastic metal composite glass textile paper other
is_recyclablebooleanNoRecyclable
hu_managedbooleanNoGets its own number and history
sscc_prefixtextNoSSCC prefix
un_approvedbooleanNoUN 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_markingtextNoUN marking
iso_container_typetextNoISO container type — 22G1, 45R1. What a shipping line asks for.
is_activebooleanNoActive
notestextNoNotes

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode
nametextread, writeName
categorytextread, writeCategory
hierarchy_levelintegerread, writePacking 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_mmnumericread, writeOutside length (mm)
width_mmnumericread, writeOutside width (mm)
height_mmnumericread, writeOutside height (mm)
inner_length_mmnumericread, writeInside length (mm) — Leave blank on an open pallet, where the load is not constrained by walls.
inner_width_mmnumericread, writeInside width (mm)
inner_height_mmnumericread, writeInside height (mm)
tare_weight_kgnumericread, writeTare weight (kg)
max_payload_kgnumericread, writeMaximum payload (kg)
max_volume_lnumericread, writeMaximum volume (L)
is_stackablebooleanread, writeMay be stacked when loaded
max_stackintegerread, writeHow many high
is_nestablebooleanread, writeNests 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_mmnumericread, writeAdded height of each empty (mm)
is_returnablebooleanread, writeReturnable
deposit_amountnumericread, writeDeposit
currencytextread, writeCurrency
materialtextread, writeMade of
Allowed: cardboard wood plastic metal composite glass textile paper other
is_recyclablebooleanread, writeRecyclable
hu_managedbooleanread, writeGets its own number and history
sscc_prefixtextread, writeSSCC prefix
un_approvedbooleanread, writeUN 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_markingtextread, writeUN marking
iso_container_typetextread, writeISO container type — 22G1, 45R1. What a shipping line asks for.
is_activebooleanread, writeActive
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 › Package Types 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.