TRANXACT.AI Help

Supply Chain · Reachable by link

Item · Planning

How supply is decided and how demand is read — both sides in one row, because the planning run reads them together.

Type REST6 operationsBase path /api/scm/item-planningPublished as /api/v1/item-planning

Download specification (OpenAPI 3.1) Screen: Item · Planning

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 › Item · Planning 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.item_planning · 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

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

GET/api/scm/item-planningList item · planning

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",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "planning_method": "none",
      "make_or_buy": "make",
      "planner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "planning_category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "safety_stock_qty": "12.0000",
      "safety_stock_days": 10,
      "reorder_point": "1250.00",
      "minimum_qty": "12.0000",
      "maximum_qty": "12.0000",
      "fixed_order_qty": "12.0000",
      "economic_order_qty": "12.0000"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/item-planning?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/item-planning/{id}Read one item planning

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "planning_method": "none",
  "make_or_buy": "make",
  "planner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "planning_category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "safety_stock_qty": "12.0000",
  "safety_stock_days": 10,
  "reorder_point": "1250.00",
  "minimum_qty": "12.0000",
  "maximum_qty": "12.0000",
  "fixed_order_qty": "12.0000",
  "economic_order_qty": "12.0000"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/scm/item-planning/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/item-planningCreate a item planning

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
item_iduuidYesItem
org_unit_iduuidNoApplies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants.
planning_methodtextNoPlanning method
Allowed: none min_max reorder_point mrp mps kanban vmi subcontract make_to_order buy_to_order
make_or_buytextNoMake or buy — The procurement type. Subcontract: made by a vendor from the components on its bill, which we provide. Planning method "make_to_order" plans it only from stock and supply for the sales order.
Allowed: make buy both subcontract
planner_iduuidNoPlanner
planning_category_iduuidNoPlanning category id
safety_stock_qtynumericNoSafety stock quantity
safety_stock_daysintegerNoSafety stock (days of cover)
reorder_pointnumericNoReorder point
minimum_qtynumericNoMinimum
maximum_qtynumericNoMaximum
fixed_order_qtynumericNoFixed order qty
economic_order_qtynumericNoEconomic order quantity
order_multiplenumericNoOrder multiple
processing_lead_daysintegerNoProcessing lead days
preprocessing_lead_daysintegerNoPre-processing lead days
postprocessing_lead_daysintegerNoPost-processing lead days
cumulative_lead_daysintegerNoCumulative lead days
demand_time_fence_daysintegerNoDemand time fence (days)
planning_time_fence_daysintegerNoPlanning time fence (days)
release_time_fence_daysintegerNoRelease time fence days
forecast_methodtextNoForecast method
Allowed: none manual moving_average exponential seasonal causal collaborative
forecast_consumptionbooleanNoOrders consume the forecast — Off, and a forecast and the orders against it are counted twice.
forecast_backward_daysintegerNoForecast backward days
forecast_forward_daysintegerNoForecast forward days
demand_variabilitytextNoDemand pattern
Allowed: stable seasonal erratic lumpy new
abc_classtextNoABC class
Allowed: A B C D
xyz_classtextNoXYZ class
Allowed: X Y Z
service_level_pctnumericNoTarget service level %
is_criticalbooleanNoCritical
is_phantombooleanNoPhantom (consumed through, never stocked)
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.

Sample body

{
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "planning_method": "none",
  "make_or_buy": "make",
  "planner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "planning_method": "none",
  "make_or_buy": "make",
  "planner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "planning_category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "safety_stock_qty": "12.0000",
  "safety_stock_days": 10,
  "reorder_point": "1250.00",
  "minimum_qty": "12.0000",
  "maximum_qty": "12.0000",
  "fixed_order_qty": "12.0000",
  "economic_order_qty": "12.0000"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/item-planning" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","planning_method":"none","make_or_buy":"make","planner_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/scm/item-planning/{id}Change a item planning

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
org_unit_iduuidNoApplies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants.
planning_methodtextNoPlanning method
Allowed: none min_max reorder_point mrp mps kanban vmi subcontract make_to_order buy_to_order
make_or_buytextNoMake or buy — The procurement type. Subcontract: made by a vendor from the components on its bill, which we provide. Planning method "make_to_order" plans it only from stock and supply for the sales order.
Allowed: make buy both subcontract
planner_iduuidNoPlanner
planning_category_iduuidNoPlanning category id
safety_stock_qtynumericNoSafety stock quantity
safety_stock_daysintegerNoSafety stock (days of cover)
reorder_pointnumericNoReorder point
minimum_qtynumericNoMinimum
maximum_qtynumericNoMaximum
fixed_order_qtynumericNoFixed order qty
economic_order_qtynumericNoEconomic order quantity
order_multiplenumericNoOrder multiple
processing_lead_daysintegerNoProcessing lead days
preprocessing_lead_daysintegerNoPre-processing lead days
postprocessing_lead_daysintegerNoPost-processing lead days
cumulative_lead_daysintegerNoCumulative lead days
demand_time_fence_daysintegerNoDemand time fence (days)
planning_time_fence_daysintegerNoPlanning time fence (days)
release_time_fence_daysintegerNoRelease time fence days
forecast_methodtextNoForecast method
Allowed: none manual moving_average exponential seasonal causal collaborative
forecast_consumptionbooleanNoOrders consume the forecast — Off, and a forecast and the orders against it are counted twice.
forecast_backward_daysintegerNoForecast backward days
forecast_forward_daysintegerNoForecast forward days
demand_variabilitytextNoDemand pattern
Allowed: stable seasonal erratic lumpy new
abc_classtextNoABC class
Allowed: A B C D
xyz_classtextNoXYZ class
Allowed: X Y Z
service_level_pctnumericNoTarget service level %
is_criticalbooleanNoCritical
is_phantombooleanNoPhantom (consumed through, never stocked)
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.

Sample body

{
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "planning_method": "none",
  "make_or_buy": "make",
  "planner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "planning_category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "safety_stock_qty": "12.0000",
  "safety_stock_days": 10,
  "reorder_point": "1250.00",
  "minimum_qty": "12.0000",
  "maximum_qty": "12.0000",
  "fixed_order_qty": "12.0000",
  "economic_order_qty": "12.0000"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/item-planning/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/scm/item-planning/{id}Delete a item planning

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/item-planning/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/item-planning/{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/item-planning/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a item planning, 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
item_iduuidread, writeItem
org_unit_iduuidread, writeApplies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants.
planning_methodtextread, writePlanning method
Allowed: none min_max reorder_point mrp mps kanban vmi subcontract make_to_order buy_to_order
make_or_buytextread, writeMake or buy — The procurement type. Subcontract: made by a vendor from the components on its bill, which we provide. Planning method "make_to_order" plans it only from stock and supply for the sales order.
Allowed: make buy both subcontract
planner_iduuidread, writePlanner
planning_category_iduuidread, writePlanning category id
safety_stock_qtynumericread, writeSafety stock quantity
safety_stock_daysintegerread, writeSafety stock (days of cover)
reorder_pointnumericread, writeReorder point
minimum_qtynumericread, writeMinimum
maximum_qtynumericread, writeMaximum
fixed_order_qtynumericread, writeFixed order qty
economic_order_qtynumericread, writeEconomic order quantity
order_multiplenumericread, writeOrder multiple
processing_lead_daysintegerread, writeProcessing lead days
preprocessing_lead_daysintegerread, writePre-processing lead days
postprocessing_lead_daysintegerread, writePost-processing lead days
cumulative_lead_daysintegerread, writeCumulative lead days
demand_time_fence_daysintegerread, writeDemand time fence (days)
planning_time_fence_daysintegerread, writePlanning time fence (days)
release_time_fence_daysintegerread, writeRelease time fence days
forecast_methodtextread, writeForecast method
Allowed: none manual moving_average exponential seasonal causal collaborative
forecast_consumptionbooleanread, writeOrders consume the forecast — Off, and a forecast and the orders against it are counted twice.
forecast_backward_daysintegerread, writeForecast backward days
forecast_forward_daysintegerread, writeForecast forward days
demand_variabilitytextread, writeDemand pattern
Allowed: stable seasonal erratic lumpy new
abc_classtextread, writeABC class
Allowed: A B C D
xyz_classtextread, writeXYZ class
Allowed: X Y Z
service_level_pctnumericread, writeTarget service level %
is_criticalbooleanread, writeCritical
is_phantombooleanread, writePhantom (consumed through, never stocked)
created_attimestamp with time zoneread onlyCreated at
effective_fromdateread, writeIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateread, writeUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
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 › Item · Planning 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.