List parts below minimum stock
const url = 'https://app.buildtrace.eu/api/stock/below-minimum';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://app.buildtrace.eu/api/stock/below-minimum \ --header 'Authorization: Bearer <token>'The parts whose available stock (on hand less reserved and blocked, over all revisions and locations) is below their reorder point’s minimum, with the shortfall and the quantity to reorder. Parts without a reorder point are never listed.
Required scope: inventory:read.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”OK
object
Over all revisions and locations; equals available + reserved + blocked. RAW: lot stock. Serialized parts: units available, reserved or quarantined.
Held by open build orders (RAW - reserved less consumed; serialized - reserved units).
Free to use: what a reservation may still take. RAW: on hand minus blocked minus reserved. Serialized: units with status AVAILABLE.
On hand but not usable. RAW: stock in lots whose latest lot inspection failed. Serialized: quarantined units.
How far available is under the minimum; “0” when it is not below it.
Available is less than the minimum (being exactly at it is not below it).
Example generated
[ { "partId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "partCode": "example", "partName": "example", "partKind": "example", "stockUom": "example", "minQty": "example", "reorderQty": "example", "onHand": "example", "reserved": "example", "available": "example", "blocked": "example", "shortfall": "example", "belowMinimum": true }]Unauthorized