TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/scm/item-qualityPublished as /api/v1/item-quality

Download specification (OpenAPI 3.1) Screen: Item · Quality

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 › 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.
Tablescm.item_quality · 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/item-qualityList item · quality

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

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

FieldTypeRequiredDescription
item_iduuidYesItem
org_unit_iduuidNoApplies 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_requiredbooleanNoInspection required
inspection_on_receiptbooleanNoOn receipt
inspection_on_completionbooleanNoOn completion
inspection_on_returnbooleanNoOn return
sampling_plantextNoSampling plan
Allowed: none 100_percent aql skip_lot first_article periodic
aql_leveltextNoAQL level
sample_size_pctnumericNoSample size %
specification_notextNoSpecification
drawing_notextNoDrawing
test_methodtextNoTest method
tolerance_notestextNoTolerance notes
disposition_on_failtextNoWhen it fails
Allowed: quarantine reject rework use_as_is scrap return_to_supplier
requires_coabooleanNoCertificate of analysis required
requires_cocbooleanNoCertificate of conformance required
requires_mtrbooleanNoMill test report required
is_regulatedbooleanNoRegulated
regulatory_schemetextNoRegulatory scheme — FDA, CE, UL, REACH, RoHS — whatever governs it.
shelf_life_daysintegerNoShelf life (days)
retest_interval_daysintegerNoRetest every (days)
expiry_actiontextNoOn expiry
Allowed: block warn retest scrap
criticalitytextNoCriticality
Allowed: critical major minor cosmetic
requires_first_articlebooleanNoFirst article inspection
requires_ppapbooleanNoPPAP required
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — 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

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
item_iduuidYesItem
org_unit_iduuidNoApplies 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_requiredbooleanNoInspection required
inspection_on_receiptbooleanNoOn receipt
inspection_on_completionbooleanNoOn completion
inspection_on_returnbooleanNoOn return
sampling_plantextNoSampling plan
Allowed: none 100_percent aql skip_lot first_article periodic
aql_leveltextNoAQL level
sample_size_pctnumericNoSample size %
specification_notextNoSpecification
drawing_notextNoDrawing
test_methodtextNoTest method
tolerance_notestextNoTolerance notes
disposition_on_failtextNoWhen it fails
Allowed: quarantine reject rework use_as_is scrap return_to_supplier
requires_coabooleanNoCertificate of analysis required
requires_cocbooleanNoCertificate of conformance required
requires_mtrbooleanNoMill test report required
is_regulatedbooleanNoRegulated
regulatory_schemetextNoRegulatory scheme — FDA, CE, UL, REACH, RoHS — whatever governs it.
shelf_life_daysintegerNoShelf life (days)
retest_interval_daysintegerNoRetest every (days)
expiry_actiontextNoOn expiry
Allowed: block warn retest scrap
criticalitytextNoCriticality
Allowed: critical major minor cosmetic
requires_first_articlebooleanNoFirst article inspection
requires_ppapbooleanNoPPAP required
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — 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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
item_iduuidread, writeItem
org_unit_iduuidread, writeApplies 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_requiredbooleanread, writeInspection required
inspection_on_receiptbooleanread, writeOn receipt
inspection_on_completionbooleanread, writeOn completion
inspection_on_returnbooleanread, writeOn return
sampling_plantextread, writeSampling plan
Allowed: none 100_percent aql skip_lot first_article periodic
aql_leveltextread, writeAQL level
sample_size_pctnumericread, writeSample size %
specification_notextread, writeSpecification
drawing_notextread, writeDrawing
test_methodtextread, writeTest method
tolerance_notestextread, writeTolerance notes
disposition_on_failtextread, writeWhen it fails
Allowed: quarantine reject rework use_as_is scrap return_to_supplier
requires_coabooleanread, writeCertificate of analysis required
requires_cocbooleanread, writeCertificate of conformance required
requires_mtrbooleanread, writeMill test report required
is_regulatedbooleanread, writeRegulated
regulatory_schemetextread, writeRegulatory scheme — FDA, CE, UL, REACH, RoHS — whatever governs it.
shelf_life_daysintegerread, writeShelf life (days)
retest_interval_daysintegerread, writeRetest every (days)
expiry_actiontextread, writeOn expiry
Allowed: block warn retest scrap
criticalitytextread, writeCriticality
Allowed: critical major minor cosmetic
requires_first_articlebooleanread, writeFirst article inspection
requires_ppapbooleanread, writePPAP required
created_attimestamp with time zoneread onlyCreated at
effective_fromdateread, writeIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateread, writeUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
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 › Item · Quality 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.