Supply Chain · Reachable by link
Item · Quality
When it is inspected, against what, and what happens when it fails. The flags here are what turn a receipt into quarantine.
/api/scm/item-qualityPublished as /api/v1/item-qualityOverview
| 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 · Quality 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_quality · 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-qualityList item · quality
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",
"inspection_required": true,
"inspection_on_receipt": true,
"inspection_on_completion": true,
"inspection_on_return": true,
"sampling_plan": "none",
"aql_level": "text",
"sample_size_pct": "1250.00",
"specification_no": "SPE-000001",
"drawing_no": "DRA-000001",
"test_method": "text",
"tolerance_notes": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/item-quality?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/item-quality/{id}Read one item quality
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",
"inspection_required": true,
"inspection_on_receipt": true,
"inspection_on_completion": true,
"inspection_on_return": true,
"sampling_plan": "none",
"aql_level": "text",
"sample_size_pct": "1250.00",
"specification_no": "SPE-000001",
"drawing_no": "DRA-000001",
"test_method": "text",
"tolerance_notes": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/item-quality/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/item-qualityCreate a item quality
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. |
inspection_required | boolean | No | Inspection required |
inspection_on_receipt | boolean | No | On receipt |
inspection_on_completion | boolean | No | On completion |
inspection_on_return | boolean | No | On return |
sampling_plan | text | No | Sampling plan Allowed: none 100_percent aql skip_lot first_article periodic |
aql_level | text | No | AQL level |
sample_size_pct | numeric | No | Sample size % |
specification_no | text | No | Specification |
drawing_no | text | No | Drawing |
test_method | text | No | Test method |
tolerance_notes | text | No | Tolerance notes |
disposition_on_fail | text | No | When it fails Allowed: quarantine reject rework use_as_is scrap return_to_supplier |
requires_coa | boolean | No | Certificate of analysis required |
requires_coc | boolean | No | Certificate of conformance required |
requires_mtr | boolean | No | Mill test report required |
is_regulated | boolean | No | Regulated |
regulatory_scheme | text | No | Regulatory scheme — FDA, CE, UL, REACH, RoHS — whatever governs it. |
shelf_life_days | integer | No | Shelf life (days) |
retest_interval_days | integer | No | Retest every (days) |
expiry_action | text | No | On expiry Allowed: block warn retest scrap |
criticality | text | No | Criticality Allowed: critical major minor cosmetic |
requires_first_article | boolean | No | First article inspection |
requires_ppap | boolean | No | PPAP required |
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",
"inspection_required": true,
"inspection_on_receipt": true,
"inspection_on_completion": true
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"inspection_required": true,
"inspection_on_receipt": true,
"inspection_on_completion": true,
"inspection_on_return": true,
"sampling_plan": "none",
"aql_level": "text",
"sample_size_pct": "1250.00",
"specification_no": "SPE-000001",
"drawing_no": "DRA-000001",
"test_method": "text",
"tolerance_notes": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/item-quality" \
-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","inspection_required":true,"inspection_on_receipt":true,"inspection_on_completion":true}'PUT/api/scm/item-quality/{id}Change a item quality
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. |
inspection_required | boolean | No | Inspection required |
inspection_on_receipt | boolean | No | On receipt |
inspection_on_completion | boolean | No | On completion |
inspection_on_return | boolean | No | On return |
sampling_plan | text | No | Sampling plan Allowed: none 100_percent aql skip_lot first_article periodic |
aql_level | text | No | AQL level |
sample_size_pct | numeric | No | Sample size % |
specification_no | text | No | Specification |
drawing_no | text | No | Drawing |
test_method | text | No | Test method |
tolerance_notes | text | No | Tolerance notes |
disposition_on_fail | text | No | When it fails Allowed: quarantine reject rework use_as_is scrap return_to_supplier |
requires_coa | boolean | No | Certificate of analysis required |
requires_coc | boolean | No | Certificate of conformance required |
requires_mtr | boolean | No | Mill test report required |
is_regulated | boolean | No | Regulated |
regulatory_scheme | text | No | Regulatory scheme — FDA, CE, UL, REACH, RoHS — whatever governs it. |
shelf_life_days | integer | No | Shelf life (days) |
retest_interval_days | integer | No | Retest every (days) |
expiry_action | text | No | On expiry Allowed: block warn retest scrap |
criticality | text | No | Criticality Allowed: critical major minor cosmetic |
requires_first_article | boolean | No | First article inspection |
requires_ppap | boolean | No | PPAP required |
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",
"inspection_required": true,
"inspection_on_receipt": true,
"inspection_on_completion": true,
"inspection_on_return": true,
"sampling_plan": "none",
"aql_level": "text",
"sample_size_pct": "1250.00",
"specification_no": "SPE-000001",
"drawing_no": "DRA-000001",
"test_method": "text",
"tolerance_notes": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/item-quality/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-quality/{id}Delete a item quality
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-quality/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/item-quality/{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-quality/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 quality, 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. |
inspection_required | boolean | read, write | Inspection required |
inspection_on_receipt | boolean | read, write | On receipt |
inspection_on_completion | boolean | read, write | On completion |
inspection_on_return | boolean | read, write | On return |
sampling_plan | text | read, write | Sampling plan Allowed: none 100_percent aql skip_lot first_article periodic |
aql_level | text | read, write | AQL level |
sample_size_pct | numeric | read, write | Sample size % |
specification_no | text | read, write | Specification |
drawing_no | text | read, write | Drawing |
test_method | text | read, write | Test method |
tolerance_notes | text | read, write | Tolerance notes |
disposition_on_fail | text | read, write | When it fails Allowed: quarantine reject rework use_as_is scrap return_to_supplier |
requires_coa | boolean | read, write | Certificate of analysis required |
requires_coc | boolean | read, write | Certificate of conformance required |
requires_mtr | boolean | read, write | Mill test report required |
is_regulated | boolean | read, write | Regulated |
regulatory_scheme | text | read, write | Regulatory scheme — FDA, CE, UL, REACH, RoHS — whatever governs it. |
shelf_life_days | integer | read, write | Shelf life (days) |
retest_interval_days | integer | read, write | Retest every (days) |
expiry_action | text | read, write | On expiry Allowed: block warn retest scrap |
criticality | text | read, write | Criticality Allowed: critical major minor cosmetic |
requires_first_article | boolean | read, write | First article inspection |
requires_ppap | boolean | read, write | PPAP required |
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 · Quality 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.