TRANXACT.AI Help

Supply Chain · Supply Planning

Material Requirements Planning

What a sales order needs, exploded through its bills of material and netted against stock and open supply. What is short is bought on a requisition naming the order, or made on a planned order that becomes its production order.

Type REST7 operationsBase path /api/scm/material-requirements

Download specification (OpenAPI 3.1) Screen: Material Requirements 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 › Material Requirements 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.
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/material-requirementsRead material requirements planning

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/material-requirements" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/material-requirements/sales-ordersSales orders

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/material-requirements/sales-orders" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/material-requirements/requisitionsRequisitions

Request body

The keys this action reads (* = required; "one of" lists the only values):

salesOrderId, itemIds

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/material-requirements/requisitions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"salesOrderId":"value","itemIds":"value"}'
POST/api/scm/material-requirements/planned-ordersPlanned orders

Request body

The keys this action reads (* = required; "one of" lists the only values):

salesOrderId, itemIds

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/material-requirements/planned-orders" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"salesOrderId":"value","itemIds":"value"}'
POST/api/scm/material-requirements/subcontract-requisitionsSubcontract requisitions

Request body

The keys this action reads (* = required; "one of" lists the only values):

salesOrderId, itemIds

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/material-requirements/subcontract-requisitions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"salesOrderId":"value","itemIds":"value"}'
POST/api/scm/material-requirements/fulfilmentFulfilment

Request body

The keys this action reads (* = required; "one of" lists the only values):

salesOrderId, itemId, method, supplierId, reason

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/material-requirements/fulfilment" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"salesOrderId":"value","itemId":"value","method":"value","supplierId":"value","reason":"value"}'
GET/api/scm/material-requirements/traceTrace

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/material-requirements/trace" \
  -H "Authorization: Bearer $TOKEN"

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 › Material Requirements 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.