iotoms Docs

Calculate material requirements for a BOM

GET
/api/v1/manufacturing/bom/{id}/explode

Scales a bill of materials to a planned qty and returns each component's required quantity, including scrap, against stock on hand. Pass locationId to check one location instead of all, and see any shortfall. Read only.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

Query Parameters

qty*number

Planned quantity of the finished product to make, in the bill's output unit. Required; must be greater than zero.

locationId?string

Stockroom to check stock at, from List inventory locations. Leave out to check total stock across all stockrooms.

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

message*string

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

data?

Material requirements for the planned output quantity, with stock on hand and shortfall per component.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/manufacturing/bom/497f6eca-6276-4993-bfeb-53cbbbba6f08/explode?qty=0' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "bomId": "53dce8f3-d3cc-4928-853d-2f3a84abe4b1",    "finishedGoodId": "string",    "finishedGoodName": "string",    "plannedOutputQty": 0,    "components": [      {        "componentItemId": "string",        "componentItemName": "string",        "requiredQty": 0,        "effectiveQty": 0,        "currentQoh": 0,        "shortfallQty": 0,        "isSufficient": true      }    ]  }}