Supply Chain · Product Configurator
Configurations
What customers actually configured, what it came to, and whether it can be made yet.
/api/scm/configurationsPublished as /api/v1/configurationsOverview
| 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 › Configurations 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.configurations · 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
19 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/configurationsList configurations
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",
"config_no": "CON-000001",
"model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quotation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quantity": "12.0000",
"status": "draft",
"is_complete": true,
"violation_count": 10,
"configured_price": "1250.00",
"configured_cost": "1250.00",
"lead_time_days": 10
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/configurations?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/configurations/{id}Read one configurations
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",
"config_no": "CON-000001",
"model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quotation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quantity": "12.0000",
"status": "draft",
"is_complete": true,
"violation_count": 10,
"configured_price": "1250.00",
"configured_cost": "1250.00",
"lead_time_days": 10
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/configurations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/configurationsCreate a configurations
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
org_unit_id | uuid | No | Org unit id |
model_id | uuid | Yes | Model id |
account_id | uuid | No | Account id |
quotation_id | uuid | No | Quotation id |
sales_order_id | uuid | No | Sales order id |
quantity | numeric | No | Quantity |
notes | text | No | Notes |
Sample body
{
"model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quotation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"config_no": "CON-000001",
"model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quotation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quantity": "12.0000",
"status": "draft",
"is_complete": true,
"violation_count": 10,
"configured_price": "1250.00",
"configured_cost": "1250.00",
"lead_time_days": 10
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/configurations" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"model_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","quotation_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","sales_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/scm/configurations/{id}Change a configurations
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_id | uuid | Yes | Model id |
account_id | uuid | No | Account id |
quotation_id | uuid | No | Quotation id |
sales_order_id | uuid | No | Sales order id |
quantity | numeric | No | Quantity |
notes | text | No | Notes |
Sample body
{
"model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"config_no": "CON-000001",
"model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quotation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quantity": "12.0000",
"status": "draft",
"is_complete": true,
"violation_count": 10,
"configured_price": "1250.00",
"configured_cost": "1250.00",
"lead_time_days": 10
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/configurations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"model_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/scm/configurations/{id}Delete a configurations
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/configurations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/configurations/import-templateImport template
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/configurations/import-template" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/configurations/importImport
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/configurations/import" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/configurations/{id}/pricePrice
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/configurations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/price" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/configurations/{id}/cost-priceCost price
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/configurations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cost-price" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/configurations/{id}/selectSelect
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):
optionId*, quantity, instanceNo, remove, valueResponse
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/configurations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/select" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"optionId":"value","quantity":"value","instanceNo":"value","remove":"value","value":"value"}'POST/api/scm/configurations/{id}/resolveResolve
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/configurations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/resolve" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/configurations/{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/configurations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/scm/configurations/{id}/resolve-structureResolve structure
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/configurations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/resolve-structure" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/configurations/{id}/structureStructure
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/configurations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/structure" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/configurations/{id}/explosionExplosion
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/configurations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/explosion" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/configurations/{id}/previewPreview
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/configurations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/preview" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/configurations/{id}/explainExplain
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/configurations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/explain" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/configurations/{id}/quoteQuote
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):
accountId*, markupPct, currency, exchangeRate, unitPrice, validUntil, notesResponse
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/configurations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/quote" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"accountId":"value","markupPct":"value","currency":"value","exchangeRate":"value","unitPrice":"value","validUntil":"value"}'POST/api/scm/configurations/{id}/production-orderProduction order
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):
quantity, dueDate, plannedStart, plannedEnd, currencyResponse
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/configurations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/production-order" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"quantity":"value","dueDate":"value","plannedStart":"value","plannedEnd":"value","currency":"value"}'Data model
Every field of a configurations, 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 |
config_no | text | read only | Config no |
model_id | uuid | read, write | Model id |
account_id | uuid | read, write | Account id |
quotation_id | uuid | read, write | Quotation id |
sales_order_id | uuid | read, write | Sales order id |
quantity | numeric | read, write | Quantity |
status | text | read only | Status |
is_complete | boolean | read only | Is complete |
violation_count | integer | read only | Violation count |
configured_price | numeric | read only | Configured price |
configured_cost | numeric | read only | Configured cost |
lead_time_days | integer | read only | Lead time days |
configured_weight_kg | numeric | read only | Configured weight kg |
effective_fulfilment | text | read only | Effective fulfilment |
configured_item_id | uuid | read only | Configured item id |
configured_bom_id | uuid | read only | Configured bom id |
production_order_id | uuid | read only | Production order id |
revision_id | uuid | read only | Revision id |
configured_at | timestamp with time zone | read only | Configured at |
configured_by | uuid | read only | Configured by |
model_version | text | read only | Model version |
notes | text | read, write | Notes |
parent_config_id | uuid | read only | Parent config id |
parent_rule_id | uuid | read only | Parent rule id |
structure_level | integer | read only | Structure level |
material_cost | numeric | read only | Material cost |
labor_cost | numeric | read only | Labor cost |
machine_cost | numeric | read only | Machine cost |
setup_cost | numeric | read only | Setup cost |
outside_cost | numeric | read only | Outside cost |
consumable_cost | numeric | read only | Consumable cost |
packaging_cost | numeric | read only | Packaging cost |
scrap_cost | numeric | read only | Scrap cost |
freight_cost | numeric | read only | Freight cost |
overhead_cost | numeric | read only | Overhead cost |
total_cost | numeric | read only | Total cost |
applied_markup_pct | numeric | read only | Applied markup pct |
quoted_price | numeric | read only | Quoted price |
configured_routing_id | uuid | read only | Configured routing id |
structure_resolved_at | timestamp with time zone | read only | Structure resolved at |
resolve_note | text | read only | Resolve note |
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 › Configurations 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.