TRANXACT.AI Help

Manufacturing · Production

Production Orders

Read and maintain production orders records (mfg.production_orders).

Type REST28 operationsBase path /api/mfg/production-ordersPublished as /api/v1/production-orders

Download specification (OpenAPI 3.1) Screen: Production 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 › Production 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.production_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

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

GET/api/mfg/production-ordersList production 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",
      "order_no": "ORD-000001",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "quantity": "12.0000",
      "qty_completed": "12.0000",
      "qty_scrapped": "12.0000",
      "due_date": "2026-10-30",
      "priority": 10,
      "status": "draft",
      "source_demand": "text",
      "wip_journal_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "created_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "order_no": "ORD-000001",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000",
  "qty_completed": "12.0000",
  "qty_scrapped": "12.0000",
  "due_date": "2026-10-30",
  "priority": 10,
  "status": "draft",
  "source_demand": "text",
  "wip_journal_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
item_iduuidYesItem id
quantitynumericYesQuantity
due_datedateNoDue date
priorityintegerNoPriority (1 = highest)
statustextNoStatus
source_demandtextNoDemand reference
over_delivery_tolerance_pctnumericNoOver-delivery tolerance % — How far over the open quantity an operation may be confirmed: good + scrap + rework may be at most open × (1 + tolerance ÷ 100). 0 allows no over-delivery.
notestextNoNotes

Sample body

{
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000",
  "due_date": "2026-10-30",
  "priority": 10,
  "status": "draft",
  "source_demand": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "order_no": "ORD-000001",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000",
  "qty_completed": "12.0000",
  "qty_scrapped": "12.0000",
  "due_date": "2026-10-30",
  "priority": 10,
  "status": "draft",
  "source_demand": "text",
  "wip_journal_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/production-orders" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","quantity":"12.0000","due_date":"2026-10-30","priority":10,"status":"draft","source_demand":"text"}'
PUT/api/mfg/production-orders/{id}Change a production orders

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 id
quantitynumericYesQuantity
due_datedateNoDue date
priorityintegerNoPriority (1 = highest)
statustextNoStatus
source_demandtextNoDemand reference
over_delivery_tolerance_pctnumericNoOver-delivery tolerance % — How far over the open quantity an operation may be confirmed: good + scrap + rework may be at most open × (1 + tolerance ÷ 100). 0 allows no over-delivery.
notestextNoNotes

Sample body

{
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "order_no": "ORD-000001",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000",
  "qty_completed": "12.0000",
  "qty_scrapped": "12.0000",
  "due_date": "2026-10-30",
  "priority": 10,
  "status": "draft",
  "source_demand": "text",
  "wip_journal_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/mfg/production-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","quantity":"12.0000"}'
DELETE/api/mfg/production-orders/{id}Delete a production orders

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

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

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

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

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

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

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

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

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

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

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/production-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/issues" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/production-orders/createCreate

Request body

The keys this action reads (* = required; "one of" lists the only values):

itemId*, quantity, dueDate, priority, sourceDemand, configId

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/production-orders/create" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"itemId":"value","quantity":"value","dueDate":"value","priority":"value","sourceDemand":"value","configId":"value"}'
GET/api/mfg/production-orders/{id}/availabilityAvailability

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/production-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/availability" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/production-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):

overrideReason

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/production-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/release" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrideReason":"value"}'
POST/api/mfg/production-orders/{id}/reserve-materialsReserve materials

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/production-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reserve-materials" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/production-orders/{id}/issue-materialsIssue materials

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/production-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/issue-materials" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/production-orders/{id}/completeComplete

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

qtyGood*, qtyScrap, binId*, lotNo, serials, allocateSerials

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/production-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/complete" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"qtyGood":"value","qtyScrap":"value","binId":"value","lotNo":"value","serials":"value","allocateSerials":"value"}'
GET/api/mfg/production-orders/{id}/genealogyGenealogy

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

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

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

currency, exchangeRate

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/production-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/subcontract" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"currency":"value","exchangeRate":"value"}'
POST/api/mfg/production-orders/{id}/inspectInspect

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

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

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/production-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cost" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a production orders, 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
order_notextread onlyOrder no
item_iduuidread, writeItem id
bom_iduuidread onlyBom id
routing_iduuidread onlyRouting id
quantitynumericread, writeQuantity
qty_completednumericread onlyQty completed
qty_scrappednumericread onlyQty scrapped
due_datedateread, writeDue date
priorityintegerread, writePriority (1 = highest)
statustextread, writeStatus
source_demandtextread, writeDemand reference
wip_journal_iduuidread onlyWip journal id
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
cost_center_iduuidread onlyCost center id
profit_center_iduuidread onlyProfit center id
cancelled_attimestamp with time zoneread onlyCancelled at
cancelled_byuuidread onlyCancelled by
cancel_reasontextread onlyCancel reason
reversed_by_iduuidread onlyReversed by id
reverses_iduuidread onlyReverses id
order_typetextread onlyOrder type
qty_reworkednumericread onlyQty reworked
scheduled_starttimestamp with time zoneread onlyScheduled start
scheduled_endtimestamp with time zoneread onlyScheduled end
actual_starttimestamp with time zoneread onlyActual start
actual_endtimestamp with time zoneread onlyActual end
work_center_iduuidread onlyWork center id
recipe_iduuidread onlyRecipe id
batch_notextread onlyBatch no
output_lot_notextread onlyOutput lot no
master_schedule_iduuidread onlyMaster schedule id
planned_order_iduuidread onlyPlanned order id
kanban_card_iduuidread onlyKanban card id
sales_order_iduuidread onlySales order id
sales_order_line_iduuidread onlySales order line id
config_iduuidread onlyConfig id
account_iduuidread onlyAccount id
planned_startdateread onlyPlanned start
planned_enddateread onlyPlanned end
released_attimestamp with time zoneread onlyReleased at
released_byuuidread onlyReleased by
estimated_costnumericread onlyEstimated cost
currencytextread onlyCurrency
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
parent_order_iduuidread onlyParent order id
over_delivery_tolerance_pctnumericread, writeOver-delivery tolerance % — How far over the open quantity an operation may be confirmed: good + scrap + rework may be at most open × (1 + tolerance ÷ 100). 0 allows no over-delivery.
notestextread, writeNotes

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 › Production 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.