TRANXACT.AI Help

Supply Chain · Product Configurator

Configurations

What customers actually configured, what it came to, and whether it can be made yet.

Type REST19 operationsBase path /api/scm/configurationsPublished as /api/v1/configurations

Download specification (OpenAPI 3.1) Screen: Configurations

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 › 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.
Tablecpq.configurations · 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

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

GET/api/scm/configurationsList configurations

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
org_unit_iduuidNoOrg unit id
model_iduuidYesModel id
account_iduuidNoAccount id
quotation_iduuidNoQuotation id
sales_order_iduuidNoSales order id
quantitynumericNoQuantity
notestextNoNotes

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

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_iduuidYesModel id
account_iduuidNoAccount id
quotation_iduuidNoQuotation id
sales_order_iduuidNoSales order id
quantitynumericNoQuantity
notestextNoNotes

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

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

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):

optionId*, quantity, instanceNo, remove, value

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/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

NameTypeDescription
idstring (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

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

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):

accountId*, markupPct, currency, exchangeRate, unitPrice, validUntil, notes

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/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

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):

quantity, dueDate, plannedStart, plannedEnd, currency

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread, writeOrg unit id
config_notextread onlyConfig no
model_iduuidread, writeModel id
account_iduuidread, writeAccount id
quotation_iduuidread, writeQuotation id
sales_order_iduuidread, writeSales order id
quantitynumericread, writeQuantity
statustextread onlyStatus
is_completebooleanread onlyIs complete
violation_countintegerread onlyViolation count
configured_pricenumericread onlyConfigured price
configured_costnumericread onlyConfigured cost
lead_time_daysintegerread onlyLead time days
configured_weight_kgnumericread onlyConfigured weight kg
effective_fulfilmenttextread onlyEffective fulfilment
configured_item_iduuidread onlyConfigured item id
configured_bom_iduuidread onlyConfigured bom id
production_order_iduuidread onlyProduction order id
revision_iduuidread onlyRevision id
configured_attimestamp with time zoneread onlyConfigured at
configured_byuuidread onlyConfigured by
model_versiontextread onlyModel version
notestextread, writeNotes
parent_config_iduuidread onlyParent config id
parent_rule_iduuidread onlyParent rule id
structure_levelintegerread onlyStructure level
material_costnumericread onlyMaterial cost
labor_costnumericread onlyLabor cost
machine_costnumericread onlyMachine cost
setup_costnumericread onlySetup cost
outside_costnumericread onlyOutside cost
consumable_costnumericread onlyConsumable cost
packaging_costnumericread onlyPackaging cost
scrap_costnumericread onlyScrap cost
freight_costnumericread onlyFreight cost
overhead_costnumericread onlyOverhead cost
total_costnumericread onlyTotal cost
applied_markup_pctnumericread onlyApplied markup pct
quoted_pricenumericread onlyQuoted price
configured_routing_iduuidread onlyConfigured routing id
structure_resolved_attimestamp with time zoneread onlyStructure resolved at
resolve_notetextread onlyResolve note
created_attimestamp with time zoneread onlyCreated at
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 › Configurations 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.