iotoms Docs

List production orders

GET
/api/v1/manufacturing/orders

Returns production orders, newest first, each with its component lines. Filter by status or by bill of materials (bomId); when both are sent only status is applied. Not paginated.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

status?string

Only return orders in this status: PLANNED, RELEASED, IN_PROGRESS, COMPLETED or CANCELLED.

Value in"PLANNED""RELEASED""IN_PROGRESS""COMPLETED""CLOSED""CANCELLED"
bomId?string

Only return orders for this bill of materials (see List bills of materials). Ignored when status is also sent.

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.

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?array<>|

The matching production orders, newest first, each with its component lines.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/manufacturing/orders' \  -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"    }  ]}