TRANXACT.AI Help

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.

Type REST7 operationsBase path /api/scm/demand-signalsPublished as /api/v1/demand-signals

Download specification (OpenAPI 3.1) Screen: Demand Signals

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 › 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.
Tablescm.demand_signals · 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

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

GET/api/scm/demand-signalsList demand signals

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

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

FieldTypeRequiredDescription
item_iduuidYesItem
warehouse_iduuidNoWarehouse
location_iduuidNoLocation id
signal_typetextNoKind
Allowed: sales_order quotation opportunity forecast safety_stock dependent transfer service sample contract manual
sales_order_iduuidNoSales order
quotation_iduuidNoQuotation
opportunity_iduuidNoOpportunity
production_order_iduuidNoProduction order id
demand_plan_iduuidNoDemand plan id
account_iduuidNoCustomer
reference_notextNoReference
required_ondateYesWanted on
quantitynumericNoQuantity
uom_iduuidNoUnit
probability_pctnumericNoProbability % — A weighted opportunity is not a firm order and must not be planned as one.
priorityintegerNoPriority
is_firmbooleanNoFirm
consumes_forecastbooleanNoConsumes the forecast — Without this a sold-and-forecast unit is planned twice.
statustextNoStatus
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

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
item_iduuidYesItem
warehouse_iduuidNoWarehouse
location_iduuidNoLocation id
signal_typetextNoKind
Allowed: sales_order quotation opportunity forecast safety_stock dependent transfer service sample contract manual
sales_order_iduuidNoSales order
quotation_iduuidNoQuotation
opportunity_iduuidNoOpportunity
production_order_iduuidNoProduction order id
demand_plan_iduuidNoDemand plan id
account_iduuidNoCustomer
reference_notextNoReference
required_ondateYesWanted on
quantitynumericNoQuantity
uom_iduuidNoUnit
probability_pctnumericNoProbability % — A weighted opportunity is not a firm order and must not be planned as one.
priorityintegerNoPriority
is_firmbooleanNoFirm
consumes_forecastbooleanNoConsumes the forecast — Without this a sold-and-forecast unit is planned twice.
statustextNoStatus
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

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/demand-signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/demand-signals/{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/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, warehouseId

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
item_iduuidread, writeItem
warehouse_iduuidread, writeWarehouse
location_iduuidread, writeLocation id
signal_typetextread, writeKind
Allowed: sales_order quotation opportunity forecast safety_stock dependent transfer service sample contract manual
sales_order_iduuidread, writeSales order
quotation_iduuidread, writeQuotation
opportunity_iduuidread, writeOpportunity
production_order_iduuidread, writeProduction order id
demand_plan_iduuidread, writeDemand plan id
account_iduuidread, writeCustomer
reference_notextread, writeReference
required_ondateread, writeWanted on
quantitynumericread, writeQuantity
uom_iduuidread, writeUnit
quantity_committednumericread onlyQuantity committed
probability_pctnumericread, writeProbability % — A weighted opportunity is not a firm order and must not be planned as one.
weighted_quantitynumericread onlyWeighted quantity
priorityintegerread, writePriority
is_firmbooleanread, writeFirm
consumes_forecastbooleanread, writeConsumes the forecast — Without this a sold-and-forecast unit is planned twice.
statustextread, writeStatus
Allowed: open planned committed fulfilled cancelled expired
created_attimestamp with time zoneread onlyCreated at
source_line_iduuidread onlySource line id
config_iduuidread onlyConfig id
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 › Demand Signals 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.