TRANXACT.AI Help

Supply Chain · Units & Packaging

Packing Instructions

How many go in the carton, how many cartons on the layer, how many layers on the pallet. One row per level, so a customer who wants it packed differently is a second instruction rather than an argument.

Type REST6 operationsBase path /api/scm/packing-instructionsPublished as /api/v1/packing-instructions

Download specification (OpenAPI 3.1) Screen: Packing Instructions

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 › Packing Instructions 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.packing_instructions · 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/packing-instructionsList packing instructions

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",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "level_no": 10,
      "quantity": "12.0000",
      "uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "child_package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "per_layer": 10
    }
  ],
  "count": 1
}

Sample request

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

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",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "level_no": 10,
  "quantity": "12.0000",
  "uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "child_package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "per_layer": 10
}

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

Sample request

curl "https://demo.tranxact.ai/api/scm/packing-instructions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/packing-instructionsCreate a packing instruction

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
item_iduuidNoItem
account_iduuidNoFor customer — A customer may want the same item packed differently, and both instructions are correct.
supplier_iduuidNoFrom supplier
warehouse_iduuidNoWarehouse
package_type_iduuidYesPacked in
level_nointegerNoLevel — 1 is innermost. Three rows describe a case in a carton on a pallet.
quantitynumericYesHow many go in one
uom_iduuidNoUnit
child_package_type_iduuidNoOf this package — For a level above the innermost: what is being counted into this one.
per_layerintegerNoPer layer
layersintegerNoLayers
allow_mixed_itemsbooleanNoMay hold more than one item
allow_mixed_lotsbooleanNoMay hold more than one lot
target_fill_pctnumericNoTarget fill %
is_defaultbooleanNoThe default for this item
valid_fromdateNoIn force from
valid_todateNoUntil
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "level_no": 10,
  "quantity": "12.0000",
  "uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "child_package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "per_layer": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/packing-instructions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","package_type_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","quantity":"12.0000","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/scm/packing-instructions/{id}Change a packing instruction

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
item_iduuidNoItem
account_iduuidNoFor customer — A customer may want the same item packed differently, and both instructions are correct.
supplier_iduuidNoFrom supplier
warehouse_iduuidNoWarehouse
package_type_iduuidYesPacked in
level_nointegerNoLevel — 1 is innermost. Three rows describe a case in a carton on a pallet.
quantitynumericYesHow many go in one
uom_iduuidNoUnit
child_package_type_iduuidNoOf this package — For a level above the innermost: what is being counted into this one.
per_layerintegerNoPer layer
layersintegerNoLayers
allow_mixed_itemsbooleanNoMay hold more than one item
allow_mixed_lotsbooleanNoMay hold more than one lot
target_fill_pctnumericNoTarget fill %
is_defaultbooleanNoThe default for this item
valid_fromdateNoIn force from
valid_todateNoUntil
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",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "level_no": 10,
  "quantity": "12.0000",
  "uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "child_package_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "per_layer": 10
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/packing-instructions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/scm/packing-instructions/{id}Delete a packing instruction

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/packing-instructions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/packing-instructions/{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/packing-instructions/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 packing instruction, 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
item_iduuidread, writeItem
account_iduuidread, writeFor customer — A customer may want the same item packed differently, and both instructions are correct.
supplier_iduuidread, writeFrom supplier
warehouse_iduuidread, writeWarehouse
package_type_iduuidread, writePacked in
level_nointegerread, writeLevel — 1 is innermost. Three rows describe a case in a carton on a pallet.
quantitynumericread, writeHow many go in one
uom_iduuidread, writeUnit
child_package_type_iduuidread, writeOf this package — For a level above the innermost: what is being counted into this one.
per_layerintegerread, writePer layer
layersintegerread, writeLayers
allow_mixed_itemsbooleanread, writeMay hold more than one item
allow_mixed_lotsbooleanread, writeMay hold more than one lot
target_fill_pctnumericread, writeTarget fill %
packaging_material_ids_uuidread onlyPackaging material ids
is_defaultbooleanread, writeThe default for this item
valid_fromdateread, writeIn force from
valid_todateread, writeUntil
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 › Packing Instructions 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.