Supply Chain · Product Configurator
Configurator · Sub-assembly Inheritance
Which of a parent model’s answers travel down to a child model, and under what name there. Without the map a sub-assembly is configured in isolation, and a 12 mm machine acquires a 10 mm axle.
/api/scm/config-inheritancePublished as /api/v1/config-inheritanceDownload specification (OpenAPI 3.1) Screen: Configurator · Sub-assembly Inheritance
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 · Sub-assembly Inheritance 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.model_inheritance · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/config-inheritanceList configurator · sub-assembly inheritance
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",
"parent_model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"child_model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_code": "PAR-000001",
"child_code": "CHI-000001",
"is_locked": true,
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/config-inheritance?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/config-inheritance/{id}Read one inheritance rule
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",
"parent_model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"child_model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_code": "PAR-000001",
"child_code": "CHI-000001",
"is_locked": true,
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/config-inheritance/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/config-inheritanceCreate a inheritance rule
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
parent_model_id | uuid | Yes | Parent model |
child_model_id | uuid | Yes | Sub-assembly model |
parent_code | text | Yes | The parent’s question code |
child_code | text | Yes | The child’s question code |
is_locked | boolean | No | The child must match the parent — Locked: a diameter that has to agree. Unlocked: a finish that may differ, where the parent’s answer is only the default. |
notes | text | No | Notes |
Sample body
{
"parent_model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"child_model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_code": "PAR-000001",
"child_code": "CHI-000001",
"is_locked": true,
"notes": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"child_model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_code": "PAR-000001",
"child_code": "CHI-000001",
"is_locked": true,
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/config-inheritance" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"parent_model_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","child_model_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","parent_code":"PAR-000001","child_code":"CHI-000001","is_locked":true,"notes":"text"}'PUT/api/scm/config-inheritance/{id}Change a inheritance rule
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 |
|---|---|---|---|
parent_model_id | uuid | Yes | Parent model |
child_model_id | uuid | Yes | Sub-assembly model |
parent_code | text | Yes | The parent’s question code |
child_code | text | Yes | The child’s question code |
is_locked | boolean | No | The child must match the parent — Locked: a diameter that has to agree. Unlocked: a finish that may differ, where the parent’s answer is only the default. |
notes | text | No | Notes |
Sample body
{
"parent_model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"child_model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"child_model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_code": "PAR-000001",
"child_code": "CHI-000001",
"is_locked": true,
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/config-inheritance/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"parent_model_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","child_model_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/scm/config-inheritance/{id}Delete a inheritance rule
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-inheritance/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/config-inheritance/{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-inheritance/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 inheritance rule, 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 |
parent_model_id | uuid | read, write | Parent model |
child_model_id | uuid | read, write | Sub-assembly model |
parent_code | text | read, write | The parent’s question code |
child_code | text | read, write | The child’s question code |
is_locked | boolean | read, write | The child must match the parent — Locked: a diameter that has to agree. Unlocked: a finish that may differ, where the parent’s answer is only the default. |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
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 · Sub-assembly Inheritance 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.