Supply Chain · Product Configurator
Configurator · Models
A configurable product and how a configuration of it gets made — configure, assemble, make or engineer to order.
/api/scm/config-modelsPublished as /api/v1/config-modelsDownload specification (OpenAPI 3.1) Screen: Configurator · Models
Overview
| Package | Supply Chain |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The 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. |
| Table | cpq.models · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The 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
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Required | Description |
|---|---|---|---|
org_unit_id | uuid | No | Org unit id |
model_no | text | Yes | Model number |
name | text | Yes | Name |
description | text | No | Description |
base_item_id | uuid | Yes | Base item |
fulfilment | text | No | Fulfilment 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_quote | boolean | No | A date may be promised at quotation |
requires_engineering | boolean | No | Always needs engineering |
creates_item | boolean | No | Resolving creates an item |
item_no_pattern | text | No | Item no pattern |
creates_bom | boolean | No | Resolving creates a bill of material |
base_bom_id | uuid | No | Base 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_id | uuid | No | Base routing id |
pricing_method | text | No | Pricing Allowed: rollup base_only price_list manual cost_plus |
base_price | numeric | No | Base price |
currency | text | No | Currency — The currency’s code, e.g. INR, USD, SAR. A currency’s name is saved as its code. |
markup_pct | numeric | No | Markup % |
status | text | No | Status Allowed: draft in_review released superseded withdrawn |
version | text | No | Version |
owner_id | uuid | No | Owner id |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
overhead_pct | numeric | No | Overhead % — Added to the cost of every configuration, on top of the work centers’ own overhead. |
scrap_pct | numeric | No | Scrap and yield % |
freight_amount | numeric | No | Freight per unit |
packaging_amount | numeric | No | Packaging per unit |
creates_routing | boolean | No | Resolving creates a routing |
default_work_center_id | uuid | No | Default work center — Where an operation a rule names without a work center is done. |
starts_from_base_bom | boolean | No | Start 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
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
org_unit_id | uuid | No | Org unit id |
model_no | text | Yes | Model number |
name | text | Yes | Name |
description | text | No | Description |
base_item_id | uuid | Yes | Base item |
fulfilment | text | No | Fulfilment 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_quote | boolean | No | A date may be promised at quotation |
requires_engineering | boolean | No | Always needs engineering |
creates_item | boolean | No | Resolving creates an item |
item_no_pattern | text | No | Item no pattern |
creates_bom | boolean | No | Resolving creates a bill of material |
base_bom_id | uuid | No | Base 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_id | uuid | No | Base routing id |
pricing_method | text | No | Pricing Allowed: rollup base_only price_list manual cost_plus |
base_price | numeric | No | Base price |
currency | text | No | Currency — The currency’s code, e.g. INR, USD, SAR. A currency’s name is saved as its code. |
markup_pct | numeric | No | Markup % |
status | text | No | Status Allowed: draft in_review released superseded withdrawn |
version | text | No | Version |
owner_id | uuid | No | Owner id |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
overhead_pct | numeric | No | Overhead % — Added to the cost of every configuration, on top of the work centers’ own overhead. |
scrap_pct | numeric | No | Scrap and yield % |
freight_amount | numeric | No | Freight per unit |
packaging_amount | numeric | No | Packaging per unit |
creates_routing | boolean | No | Resolving creates a routing |
default_work_center_id | uuid | No | Default work center — Where an operation a rule names without a work center is done. |
starts_from_base_bom | boolean | No | Start 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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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
| Name | Type | Description |
|---|---|---|
parentId | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read, write | Org unit id |
model_no | text | read, write | Model number |
name | text | read, write | Name |
description | text | read, write | Description |
base_item_id | uuid | read, write | Base item |
fulfilment | text | read, write | Fulfilment 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_quote | boolean | read, write | A date may be promised at quotation |
requires_engineering | boolean | read, write | Always needs engineering |
creates_item | boolean | read, write | Resolving creates an item |
item_no_pattern | text | read, write | Item no pattern |
creates_bom | boolean | read, write | Resolving creates a bill of material |
base_bom_id | uuid | read, write | Base 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_id | uuid | read, write | Base routing id |
pricing_method | text | read, write | Pricing Allowed: rollup base_only price_list manual cost_plus |
base_price | numeric | read, write | Base price |
currency | text | read, write | Currency — The currency’s code, e.g. INR, USD, SAR. A currency’s name is saved as its code. |
markup_pct | numeric | read, write | Markup % |
status | text | read, write | Status Allowed: draft in_review released superseded withdrawn |
version | text | read, write | Version |
owner_id | uuid | read, write | Owner id |
created_at | timestamp with time zone | read only | Created at |
effective_from | date | read, write | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | read, write | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
overhead_pct | numeric | read, write | Overhead % — Added to the cost of every configuration, on top of the work centers’ own overhead. |
scrap_pct | numeric | read, write | Scrap and yield % |
freight_amount | numeric | read, write | Freight per unit |
packaging_amount | numeric | read, write | Packaging per unit |
creates_routing | boolean | read, write | Resolving creates a routing |
default_work_center_id | uuid | read, write | Default work center — Where an operation a rule names without a work center is done. |
starts_from_base_bom | boolean | read, write | Start 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_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Supply Chain › Configurator · Models for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.