TRANXACT.AI Help

Manufacturing · Engineering

Production Versions

Which bill of material, routing and fulfilment (make, buy, subcontract) an item is made with, chosen by the configuration attributes on the sales order line. MRP plans each order line on the version its attributes match.

Type REST6 operationsBase path /api/mfg/production-versionsPublished as /api/v1/production-versions

Download specification (OpenAPI 3.1) Screen: Production Versions

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 Versions 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_versions · 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/mfg/production-versionsList production versions

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",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "version_code": "VER-000001",
      "name": "Example",
      "bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "fulfilment": "make",
      "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "attributes": {},
      "priority": 10,
      "is_default": true,
      "valid_from": "2026-10-30",
      "valid_to": "2026-10-30"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "version_code": "VER-000001",
  "name": "Example",
  "bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fulfilment": "make",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "attributes": {},
  "priority": 10,
  "is_default": true,
  "valid_from": "2026-10-30",
  "valid_to": "2026-10-30"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
item_iduuidYesItem
version_codetextYesVersion — e.g. ZN for the zinc-nickel coating
nametextNoName
bom_iduuidNoBill of material — Empty: the item’s default bill.
routing_iduuidNoRouting — Empty: the item’s default routing.
fulfilmenttextNoFulfilment — Empty: the item’s own procurement type. Subcontract: a vendor makes it from the components on the bill, which are provided.
Allowed: make buy subcontract
supplier_iduuidNoVendor — Who buys out or subcontracts it on this version.
attributesjsonbNoAttribute conditions — Every name here must equal the order line’s attribute, e.g. {"coating": "zinc-nickel"}. Empty: any line.
priorityintegerNoPriority — Lower wins when two versions match equally.
is_defaultbooleanNoDefault — The version New production order takes when the quantity fits more than one. An item has one default.
valid_fromdateNoValid from
valid_todateNoValid to
statustextNoStatus
Allowed: active inactive
notestextNoNotes

Sample body

{
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "version_code": "VER-000001",
  "name": "Example",
  "bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fulfilment": "make"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "version_code": "VER-000001",
  "name": "Example",
  "bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fulfilment": "make",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "attributes": {},
  "priority": 10,
  "is_default": true,
  "valid_from": "2026-10-30",
  "valid_to": "2026-10-30"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/production-versions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","version_code":"VER-000001","name":"Example","bom_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","routing_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","fulfilment":"make"}'
PUT/api/mfg/production-versions/{id}Change a production version

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
version_codetextYesVersion — e.g. ZN for the zinc-nickel coating
nametextNoName
bom_iduuidNoBill of material — Empty: the item’s default bill.
routing_iduuidNoRouting — Empty: the item’s default routing.
fulfilmenttextNoFulfilment — Empty: the item’s own procurement type. Subcontract: a vendor makes it from the components on the bill, which are provided.
Allowed: make buy subcontract
supplier_iduuidNoVendor — Who buys out or subcontracts it on this version.
attributesjsonbNoAttribute conditions — Every name here must equal the order line’s attribute, e.g. {"coating": "zinc-nickel"}. Empty: any line.
priorityintegerNoPriority — Lower wins when two versions match equally.
is_defaultbooleanNoDefault — The version New production order takes when the quantity fits more than one. An item has one default.
valid_fromdateNoValid from
valid_todateNoValid to
statustextNoStatus
Allowed: active inactive
notestextNoNotes

Sample body

{
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "version_code": "VER-000001"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "version_code": "VER-000001",
  "name": "Example",
  "bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fulfilment": "make",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "attributes": {},
  "priority": 10,
  "is_default": true,
  "valid_from": "2026-10-30",
  "valid_to": "2026-10-30"
}

Sample request

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

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-versions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/production-versions/{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-versions/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 production version, 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
item_iduuidread, writeItem
version_codetextread, writeVersion — e.g. ZN for the zinc-nickel coating
nametextread, writeName
bom_iduuidread, writeBill of material — Empty: the item’s default bill.
routing_iduuidread, writeRouting — Empty: the item’s default routing.
fulfilmenttextread, writeFulfilment — Empty: the item’s own procurement type. Subcontract: a vendor makes it from the components on the bill, which are provided.
Allowed: make buy subcontract
supplier_iduuidread, writeVendor — Who buys out or subcontracts it on this version.
attributesjsonbread, writeAttribute conditions — Every name here must equal the order line’s attribute, e.g. {"coating": "zinc-nickel"}. Empty: any line.
priorityintegerread, writePriority — Lower wins when two versions match equally.
is_defaultbooleanread, writeDefault — The version New production order takes when the quantity fits more than one. An item has one default.
valid_fromdateread, writeValid from
valid_todateread, writeValid to
statustextread, writeStatus
Allowed: active inactive
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 Versions 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.