iotoms Docs

Create a production order

POST
/api/v1/manufacturing/orders

Creates a production order in planned status for a bill of materials. The optional X-Actor header records who made the change.

How to use it

  1. Pick an active recipe from List bills of materials and the manufacturing and output locations from List inventory locations.
  2. Send bomId, plannedQty, both location IDs and plannedDate.
  3. The order is created as PLANNED with component quantities scaled from the recipe (including scrap); no stock moves yet.
  4. Next, call Release a production order.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

X-Actor?string

Name or username of the person making the change, recorded against the order and its stock movements. Defaults to "system".

Default"system"

Request Body

application/json
  1. body
bomId*string

ID of an active bill of materials to produce (see List bills of materials). Inactive recipes are rejected.

Formatuuid
plannedQty*number

Quantity of the finished product to make, in the recipe's output unit. Must be greater than 0.

manufacturingLocationId*string

Inventory location the components will be taken from when production starts (see List inventory locations).

Formatuuid
outputLocationId*string

Inventory location the finished goods will be added to on completion.

Formatuuid
plannedDate*string

Date production is planned for, YYYY-MM-DD. Also used to build the order number.

Formatdate
notes?|

Optional free-text notes for the shop floor.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was processed; otherwise an error status.

message*string

Short human-readable message describing the outcome, e.g. which record was saved or why the call failed.

data?

The production order after the call, with its component lines.

Example Request
curl -X POST 'https://beta.iotoms.com/api/v1/manufacturing/orders' \  -H 'X-TenantID: your-tenant-code' \  -H 'Content-Type: application/json' \  -d '{  "bomId": "53dce8f3-d3cc-4928-853d-2f3a84abe4b1",  "plannedQty": 0,  "manufacturingLocationId": "56275864-a2a2-4e00-8355-5fb463f05abd",  "outputLocationId": "8ac1ed53-5778-48bb-ba89-21cc9ca9c60e",  "plannedDate": "2019-08-24"}'
Example Response
{  "status": "string",  "message": "string",  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "orderNumber": "string",    "bomId": "53dce8f3-d3cc-4928-853d-2f3a84abe4b1",    "finishedGoodId": "string",    "finishedGoodName": "string",    "plannedQty": 0,    "actualQty": 0,    "status": "string",    "manufacturingLocationId": "56275864-a2a2-4e00-8355-5fb463f05abd",    "outputLocationId": "8ac1ed53-5778-48bb-ba89-21cc9ca9c60e",    "plannedDate": "2019-08-24",    "startedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "notes": "string",    "components": [      {        "id": 0,        "componentItemId": "string",        "componentItemName": "string",        "plannedQty": 0,        "actualQty": 0      }    ],    "createdAt": "2019-08-24T14:15:22Z"  }}