TRANXACT.AI Help

Supply Chain · Product Configurator

Configurator · Models

A configurable product and how a configuration of it gets made — configure, assemble, make or engineer to order.

Type REST14 operationsBase path /api/scm/config-modelsPublished as /api/v1/config-models

Download specification (OpenAPI 3.1) Screen: Configurator · Models

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 › Configurator · Models 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.
Tablecpq.models · 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

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

GET/api/scm/config-modelsList configurator · models

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",
      "model_no": "MOD-000001",
      "name": "Example",
      "description": "text",
      "base_item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "fulfilment": "cto",
      "promise_at_quote": true,
      "requires_engineering": true,
      "creates_item": true,
      "item_no_pattern": "text",
      "creates_bom": true,
      "base_bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "base_routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "model_no": "MOD-000001",
  "name": "Example",
  "description": "text",
  "base_item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fulfilment": "cto",
  "promise_at_quote": true,
  "requires_engineering": true,
  "creates_item": true,
  "item_no_pattern": "text",
  "creates_bom": true,
  "base_bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "base_routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
org_unit_iduuidNoOrg unit id
model_notextYesModel number
nametextYesName
descriptiontextNoDescription
base_item_iduuidYesBase item
fulfilmenttextNoFulfilment strategy — CTO resolves to a configured item; ATO assembles stocked sub-assemblies; MTO raises a production order; ETO needs engineering before a date can be promised.
Allowed: cto ato mto eto
promise_at_quotebooleanNoA date may be promised at quotation
requires_engineeringbooleanNoAlways needs engineering
creates_itembooleanNoResolving creates an item
item_no_patterntextNoItem no pattern
creates_bombooleanNoResolving creates a bill of material
base_bom_iduuidNoBase bill of material — The structure every configuration starts from. Leave it empty and the base item’s own current bill of material is used.
base_routing_iduuidNoBase routing id
pricing_methodtextNoPricing
Allowed: rollup base_only price_list manual cost_plus
base_pricenumericNoBase price
currencytextNoCurrency — The currency’s code, e.g. INR, USD, SAR. A currency’s name is saved as its code.
markup_pctnumericNoMarkup %
statustextNoStatus
Allowed: draft in_review released superseded withdrawn
versiontextNoVersion
owner_iduuidNoOwner id
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.
overhead_pctnumericNoOverhead % — Added to the cost of every configuration, on top of the work centers’ own overhead.
scrap_pctnumericNoScrap and yield %
freight_amountnumericNoFreight per unit
packaging_amountnumericNoPackaging per unit
creates_routingbooleanNoResolving creates a routing
default_work_center_iduuidNoDefault work center — Where an operation a rule names without a work center is done.
starts_from_base_bombooleanNoStart from the base item’s bill of material — On, a configuration begins with every component of the item this model configures and the rules add to it. Off, it begins with nothing and only what the rules and options name is in it.

Sample body

{
  "model_no": "MOD-000001",
  "name": "Example",
  "base_item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "description": "text",
  "fulfilment": "cto",
  "promise_at_quote": true
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "model_no": "MOD-000001",
  "name": "Example",
  "description": "text",
  "base_item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fulfilment": "cto",
  "promise_at_quote": true,
  "requires_engineering": true,
  "creates_item": true,
  "item_no_pattern": "text",
  "creates_bom": true,
  "base_bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "base_routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/config-models" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"model_no":"MOD-000001","name":"Example","base_item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","description":"text","fulfilment":"cto","promise_at_quote":true}'
PUT/api/scm/config-models/{id}Change a config models

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
org_unit_iduuidNoOrg unit id
model_notextYesModel number
nametextYesName
descriptiontextNoDescription
base_item_iduuidYesBase item
fulfilmenttextNoFulfilment strategy — CTO resolves to a configured item; ATO assembles stocked sub-assemblies; MTO raises a production order; ETO needs engineering before a date can be promised.
Allowed: cto ato mto eto
promise_at_quotebooleanNoA date may be promised at quotation
requires_engineeringbooleanNoAlways needs engineering
creates_itembooleanNoResolving creates an item
item_no_patterntextNoItem no pattern
creates_bombooleanNoResolving creates a bill of material
base_bom_iduuidNoBase bill of material — The structure every configuration starts from. Leave it empty and the base item’s own current bill of material is used.
base_routing_iduuidNoBase routing id
pricing_methodtextNoPricing
Allowed: rollup base_only price_list manual cost_plus
base_pricenumericNoBase price
currencytextNoCurrency — The currency’s code, e.g. INR, USD, SAR. A currency’s name is saved as its code.
markup_pctnumericNoMarkup %
statustextNoStatus
Allowed: draft in_review released superseded withdrawn
versiontextNoVersion
owner_iduuidNoOwner id
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.
overhead_pctnumericNoOverhead % — Added to the cost of every configuration, on top of the work centers’ own overhead.
scrap_pctnumericNoScrap and yield %
freight_amountnumericNoFreight per unit
packaging_amountnumericNoPackaging per unit
creates_routingbooleanNoResolving creates a routing
default_work_center_iduuidNoDefault work center — Where an operation a rule names without a work center is done.
starts_from_base_bombooleanNoStart from the base item’s bill of material — On, a configuration begins with every component of the item this model configures and the rules add to it. Off, it begins with nothing and only what the rules and options name is in it.

Sample body

{
  "model_no": "MOD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "model_no": "MOD-000001",
  "name": "Example",
  "description": "text",
  "base_item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fulfilment": "cto",
  "promise_at_quote": true,
  "requires_engineering": true,
  "creates_item": true,
  "item_no_pattern": "text",
  "creates_bom": true,
  "base_bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "base_routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/config-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"model_no":"MOD-000001","name":"Example"}'
DELETE/api/scm/config-models/{id}Delete a config models

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/config-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/config-models/{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/config-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
GET/api/scm/config-models/{parentId}/materialsMaterials

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/scm/config-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/materials" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/config-models/{parentId}/materialsMaterials

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/scm/config-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/materials" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/scm/config-models/{parentId}/materials/{lineId}Materials

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/scm/config-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/materials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/config-models/{parentId}/materials/{lineId}Materials

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/scm/config-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/materials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/config-models/{parentId}/processesProcesses

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/scm/config-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/processes" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/config-models/{parentId}/processesProcesses

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/scm/config-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/processes" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/scm/config-models/{parentId}/processes/{lineId}Processes

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/scm/config-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/processes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/config-models/{parentId}/processes/{lineId}Processes

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/scm/config-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/processes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a config models, 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, writeOrg unit id
model_notextread, writeModel number
nametextread, writeName
descriptiontextread, writeDescription
base_item_iduuidread, writeBase item
fulfilmenttextread, writeFulfilment strategy — CTO resolves to a configured item; ATO assembles stocked sub-assemblies; MTO raises a production order; ETO needs engineering before a date can be promised.
Allowed: cto ato mto eto
promise_at_quotebooleanread, writeA date may be promised at quotation
requires_engineeringbooleanread, writeAlways needs engineering
creates_itembooleanread, writeResolving creates an item
item_no_patterntextread, writeItem no pattern
creates_bombooleanread, writeResolving creates a bill of material
base_bom_iduuidread, writeBase bill of material — The structure every configuration starts from. Leave it empty and the base item’s own current bill of material is used.
base_routing_iduuidread, writeBase routing id
pricing_methodtextread, writePricing
Allowed: rollup base_only price_list manual cost_plus
base_pricenumericread, writeBase price
currencytextread, writeCurrency — The currency’s code, e.g. INR, USD, SAR. A currency’s name is saved as its code.
markup_pctnumericread, writeMarkup %
statustextread, writeStatus
Allowed: draft in_review released superseded withdrawn
versiontextread, writeVersion
owner_iduuidread, writeOwner id
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.
overhead_pctnumericread, writeOverhead % — Added to the cost of every configuration, on top of the work centers’ own overhead.
scrap_pctnumericread, writeScrap and yield %
freight_amountnumericread, writeFreight per unit
packaging_amountnumericread, writePackaging per unit
creates_routingbooleanread, writeResolving creates a routing
default_work_center_iduuidread, writeDefault work center — Where an operation a rule names without a work center is done.
starts_from_base_bombooleanread, writeStart from the base item’s bill of material — On, a configuration begins with every component of the item this model configures and the rules add to it. Off, it begins with nothing and only what the rules and options name is in it.
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 Supply Chain › Configurator · Models 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.