Supply Chain · Reachable by link
Item · Lot & Serial Control
The POLICY. Whether lots and serials are demanded, how they are formed, and what may not move without them — which is what turns traceability from an intention into a control.
/api/scm/item-traceabilityPublished as /api/v1/item-traceabilityDownload specification (OpenAPI 3.1) Screen: Item · Lot & Serial Control
Overview
| 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 › Item · Lot & Serial Control 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.item_lot_serial · 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/item-traceabilityList item · lot & serial control
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",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lot_control": "none",
"lot_prefix": "text",
"lot_numbering": "manual",
"lot_uniqueness": "text",
"lot_split_allowed": true,
"lot_merge_allowed": true,
"shelf_life_control": "none",
"shelf_life_days": 10,
"expiry_warning_days": 10,
"serial_control": "none",
"serial_prefix": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/item-traceability?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/item-traceability/{id}Read one item traceability
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",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lot_control": "none",
"lot_prefix": "text",
"lot_numbering": "manual",
"lot_uniqueness": "text",
"lot_split_allowed": true,
"lot_merge_allowed": true,
"shelf_life_control": "none",
"shelf_life_days": 10,
"expiry_warning_days": 10,
"serial_control": "none",
"serial_prefix": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/item-traceability/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/item-traceabilityCreate a item traceability
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
item_id | uuid | Yes | Item |
org_unit_id | uuid | No | Applies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants. |
lot_control | text | No | Lot control Allowed: none full at_receipt at_completion optional |
lot_prefix | text | No | Lot prefix |
lot_numbering | text | No | Lot numbering Allowed: manual automatic supplier production_order date_based |
lot_uniqueness | text | No | Lot uniqueness |
lot_split_allowed | boolean | No | Lots may be split |
lot_merge_allowed | boolean | No | Lots may be merged |
shelf_life_control | text | No | Shelf life control Allowed: none shelf_life_days user_defined supplier_expiry |
shelf_life_days | integer | No | Shelf life (days) |
expiry_warning_days | integer | No | Warn this many days before expiry |
serial_control | text | No | Serial control Allowed: none at_receipt at_completion at_issue at_sale predefined |
serial_prefix | text | No | Serial prefix |
serial_numbering | text | No | Serial numbering Allowed: manual automatic supplier manufacturer |
serial_uniqueness | text | No | Serial uniqueness |
enforce_on_receipt | boolean | No | Enforce on receipt |
enforce_on_issue | boolean | No | Enforce on issue |
enforce_on_ship | boolean | No | Enforce on shipment |
enforce_on_return | boolean | No | Enforce on return |
track_genealogy | boolean | No | Track genealogy — What a recall walks. Off, and a recall is a spreadsheet exercise. |
track_at_customer | boolean | No | Track after it has shipped |
recall_class | text | No | Recall class Allowed: class_i class_ii class_iii none |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
Sample body
{
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lot_control": "none",
"lot_prefix": "text",
"lot_numbering": "manual"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lot_control": "none",
"lot_prefix": "text",
"lot_numbering": "manual",
"lot_uniqueness": "text",
"lot_split_allowed": true,
"lot_merge_allowed": true,
"shelf_life_control": "none",
"shelf_life_days": 10,
"expiry_warning_days": 10,
"serial_control": "none",
"serial_prefix": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/item-traceability" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","lot_control":"none","lot_prefix":"text","lot_numbering":"manual"}'PUT/api/scm/item-traceability/{id}Change a item traceability
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 |
|---|---|---|---|
item_id | uuid | Yes | Item |
org_unit_id | uuid | No | Applies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants. |
lot_control | text | No | Lot control Allowed: none full at_receipt at_completion optional |
lot_prefix | text | No | Lot prefix |
lot_numbering | text | No | Lot numbering Allowed: manual automatic supplier production_order date_based |
lot_uniqueness | text | No | Lot uniqueness |
lot_split_allowed | boolean | No | Lots may be split |
lot_merge_allowed | boolean | No | Lots may be merged |
shelf_life_control | text | No | Shelf life control Allowed: none shelf_life_days user_defined supplier_expiry |
shelf_life_days | integer | No | Shelf life (days) |
expiry_warning_days | integer | No | Warn this many days before expiry |
serial_control | text | No | Serial control Allowed: none at_receipt at_completion at_issue at_sale predefined |
serial_prefix | text | No | Serial prefix |
serial_numbering | text | No | Serial numbering Allowed: manual automatic supplier manufacturer |
serial_uniqueness | text | No | Serial uniqueness |
enforce_on_receipt | boolean | No | Enforce on receipt |
enforce_on_issue | boolean | No | Enforce on issue |
enforce_on_ship | boolean | No | Enforce on shipment |
enforce_on_return | boolean | No | Enforce on return |
track_genealogy | boolean | No | Track genealogy — What a recall walks. Off, and a recall is a spreadsheet exercise. |
track_at_customer | boolean | No | Track after it has shipped |
recall_class | text | No | Recall class Allowed: class_i class_ii class_iii none |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
Sample body
{
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lot_control": "none",
"lot_prefix": "text",
"lot_numbering": "manual",
"lot_uniqueness": "text",
"lot_split_allowed": true,
"lot_merge_allowed": true,
"shelf_life_control": "none",
"shelf_life_days": 10,
"expiry_warning_days": 10,
"serial_control": "none",
"serial_prefix": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/item-traceability/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/scm/item-traceability/{id}Delete a item traceability
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/item-traceability/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/item-traceability/{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/item-traceability/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 item traceability, 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 |
item_id | uuid | read, write | Item |
org_unit_id | uuid | read, write | Applies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants. |
lot_control | text | read, write | Lot control Allowed: none full at_receipt at_completion optional |
lot_prefix | text | read, write | Lot prefix |
lot_numbering | text | read, write | Lot numbering Allowed: manual automatic supplier production_order date_based |
lot_uniqueness | text | read, write | Lot uniqueness |
lot_split_allowed | boolean | read, write | Lots may be split |
lot_merge_allowed | boolean | read, write | Lots may be merged |
shelf_life_control | text | read, write | Shelf life control Allowed: none shelf_life_days user_defined supplier_expiry |
shelf_life_days | integer | read, write | Shelf life (days) |
expiry_warning_days | integer | read, write | Warn this many days before expiry |
serial_control | text | read, write | Serial control Allowed: none at_receipt at_completion at_issue at_sale predefined |
serial_prefix | text | read, write | Serial prefix |
serial_numbering | text | read, write | Serial numbering Allowed: manual automatic supplier manufacturer |
serial_uniqueness | text | read, write | Serial uniqueness |
enforce_on_receipt | boolean | read, write | Enforce on receipt |
enforce_on_issue | boolean | read, write | Enforce on issue |
enforce_on_ship | boolean | read, write | Enforce on shipment |
enforce_on_return | boolean | read, write | Enforce on return |
track_genealogy | boolean | read, write | Track genealogy — What a recall walks. Off, and a recall is a spreadsheet exercise. |
track_at_customer | boolean | read, write | Track after it has shipped |
recall_class | text | read, write | Recall class Allowed: class_i class_ii class_iii none |
created_at | timestamp with time zone | read only | Created at |
effective_from | date | read, write | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | read, write | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
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 › Item · Lot & Serial Control 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.