TRANXACT.AI Help

Supply Chain · Reachable by link

Item · Work Definition

How it is built: the bill of material and routing it is built against, the lot sizes, the yield and how components are consumed.

Type REST6 operationsBase path /api/scm/item-manufacturingPublished as /api/v1/item-manufacturing

Download specification (OpenAPI 3.1) Screen: Item · Work Definition

Overview

PackageSupply Chain
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 Supply Chain › Item · Work Definition 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.
Tablescm.item_manufacturing · 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/scm/item-manufacturingList item · work definition

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",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "is_manufacturable": true,
      "build_type": "standard",
      "default_bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "default_routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "standard_lot_size": "1250.00",
      "minimum_lot_size": "1250.00",
      "maximum_lot_size": "1250.00",
      "yield_pct": "1250.00",
      "scrap_pct": "1250.00",
      "supply_type": "push"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_manufacturable": true,
  "build_type": "standard",
  "default_bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "default_routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "standard_lot_size": "1250.00",
  "minimum_lot_size": "1250.00",
  "maximum_lot_size": "1250.00",
  "yield_pct": "1250.00",
  "scrap_pct": "1250.00",
  "supply_type": "push"
}

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

Sample request

curl "https://demo.tranxact.ai/api/scm/item-manufacturing/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/item-manufacturingCreate a item manufacturing

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
item_iduuidYesItem
org_unit_iduuidNoApplies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants.
is_manufacturablebooleanNoManufacturable
build_typetextNoBuild type
Allowed: standard process repetitive project configured repair
default_bom_iduuidNoDefault bill of material
default_routing_iduuidNoDefault routing
work_center_iduuidNoWork center
standard_lot_sizenumericNoStandard lot size
minimum_lot_sizenumericNoMinimum lot size
maximum_lot_sizenumericNoMaximum lot size
yield_pctnumericNoYield %
scrap_pctnumericNoScrap %
supply_typetextNoComponent supply
Allowed: push pull operation_pull bulk phantom supplier
backflushbooleanNoBackflush components
requires_inspectionbooleanNoCompletion needs inspection
shrinkage_pctnumericNoShrinkage pct
setup_hoursnumericNoSetup hours
run_hours_per_unitnumericNoRun hours per unit
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.

Sample body

{
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_manufacturable": true,
  "build_type": "standard",
  "default_bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_manufacturable": true,
  "build_type": "standard",
  "default_bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "default_routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "standard_lot_size": "1250.00",
  "minimum_lot_size": "1250.00",
  "maximum_lot_size": "1250.00",
  "yield_pct": "1250.00",
  "scrap_pct": "1250.00",
  "supply_type": "push"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/item-manufacturing" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","is_manufacturable":true,"build_type":"standard","default_bom_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/scm/item-manufacturing/{id}Change a item manufacturing

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
org_unit_iduuidNoApplies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants.
is_manufacturablebooleanNoManufacturable
build_typetextNoBuild type
Allowed: standard process repetitive project configured repair
default_bom_iduuidNoDefault bill of material
default_routing_iduuidNoDefault routing
work_center_iduuidNoWork center
standard_lot_sizenumericNoStandard lot size
minimum_lot_sizenumericNoMinimum lot size
maximum_lot_sizenumericNoMaximum lot size
yield_pctnumericNoYield %
scrap_pctnumericNoScrap %
supply_typetextNoComponent supply
Allowed: push pull operation_pull bulk phantom supplier
backflushbooleanNoBackflush components
requires_inspectionbooleanNoCompletion needs inspection
shrinkage_pctnumericNoShrinkage pct
setup_hoursnumericNoSetup hours
run_hours_per_unitnumericNoRun hours per unit
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_manufacturable": true,
  "build_type": "standard",
  "default_bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "default_routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "standard_lot_size": "1250.00",
  "minimum_lot_size": "1250.00",
  "maximum_lot_size": "1250.00",
  "yield_pct": "1250.00",
  "scrap_pct": "1250.00",
  "supply_type": "push"
}

Sample request

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

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/scm/item-manufacturing/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/item-manufacturing/{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/scm/item-manufacturing/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 item manufacturing, 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
item_iduuidread, writeItem
org_unit_iduuidread, writeApplies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants.
is_manufacturablebooleanread, writeManufacturable
build_typetextread, writeBuild type
Allowed: standard process repetitive project configured repair
default_bom_iduuidread, writeDefault bill of material
default_routing_iduuidread, writeDefault routing
work_center_iduuidread, writeWork center
standard_lot_sizenumericread, writeStandard lot size
minimum_lot_sizenumericread, writeMinimum lot size
maximum_lot_sizenumericread, writeMaximum lot size
yield_pctnumericread, writeYield %
scrap_pctnumericread, writeScrap %
supply_typetextread, writeComponent supply
Allowed: push pull operation_pull bulk phantom supplier
backflushbooleanread, writeBackflush components
requires_inspectionbooleanread, writeCompletion needs inspection
shrinkage_pctnumericread, writeShrinkage pct
setup_hoursnumericread, writeSetup hours
run_hours_per_unitnumericread, writeRun hours per unit
created_attimestamp with time zoneread onlyCreated at
effective_fromdateread, writeIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateread, writeUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
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 Supply Chain › Item · Work Definition 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.