Supply Chain · Product Configurator
Configurator · Options
The answers. An option with an item puts a part in the product; one without is a characteristic that changes price and paperwork.
/api/scm/config-optionsPublished as /api/v1/config-optionsDownload specification (OpenAPI 3.1) Screen: Configurator · Options
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 · Options 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.options · 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-optionsList configurator · options
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",
"model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quantity": "12.0000",
"uom": "text",
"price_delta": "1250.00",
"cost_delta": "1250.00",
"lead_time_delta_days": 10,
"weight_delta_kg": "1250.00",
"is_default": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/config-options?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/config-options/{id}Read one config options
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",
"model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quantity": "12.0000",
"uom": "text",
"price_delta": "1250.00",
"cost_delta": "1250.00",
"lead_time_delta_days": 10,
"weight_delta_kg": "1250.00",
"is_default": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/config-options/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/config-optionsCreate a config options
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
model_id | uuid | Yes | Model |
class_id | uuid | Yes | Question — Choose the model first; only its questions are offered. |
code | text | Yes | Code |
name | text | Yes | Option |
description | text | No | Description |
item_id | uuid | No | Item it adds — Leave empty for a characteristic that adds no part. |
quantity | numeric | No | Quantity |
uom | text | No | Uom |
price_delta | numeric | No | Price change |
cost_delta | numeric | No | Cost change |
lead_time_delta_days | integer | No | Lead time change (days) |
weight_delta_kg | numeric | No | Weight change (kg) |
is_default | boolean | No | Chosen by default |
is_mandatory | boolean | No | Fitted as standard, cannot be removed |
forces_engineering | boolean | No | Turns the whole order into engineer-to-order — One special bracket is all it takes, and the order screen has to know. |
sort_order | integer | No | Order |
is_active | boolean | No | Active |
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. |
value_kind | text | No | The answer is a value the person enters — "To be specified": the option is chosen, and then the length, size or wording itself is typed in. Leave blank for an ordinary option. Allowed: number text |
value_label | text | No | What to ask for — e.g. Stem length |
value_uom | text | No | Unit of the value — e.g. mm |
value_min | numeric | No | Smallest allowed |
value_max | numeric | No | Largest allowed |
value_sets_quantity | boolean | No | The value is the quantity of the item it adds — 250 mm of stem becomes 250 of the pipe this option adds (times its own quantity) — priced, costed and put in the BOM. |
value_decimals | smallint | No | Decimal places allowed — For a number: 2 accepts 125.25 and refuses 125.255. Leave empty for any. |
value_max_length | smallint | No | Most characters allowed — For text, e.g. 10 for a material such as INC625 or a thread such as M33x4(M). |
value_code | text | No | Value a rule compares — What a rule reads for this answer — B for Bimetal, 6 for 6". Leave empty and the code is used. Lets two questions both have an answer “B” while their codes differ (GAUGE_TYPE-B, STEM_LOCATION-B). |
Sample body
{
"model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quantity": "12.0000",
"uom": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quantity": "12.0000",
"uom": "text",
"price_delta": "1250.00",
"cost_delta": "1250.00",
"lead_time_delta_days": 10,
"weight_delta_kg": "1250.00",
"is_default": true
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/config-options" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"model_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","class_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","code":"COD-000001","name":"Example","description":"text","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","quantity":"12.0000","uom":"text"}'PUT/api/scm/config-options/{id}Change a config options
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 |
|---|---|---|---|
model_id | uuid | Yes | Model |
class_id | uuid | Yes | Question — Choose the model first; only its questions are offered. |
code | text | Yes | Code |
name | text | Yes | Option |
description | text | No | Description |
item_id | uuid | No | Item it adds — Leave empty for a characteristic that adds no part. |
quantity | numeric | No | Quantity |
uom | text | No | Uom |
price_delta | numeric | No | Price change |
cost_delta | numeric | No | Cost change |
lead_time_delta_days | integer | No | Lead time change (days) |
weight_delta_kg | numeric | No | Weight change (kg) |
is_default | boolean | No | Chosen by default |
is_mandatory | boolean | No | Fitted as standard, cannot be removed |
forces_engineering | boolean | No | Turns the whole order into engineer-to-order — One special bracket is all it takes, and the order screen has to know. |
sort_order | integer | No | Order |
is_active | boolean | No | Active |
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. |
value_kind | text | No | The answer is a value the person enters — "To be specified": the option is chosen, and then the length, size or wording itself is typed in. Leave blank for an ordinary option. Allowed: number text |
value_label | text | No | What to ask for — e.g. Stem length |
value_uom | text | No | Unit of the value — e.g. mm |
value_min | numeric | No | Smallest allowed |
value_max | numeric | No | Largest allowed |
value_sets_quantity | boolean | No | The value is the quantity of the item it adds — 250 mm of stem becomes 250 of the pipe this option adds (times its own quantity) — priced, costed and put in the BOM. |
value_decimals | smallint | No | Decimal places allowed — For a number: 2 accepts 125.25 and refuses 125.255. Leave empty for any. |
value_max_length | smallint | No | Most characters allowed — For text, e.g. 10 for a material such as INC625 or a thread such as M33x4(M). |
value_code | text | No | Value a rule compares — What a rule reads for this answer — B for Bimetal, 6 for 6". Leave empty and the code is used. Lets two questions both have an answer “B” while their codes differ (GAUGE_TYPE-B, STEM_LOCATION-B). |
Sample body
{
"model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quantity": "12.0000",
"uom": "text",
"price_delta": "1250.00",
"cost_delta": "1250.00",
"lead_time_delta_days": 10,
"weight_delta_kg": "1250.00",
"is_default": true
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/config-options/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"model_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","class_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/scm/config-options/{id}Delete a config options
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-options/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/config-options/{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-options/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 config options, 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 |
model_id | uuid | read, write | Model |
class_id | uuid | read, write | Question — Choose the model first; only its questions are offered. |
code | text | read, write | Code |
name | text | read, write | Option |
description | text | read, write | Description |
item_id | uuid | read, write | Item it adds — Leave empty for a characteristic that adds no part. |
quantity | numeric | read, write | Quantity |
uom | text | read, write | Uom |
price_delta | numeric | read, write | Price change |
cost_delta | numeric | read, write | Cost change |
lead_time_delta_days | integer | read, write | Lead time change (days) |
weight_delta_kg | numeric | read, write | Weight change (kg) |
is_default | boolean | read, write | Chosen by default |
is_mandatory | boolean | read, write | Fitted as standard, cannot be removed |
forces_engineering | boolean | read, write | Turns the whole order into engineer-to-order — One special bracket is all it takes, and the order screen has to know. |
sort_order | integer | read, write | Order |
is_active | boolean | read, write | Active |
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. |
value_kind | text | read, write | The answer is a value the person enters — "To be specified": the option is chosen, and then the length, size or wording itself is typed in. Leave blank for an ordinary option. Allowed: number text |
value_label | text | read, write | What to ask for — e.g. Stem length |
value_uom | text | read, write | Unit of the value — e.g. mm |
value_min | numeric | read, write | Smallest allowed |
value_max | numeric | read, write | Largest allowed |
value_sets_quantity | boolean | read, write | The value is the quantity of the item it adds — 250 mm of stem becomes 250 of the pipe this option adds (times its own quantity) — priced, costed and put in the BOM. |
submodel_id | uuid | read only | Submodel id |
component_kind | text | read only | Component kind |
value_decimals | smallint | read, write | Decimal places allowed — For a number: 2 accepts 125.25 and refuses 125.255. Leave empty for any. |
value_max_length | smallint | read, write | Most characters allowed — For text, e.g. 10 for a material such as INC625 or a thread such as M33x4(M). |
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 |
value_code | text | read, write | Value a rule compares — What a rule reads for this answer — B for Bimetal, 6 for 6". Leave empty and the code is used. Lets two questions both have an answer “B” while their codes differ (GAUGE_TYPE-B, STEM_LOCATION-B). |
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 · Options 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.