TRANXACT.AI Help

Manufacturing · Quality

Quality Inspections

Every inspection lot, from what was inspected — a production order, an operation or a goods receipt — through the plan’s characteristics to the result and the usage decision.

Type REST10 operationsBase path /api/mfg/quality-inspectionsPublished as /api/v1/quality-inspections

Download specification (OpenAPI 3.1) Screen: Quality Inspections

Overview

PackageManufacturing
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 Manufacturing › Quality Inspections 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.
Tablemfg.quality_inspections · 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

10 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/mfg/quality-inspectionsList quality inspections

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",
      "inspection_no": "INS-000001",
      "ref_type": "text",
      "ref_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "lot_no": "LOT-000001",
      "sample_size": "1250.00",
      "result": "text",
      "disposition": "text",
      "notes": "text",
      "inspected_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "inspected_at": "2026-10-30T09:00:00Z",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "inspection_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/mfg/quality-inspections?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/mfg/quality-inspections/{id}Read one quality inspections

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "inspection_no": "INS-000001",
  "ref_type": "text",
  "ref_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "sample_size": "1250.00",
  "result": "text",
  "disposition": "text",
  "notes": "text",
  "inspected_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "inspected_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "inspection_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

curl "https://demo.tranxact.ai/api/mfg/quality-inspections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/quality-inspectionsCreate a quality inspections

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
sample_sizenumericNoSample size
resulttextNoResult
dispositiontextNoDisposition
notestextNoNotes

Sample body

{
  "sample_size": "1250.00",
  "result": "text",
  "disposition": "text",
  "notes": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "inspection_no": "INS-000001",
  "ref_type": "text",
  "ref_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "sample_size": "1250.00",
  "result": "text",
  "disposition": "text",
  "notes": "text",
  "inspected_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "inspected_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "inspection_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/quality-inspections" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"sample_size":"1250.00","result":"text","disposition":"text","notes":"text"}'
PUT/api/mfg/quality-inspections/{id}Change a quality inspections

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
sample_sizenumericNoSample size
resulttextNoResult
dispositiontextNoDisposition
notestextNoNotes

Sample body

{
  "sample_size": "1250.00",
  "result": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "inspection_no": "INS-000001",
  "ref_type": "text",
  "ref_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "sample_size": "1250.00",
  "result": "text",
  "disposition": "text",
  "notes": "text",
  "inspected_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "inspected_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "inspection_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/mfg/quality-inspections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"sample_size":"1250.00","result":"text"}'
DELETE/api/mfg/quality-inspections/{id}Delete a quality inspections

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/mfg/quality-inspections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/quality-inspections/{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/mfg/quality-inspections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
GET/api/mfg/quality-inspections/{parentId}/linesLines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/mfg/quality-inspections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/quality-inspections/{parentId}/linesLines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

No body is required.

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/mfg/quality-inspections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/mfg/quality-inspections/{parentId}/lines/{lineId}Lines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

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 PUT "https://demo.tranxact.ai/api/mfg/quality-inspections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/mfg/quality-inspections/{parentId}/lines/{lineId}Lines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

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 DELETE "https://demo.tranxact.ai/api/mfg/quality-inspections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a quality inspections, 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
inspection_notextread onlyInspection no
ref_typetextread onlyRef type
ref_iduuidread onlyRef id
item_iduuidread onlyItem id
lot_notextread onlyLot no
sample_sizenumericread, writeSample size
resulttextread, writeResult
dispositiontextread, writeDisposition
notestextread, writeNotes
inspected_byuuidread onlyInspected by
inspected_attimestamp with time zoneread onlyInspected at
org_unit_iduuidread onlyOrg unit id
inspection_plan_iduuidread onlyInspection plan id
inspection_stagetextread onlyInspection stage
quantity_inspectednumericread onlyQuantity inspected
quantity_acceptednumericread onlyQuantity accepted
quantity_rejectednumericread onlyQuantity rejected
work_center_iduuidread onlyWork center id
supplier_iduuidread onlySupplier id
nonconformance_iduuidread onlyNonconformance id
batch_record_iduuidread onlyBatch record id
stagetextread onlyStage
statustextread onlyStatus
quantitynumericread onlyQuantity
qty_acceptednumericread onlyQty accepted
qty_rejectednumericread onlyQty rejected
receipt_iduuidread onlyReceipt id
receipt_line_iduuidread onlyReceipt line id
po_iduuidread onlyPo id
production_order_iduuidread onlyProduction order id
production_operation_iduuidread onlyProduction operation id
config_iduuidread onlyConfig id
sales_order_iduuidread onlySales order id
parent_inspection_iduuidread onlyParent inspection id
attempt_nointegerread onlyAttempt no
blocks_releasebooleanread onlyBlocks release
required_bydateread onlyRequired by
responsible_roletextread onlyResponsible role
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_attimestamp with time zoneread onlyCreated at
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 Manufacturing › Quality Inspections 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.