iotoms Docs

List bills of materials

GET
/api/v1/manufacturing/bom

Returns all bills of materials with their components; the full list comes newest first. Pass activeOnly=true to return only active ones (in no fixed order). Not paginated.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

activeOnly?boolean

Set true to leave out retired bills of materials. Defaults to false.

Defaultfalse

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 worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?array<>|

Bills of materials, each with its components.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/manufacturing/bom' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "bomCode": "string",      "finishedGoodId": "string",      "finishedGoodName": "string",      "outputQty": 0,      "outputUom": "string",      "outputUomId": "a1ce3c18-bd7d-4aae-b28c-73065017e73f",      "isActive": true,      "notes": "string",      "components": [        {          "id": 0,          "componentItemId": "string",          "componentItemName": "string",          "requiredQty": 0,          "requiredUom": "string",          "requiredUomId": "3d172696-0779-4f75-8f59-e16f1d7b4889",          "scrapPercent": 0,          "effectiveQty": 0,          "notes": "string"        }      ],      "createdAt": "2019-08-24T14:15:22Z"    }  ]}