Retrieve an item's effective bill of materials and current build capacity
The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.
A primary item returns its local BOM. A first-class variant returns the primary BOM with its sparse removals, replacements, and variant-only slots applied.
bearerAuthAuthorizationBearer <inv_ token>id*stringuuidX-Organization-ID?stringOrganization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.
uuidBill of materials with component availability
application/json- response
resource*components*array<>buildableQuantity*integer0 <= valueinheritance*|nullcurl -X GET 'https://inventory.example.com/api/v1/resources/497f6eca-6276-4993-bfeb-53cbbbba6f08/bom'{ "resource": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "quantity": 0, "trackingMode": "bulk" }, "components": [ { "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6", "resourceIds": [ "195224a6-1e4c-49ac-860d-ffd7b0578a56" ], "targetSelectionMode": "all", "allowVariantSelection": true, "quantityPerAssembly": 1, "position": 0, "note": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "slotKey": "string", "origin": "local", "name": "string", "sku": "string", "availableQuantity": 0, "trackingMode": "bulk", "cover": { "url": "string", "altText": "string" }, "availableUnits": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "code": "string", "location": "string" } ], "choices": [ { "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6", "name": "string", "sku": "string", "availableQuantity": 0, "trackingMode": "bulk", "cover": { "url": "string", "altText": "string" }, "availableUnits": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "code": "string", "location": "string" } ], "isPrimary": true } ] } ], "buildableQuantity": 0, "inheritance": { "primaryResourceId": "78ec449b-98ae-431f-8d08-a3d237c7494b", "primaryName": "string", "overrideCount": 0 }}Reset a variant's bill of materials to its primary item DELETE
Removes manual BOM overrides for a linked first-class variant while preserving configured component selections. Primary and standalone items cannot use this operation.
Replace an item's effective bill of materials PUT
Primary items store the submitted recipe as stable BOM slots. Variants compare the submitted effective recipe with the primary and persist only sparse differences.