TRANXACT.AI Help

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.

Type REST20 operationsBase path /api/mfg/change-ordersPublished as /api/v1/change-orders

Download specification (OpenAPI 3.1) Screen: Change Orders

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 › 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.
Tablemfg.change_orders · 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

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

GET/api/mfg/change-ordersList change orders

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

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

FieldTypeRequiredDescription
titletextYesTitle
descriptiontextNoDescription
change_classtextNoClass
Allowed: minor major documentation material process safety cost permanent_deviation
effectivity_typetextNoEffectivity
Allowed: date serial lot order use_up immediate
effective_fromdateNoEffective from
effective_serialtextNoEffective at serial
effective_lottextNoEffective at lot
disposition_on_handtextNoStock on hand
Allowed: use_up rework scrap return no_impact quarantine
disposition_wiptextNoWork in progress
Allowed: use_up rework scrap complete_as_is no_impact
disposition_in_transittextNoDisposition in transit
disposition_fieldtextNoDisposition field
requires_requalificationbooleanNoNeeds requalification
requires_customer_approvalbooleanNoNeeds customer approval
requires_ppapbooleanNoNeeds PPAP
requires_first_articlebooleanNoNeeds a first article
implementation_costnumericNoImplementation cost
scrap_costnumericNoScrap cost
annual_savingnumericNoAnnual saving
currencytextNoCurrency
planned_atdateNoPlanned for
owner_iduuidNoOwner id
notestextNoNotes

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

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
titletextYesTitle
descriptiontextNoDescription
change_classtextNoClass
Allowed: minor major documentation material process safety cost permanent_deviation
effectivity_typetextNoEffectivity
Allowed: date serial lot order use_up immediate
effective_fromdateNoEffective from
effective_serialtextNoEffective at serial
effective_lottextNoEffective at lot
disposition_on_handtextNoStock on hand
Allowed: use_up rework scrap return no_impact quarantine
disposition_wiptextNoWork in progress
Allowed: use_up rework scrap complete_as_is no_impact
disposition_in_transittextNoDisposition in transit
disposition_fieldtextNoDisposition field
requires_requalificationbooleanNoNeeds requalification
requires_customer_approvalbooleanNoNeeds customer approval
requires_ppapbooleanNoNeeds PPAP
requires_first_articlebooleanNoNeeds a first article
implementation_costnumericNoImplementation cost
scrap_costnumericNoScrap cost
annual_savingnumericNoAnnual saving
currencytextNoCurrency
planned_atdateNoPlanned for
owner_iduuidNoOwner id
notestextNoNotes

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

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/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/mfg/change-orders/{parentId}/affectedAffected

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/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/affected" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/change-orders/{parentId}/affectedAffected

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

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/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

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/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

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/change-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approvals" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/change-orders/{parentId}/approvalsApprovals

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

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/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

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/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

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/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_impact

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/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

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

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):

decision

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/approve" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"decision":"value"}'
POST/api/mfg/change-orders/{id}/assign-approversAssign approvers

Path parameters

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

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):

effectiveFrom

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/release" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"effectiveFrom":"value"}'
POST/api/mfg/change-orders/{id}/implementImplement

Path parameters

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
order_notextread onlyOrder no
titletextread, writeTitle
descriptiontextread, writeDescription
change_classtextread, writeClass
Allowed: minor major documentation material process safety cost permanent_deviation
effectivity_typetextread, writeEffectivity
Allowed: date serial lot order use_up immediate
effective_fromdateread, writeEffective from
effective_serialtextread, writeEffective at serial
effective_lottextread, writeEffective at lot
disposition_on_handtextread, writeStock on hand
Allowed: use_up rework scrap return no_impact quarantine
disposition_wiptextread, writeWork in progress
Allowed: use_up rework scrap complete_as_is no_impact
disposition_in_transittextread, writeDisposition in transit
disposition_fieldtextread, writeDisposition field
requires_requalificationbooleanread, writeNeeds requalification
requires_customer_approvalbooleanread, writeNeeds customer approval
requires_ppapbooleanread, writeNeeds PPAP
requires_first_articlebooleanread, writeNeeds a first article
implementation_costnumericread, writeImplementation cost
scrap_costnumericread, writeScrap cost
annual_savingnumericread, writeAnnual saving
currencytextread, writeCurrency
planned_atdateread, writePlanned for
implemented_attimestamp with time zoneread onlyImplemented at
raised_byuuidread onlyRaised by
owner_iduuidread, writeOwner id
statustextread onlyStatus
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
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 Manufacturing › Change Orders 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.