Supply Chain · Demand Planning
Demand Signals
Demand that is not a forecast: a signed order, a likely quotation, a weighted opportunity, a dependent requirement. One place for a planning run to read demand from, and it can say where every unit came from.
/api/scm/demand-signalsPublished as /api/v1/demand-signalsOverview
| 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 › Demand Signals 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 | scm.demand_signals · 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
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/demand-signalsList demand signals
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",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"signal_type": "sales_order",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quotation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"demand_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reference_no": "REF-000001",
"required_on": "2026-10-30"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/demand-signals?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/demand-signals/{id}Read one demand signal
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",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"signal_type": "sales_order",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quotation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"demand_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reference_no": "REF-000001",
"required_on": "2026-10-30"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/demand-signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/demand-signalsCreate a demand signal
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
item_id | uuid | Yes | Item |
warehouse_id | uuid | No | Warehouse |
location_id | uuid | No | Location id |
signal_type | text | No | Kind Allowed: sales_order quotation opportunity forecast safety_stock dependent transfer service sample contract manual |
sales_order_id | uuid | No | Sales order |
quotation_id | uuid | No | Quotation |
opportunity_id | uuid | No | Opportunity |
production_order_id | uuid | No | Production order id |
demand_plan_id | uuid | No | Demand plan id |
account_id | uuid | No | Customer |
reference_no | text | No | Reference |
required_on | date | Yes | Wanted on |
quantity | numeric | No | Quantity |
uom_id | uuid | No | Unit |
probability_pct | numeric | No | Probability % — A weighted opportunity is not a firm order and must not be planned as one. |
priority | integer | No | Priority |
is_firm | boolean | No | Firm |
consumes_forecast | boolean | No | Consumes the forecast — Without this a sold-and-forecast unit is planned twice. |
status | text | No | Status Allowed: open planned committed fulfilled cancelled expired |
Sample body
{
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"required_on": "2026-10-30",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"signal_type": "sales_order",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"signal_type": "sales_order",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quotation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"demand_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reference_no": "REF-000001",
"required_on": "2026-10-30"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/demand-signals" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","required_on":"2026-10-30","warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","signal_type":"sales_order","sales_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/scm/demand-signals/{id}Change a demand signal
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 |
|---|---|---|---|
item_id | uuid | Yes | Item |
warehouse_id | uuid | No | Warehouse |
location_id | uuid | No | Location id |
signal_type | text | No | Kind Allowed: sales_order quotation opportunity forecast safety_stock dependent transfer service sample contract manual |
sales_order_id | uuid | No | Sales order |
quotation_id | uuid | No | Quotation |
opportunity_id | uuid | No | Opportunity |
production_order_id | uuid | No | Production order id |
demand_plan_id | uuid | No | Demand plan id |
account_id | uuid | No | Customer |
reference_no | text | No | Reference |
required_on | date | Yes | Wanted on |
quantity | numeric | No | Quantity |
uom_id | uuid | No | Unit |
probability_pct | numeric | No | Probability % — A weighted opportunity is not a firm order and must not be planned as one. |
priority | integer | No | Priority |
is_firm | boolean | No | Firm |
consumes_forecast | boolean | No | Consumes the forecast — Without this a sold-and-forecast unit is planned twice. |
status | text | No | Status Allowed: open planned committed fulfilled cancelled expired |
Sample body
{
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"required_on": "2026-10-30"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"signal_type": "sales_order",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quotation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"demand_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reference_no": "REF-000001",
"required_on": "2026-10-30"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/demand-signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","required_on":"2026-10-30"}'DELETE/api/scm/demand-signals/{id}Delete a demand signal
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/demand-signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/demand-signals/{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/demand-signals/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/demand-signals/collectCollect
Request body
The keys this action reads (* = required; "one of" lists the only values):
horizonDays, includeQuotations, warehouseIdResponse
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/demand-signals/collect" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"horizonDays":"value","includeQuotations":"value","warehouseId":"value"}'Data model
Every field of a demand signal, 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 only | Org unit id |
item_id | uuid | read, write | Item |
warehouse_id | uuid | read, write | Warehouse |
location_id | uuid | read, write | Location id |
signal_type | text | read, write | Kind Allowed: sales_order quotation opportunity forecast safety_stock dependent transfer service sample contract manual |
sales_order_id | uuid | read, write | Sales order |
quotation_id | uuid | read, write | Quotation |
opportunity_id | uuid | read, write | Opportunity |
production_order_id | uuid | read, write | Production order id |
demand_plan_id | uuid | read, write | Demand plan id |
account_id | uuid | read, write | Customer |
reference_no | text | read, write | Reference |
required_on | date | read, write | Wanted on |
quantity | numeric | read, write | Quantity |
uom_id | uuid | read, write | Unit |
quantity_committed | numeric | read only | Quantity committed |
probability_pct | numeric | read, write | Probability % — A weighted opportunity is not a firm order and must not be planned as one. |
weighted_quantity | numeric | read only | Weighted quantity |
priority | integer | read, write | Priority |
is_firm | boolean | read, write | Firm |
consumes_forecast | boolean | read, write | Consumes the forecast — Without this a sold-and-forecast unit is planned twice. |
status | text | read, write | Status Allowed: open planned committed fulfilled cancelled expired |
created_at | timestamp with time zone | read only | Created at |
source_line_id | uuid | read only | Source line id |
config_id | uuid | read only | Config id |
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 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 › Demand Signals 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.