Manufacturing · Change Control
Change Orders
The decision, with an effectivity date, an affected-object list and a disposition for stock already made. Released only once every discipline has answered.
/api/mfg/change-ordersPublished as /api/v1/change-ordersOverview
| Package | Manufacturing |
|---|---|
| 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 Manufacturing › Change Orders 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 | mfg.change_orders · 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
20 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/mfg/change-ordersList change orders
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_no": "ORD-000001",
"title": "Example",
"description": "text",
"change_class": "minor",
"effectivity_type": "date",
"effective_from": "2026-10-30",
"effective_serial": "text",
"effective_lot": "text",
"disposition_on_hand": "use_up",
"disposition_wip": "use_up",
"disposition_in_transit": "text",
"disposition_field": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/mfg/change-orders?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/change-orders/{id}Read one change order
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_no": "ORD-000001",
"title": "Example",
"description": "text",
"change_class": "minor",
"effectivity_type": "date",
"effective_from": "2026-10-30",
"effective_serial": "text",
"effective_lot": "text",
"disposition_on_hand": "use_up",
"disposition_wip": "use_up",
"disposition_in_transit": "text",
"disposition_field": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/mfg/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/change-ordersCreate a change order
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Yes | Title |
description | text | No | Description |
change_class | text | No | Class Allowed: minor major documentation material process safety cost permanent_deviation |
effectivity_type | text | No | Effectivity Allowed: date serial lot order use_up immediate |
effective_from | date | No | Effective from |
effective_serial | text | No | Effective at serial |
effective_lot | text | No | Effective at lot |
disposition_on_hand | text | No | Stock on hand Allowed: use_up rework scrap return no_impact quarantine |
disposition_wip | text | No | Work in progress Allowed: use_up rework scrap complete_as_is no_impact |
disposition_in_transit | text | No | Disposition in transit |
disposition_field | text | No | Disposition field |
requires_requalification | boolean | No | Needs requalification |
requires_customer_approval | boolean | No | Needs customer approval |
requires_ppap | boolean | No | Needs PPAP |
requires_first_article | boolean | No | Needs a first article |
implementation_cost | numeric | No | Implementation cost |
scrap_cost | numeric | No | Scrap cost |
annual_saving | numeric | No | Annual saving |
currency | text | No | Currency |
planned_at | date | No | Planned for |
owner_id | uuid | No | Owner id |
notes | text | No | Notes |
Sample body
{
"title": "Example",
"description": "text",
"change_class": "minor",
"effectivity_type": "date",
"effective_from": "2026-10-30"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_no": "ORD-000001",
"title": "Example",
"description": "text",
"change_class": "minor",
"effectivity_type": "date",
"effective_from": "2026-10-30",
"effective_serial": "text",
"effective_lot": "text",
"disposition_on_hand": "use_up",
"disposition_wip": "use_up",
"disposition_in_transit": "text",
"disposition_field": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/change-orders" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","description":"text","change_class":"minor","effectivity_type":"date","effective_from":"2026-10-30"}'PUT/api/mfg/change-orders/{id}Change a change order
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 |
|---|---|---|---|
title | text | Yes | Title |
description | text | No | Description |
change_class | text | No | Class Allowed: minor major documentation material process safety cost permanent_deviation |
effectivity_type | text | No | Effectivity Allowed: date serial lot order use_up immediate |
effective_from | date | No | Effective from |
effective_serial | text | No | Effective at serial |
effective_lot | text | No | Effective at lot |
disposition_on_hand | text | No | Stock on hand Allowed: use_up rework scrap return no_impact quarantine |
disposition_wip | text | No | Work in progress Allowed: use_up rework scrap complete_as_is no_impact |
disposition_in_transit | text | No | Disposition in transit |
disposition_field | text | No | Disposition field |
requires_requalification | boolean | No | Needs requalification |
requires_customer_approval | boolean | No | Needs customer approval |
requires_ppap | boolean | No | Needs PPAP |
requires_first_article | boolean | No | Needs a first article |
implementation_cost | numeric | No | Implementation cost |
scrap_cost | numeric | No | Scrap cost |
annual_saving | numeric | No | Annual saving |
currency | text | No | Currency |
planned_at | date | No | Planned for |
owner_id | uuid | No | Owner id |
notes | text | No | Notes |
Sample body
{
"title": "Example",
"description": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_no": "ORD-000001",
"title": "Example",
"description": "text",
"change_class": "minor",
"effectivity_type": "date",
"effective_from": "2026-10-30",
"effective_serial": "text",
"effective_lot": "text",
"disposition_on_hand": "use_up",
"disposition_wip": "use_up",
"disposition_in_transit": "text",
"disposition_field": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/mfg/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","description":"text"}'DELETE/api/mfg/change-orders/{id}Delete a change order
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/mfg/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/change-orders/{parentId}/affectedAffected
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (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/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/affected" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/change-orders/{parentId}/affectedAffected
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (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/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/affected" \
-H "Authorization: Bearer $TOKEN"PUT/api/mfg/change-orders/{parentId}/affected/{lineId}Affected
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/affected/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/mfg/change-orders/{parentId}/affected/{lineId}Affected
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/affected/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/change-orders/{parentId}/approvalsApprovals
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (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/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approvals" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/change-orders/{parentId}/approvalsApprovals
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (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/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approvals" \
-H "Authorization: Bearer $TOKEN"PUT/api/mfg/change-orders/{parentId}/approvals/{lineId}Approvals
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approvals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/mfg/change-orders/{parentId}/approvals/{lineId}Approvals
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approvals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/change-orders/{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/mfg/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/mfg/change-orders/createCreate
Request body
The keys this action reads (* = required; "one of" lists the only values):
requestIds, requestId, title*, description, changeClass, effectivityType, effectiveFrom, dispositionOnHand, dispositionWip, ownerId; changeClass one of major|minor|documentation|material|process|safety|cost|permanent_deviation; effectivityType one of date|serial|lot|order|use_up|immediate; dispositionOnHand one of use_up|rework|scrap|return|no_impact|quarantine; dispositionWip one of use_up|rework|scrap|complete_as_is|no_impactResponse
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/change-orders/create" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"requestIds":"value","requestId":"value","title":"value","description":"value","changeClass":"value","effectivityType":"value"}'GET/api/mfg/change-orders/{id}/impactImpact
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/mfg/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/impact" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/change-orders/{id}/approveApprove
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):
decisionResponse
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/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"decision":"value"}'POST/api/mfg/change-orders/{id}/assign-approversAssign approvers
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/assign-approvers" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/change-orders/{id}/releaseRelease
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):
effectiveFromResponse
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/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/release" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"effectiveFrom":"value"}'POST/api/mfg/change-orders/{id}/implementImplement
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/implement" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a change order, 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 |
org_unit_id | uuid | read only | Org unit id |
order_no | text | read only | Order no |
title | text | read, write | Title |
description | text | read, write | Description |
change_class | text | read, write | Class Allowed: minor major documentation material process safety cost permanent_deviation |
effectivity_type | text | read, write | Effectivity Allowed: date serial lot order use_up immediate |
effective_from | date | read, write | Effective from |
effective_serial | text | read, write | Effective at serial |
effective_lot | text | read, write | Effective at lot |
disposition_on_hand | text | read, write | Stock on hand Allowed: use_up rework scrap return no_impact quarantine |
disposition_wip | text | read, write | Work in progress Allowed: use_up rework scrap complete_as_is no_impact |
disposition_in_transit | text | read, write | Disposition in transit |
disposition_field | text | read, write | Disposition field |
requires_requalification | boolean | read, write | Needs requalification |
requires_customer_approval | boolean | read, write | Needs customer approval |
requires_ppap | boolean | read, write | Needs PPAP |
requires_first_article | boolean | read, write | Needs a first article |
implementation_cost | numeric | read, write | Implementation cost |
scrap_cost | numeric | read, write | Scrap cost |
annual_saving | numeric | read, write | Annual saving |
currency | text | read, write | Currency |
planned_at | date | read, write | Planned for |
implemented_at | timestamp with time zone | read only | Implemented at |
raised_by | uuid | read only | Raised by |
owner_id | uuid | read, write | Owner id |
status | text | read only | Status |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
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 Manufacturing › Change Orders 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.