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.

GET

/stock/below-minimum

curl --request GET \
  --url https://app.dev.buildtrace.eu/api/stock/below-minimum \
  --header 'Authorization: Bearer <token>'

Required scope: inventory:read.

Authorizations

• bearerAuth

Responses

200

OK

Media typeapplication/json

Array<object>

object

partId

required

string format: uuid

partCode

required

string

partName

required

string

partKind

required

string

stockUom

required

string

minQty

required

string

reorderQty

string

onHand

required

Over all revisions and locations; equals available + reserved + blocked. RAW: lot stock. Serialized parts: units available, reserved or quarantined.

string

reserved

required

Held by open build orders (RAW - reserved less consumed; serialized - reserved units).

string

available

required

Free to use: what a reservation may still take. RAW: on hand minus blocked minus reserved. Serialized: units with status AVAILABLE.

string

blocked

required

On hand but not usable. RAW: stock in lots whose latest lot inspection failed. Serialized: quarantined units.

string

shortfall

required

How far available is under the minimum; “0” when it is not below it.

string

belowMinimum

required

Available is less than the minimum (being exactly at it is not below it).

boolean

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
  }
]

401

Unauthorized