iotoms Docs

Start a production order

PATCH
/api/v1/manufacturing/orders/{id}/start

Moves a released order to in progress and consumes the component stock from the manufacturing location. The optional X-Actor header records who made the change.

How to use it

  1. Use the ID of a RELEASED order from List production orders.
  2. Each component's planned quantity is deducted from the manufacturing location's stock.
  3. The order moves to IN_PROGRESS and can no longer be cancelled; finish it with Complete a production order.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

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"

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 PATCH 'https://beta.iotoms.com/api/v1/manufacturing/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08/start' \  -H 'X-TenantID: your-tenant-code'
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"  }}