Supply Chain · Supply Planning
Supply Plans
What would have to happen for the demand to be met. An INFINITE run assumes the factory can do whatever the plan asks; a FINITE one does not, and comparing them is exactly how a planner finds the bottleneck.
/api/scm/supply-plansPublished as /api/v1/supply-plansOverview
| 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 › Supply Plans 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.supply_plans · 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
17 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/supply-plansList supply plans
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",
"plan_no": "PLA-000001",
"name": "Example",
"plan_type": "mrp",
"capacity_mode": "text",
"scheduling_direction": "forward",
"demand_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bucket": "day",
"horizon_from": "2026-10-30",
"horizon_to": "2026-10-30",
"frozen_until": "2026-10-30",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/supply-plans?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/supply-plans/{id}Read one supply plan
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",
"plan_no": "PLA-000001",
"name": "Example",
"plan_type": "mrp",
"capacity_mode": "text",
"scheduling_direction": "forward",
"demand_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bucket": "day",
"horizon_from": "2026-10-30",
"horizon_to": "2026-10-30",
"frozen_until": "2026-10-30",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/supply-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/supply-plansCreate a supply plan
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
plan_type | text | No | Type Allowed: mrp mps drp rough_cut simulation what_if |
capacity_mode | text | No | Capacity — Infinite is fast and optimistic. Finite respects the calendars and pushes work later rather than pretending. |
scheduling_direction | text | No | Scheduled Allowed: forward backward bidirectional |
demand_plan_id | uuid | No | Demand plan |
bucket | text | No | Grain Allowed: day week month |
horizon_from | date | Yes | Plan from |
horizon_to | date | Yes | Plan to |
frozen_until | date | No | Frozen until — Inside this window the plan changes nothing, because the work has started. Without it a re-run reschedules the job that is on the machine right now. |
warehouse_id | uuid | No | Warehouse |
location_id | uuid | No | Location |
item_category | text | No | Category |
include_forecast | boolean | No | Include the forecast |
include_safety_stock | boolean | No | Respect safety stock |
include_in_transit | boolean | No | Count what is already on order |
respect_lot_sizing | boolean | No | Apply lot sizing |
currency | text | No | Currency |
is_simulation | boolean | No | A what-if — may not be firmed |
compares_to_id | uuid | No | Compare against |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"horizon_from": "2026-10-30",
"horizon_to": "2026-10-30",
"plan_type": "mrp",
"capacity_mode": "text",
"scheduling_direction": "forward",
"demand_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_no": "PLA-000001",
"name": "Example",
"plan_type": "mrp",
"capacity_mode": "text",
"scheduling_direction": "forward",
"demand_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bucket": "day",
"horizon_from": "2026-10-30",
"horizon_to": "2026-10-30",
"frozen_until": "2026-10-30",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/supply-plans" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","horizon_from":"2026-10-30","horizon_to":"2026-10-30","plan_type":"mrp","capacity_mode":"text","scheduling_direction":"forward","demand_plan_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/scm/supply-plans/{id}Change a supply plan
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 |
|---|---|---|---|
name | text | Yes | Name |
plan_type | text | No | Type Allowed: mrp mps drp rough_cut simulation what_if |
capacity_mode | text | No | Capacity — Infinite is fast and optimistic. Finite respects the calendars and pushes work later rather than pretending. |
scheduling_direction | text | No | Scheduled Allowed: forward backward bidirectional |
demand_plan_id | uuid | No | Demand plan |
bucket | text | No | Grain Allowed: day week month |
horizon_from | date | Yes | Plan from |
horizon_to | date | Yes | Plan to |
frozen_until | date | No | Frozen until — Inside this window the plan changes nothing, because the work has started. Without it a re-run reschedules the job that is on the machine right now. |
warehouse_id | uuid | No | Warehouse |
location_id | uuid | No | Location |
item_category | text | No | Category |
include_forecast | boolean | No | Include the forecast |
include_safety_stock | boolean | No | Respect safety stock |
include_in_transit | boolean | No | Count what is already on order |
respect_lot_sizing | boolean | No | Apply lot sizing |
currency | text | No | Currency |
is_simulation | boolean | No | A what-if — may not be firmed |
compares_to_id | uuid | No | Compare against |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"horizon_from": "2026-10-30"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_no": "PLA-000001",
"name": "Example",
"plan_type": "mrp",
"capacity_mode": "text",
"scheduling_direction": "forward",
"demand_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bucket": "day",
"horizon_from": "2026-10-30",
"horizon_to": "2026-10-30",
"frozen_until": "2026-10-30",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/supply-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","horizon_from":"2026-10-30"}'DELETE/api/scm/supply-plans/{id}Delete a supply plan
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/supply-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/supply-plans/{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/supply-plans/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/supply-plans/{id}/runRun
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/supply-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/run" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/supply-plans/{id}/firm-batchFirm batch
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):
plannedOrderIds, supplyType, throughDateResponse
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/supply-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/firm-batch" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"plannedOrderIds":"value","supplyType":"value","throughDate":"value"}'POST/api/scm/supply-plans/{id}/releaseRelease
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/supply-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/release" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/supply-plans/{parentId}/ordersOrders
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/supply-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/orders" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/supply-plans/{parentId}/ordersOrders
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, 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/supply-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/orders" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/supply-plans/{parentId}/orders/{lineId}Orders
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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 PUT "https://demo.tranxact.ai/api/scm/supply-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/supply-plans/{parentId}/orders/{lineId}Orders
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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 DELETE "https://demo.tranxact.ai/api/scm/supply-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/supply-plans/{parentId}/exceptionsExceptions
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/supply-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/exceptions" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/supply-plans/{parentId}/exceptionsExceptions
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, 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/supply-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/exceptions" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/supply-plans/{parentId}/exceptions/{lineId}Exceptions
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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 PUT "https://demo.tranxact.ai/api/scm/supply-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/exceptions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/supply-plans/{parentId}/exceptions/{lineId}Exceptions
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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 DELETE "https://demo.tranxact.ai/api/scm/supply-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/exceptions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a supply plan, 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 |
plan_no | text | read only | Plan no |
name | text | read, write | Name |
plan_type | text | read, write | Type Allowed: mrp mps drp rough_cut simulation what_if |
capacity_mode | text | read, write | Capacity — Infinite is fast and optimistic. Finite respects the calendars and pushes work later rather than pretending. |
scheduling_direction | text | read, write | Scheduled Allowed: forward backward bidirectional |
demand_plan_id | uuid | read, write | Demand plan |
bucket | text | read, write | Grain Allowed: day week month |
horizon_from | date | read, write | Plan from |
horizon_to | date | read, write | Plan to |
frozen_until | date | read, write | Frozen until — Inside this window the plan changes nothing, because the work has started. Without it a re-run reschedules the job that is on the machine right now. |
warehouse_id | uuid | read, write | Warehouse |
location_id | uuid | read, write | Location |
item_category | text | read, write | Category |
include_forecast | boolean | read, write | Include the forecast |
include_safety_stock | boolean | read, write | Respect safety stock |
include_in_transit | boolean | read, write | Count what is already on order |
respect_lot_sizing | boolean | read, write | Apply lot sizing |
items_planned | integer | read only | Items planned |
orders_proposed | integer | read only | Orders proposed |
orders_firmed | integer | read only | Orders firmed |
exceptions_raised | integer | read only | Exceptions raised |
capacity_overloaded_periods | integer | read only | Capacity overloaded periods |
total_value | numeric | read only | Total value |
currency | text | read, write | Currency |
run_started_at | timestamp with time zone | read only | Run started at |
run_finished_at | timestamp with time zone | read only | Run finished at |
run_by | uuid | read only | Run by |
is_simulation | boolean | read, write | A what-if — may not be firmed |
compares_to_id | uuid | read, write | Compare against |
status | text | read only | Status |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
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 |
released_by | uuid | read only | Released by |
released_at | timestamp with time zone | read only | Released at |
is_automatic | boolean | read only | Is automatic |
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 › Supply Plans 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.