Get stock levels
GET
/stock
const url = 'https://app.buildtrace.eu/api/stock?revisionId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';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?revisionId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \ --header 'Authorization: Bearer <token>'Required scope: inventory:read.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”revisionId
required
string format: uuid
locationId
string format: uuid
Responses
Section titled “Responses”OK
Media typeapplication/json
A revision’s stock (at one location or over all of them). On hand = available + reserved + blocked. A material counts its lots; a serialized part counts its units, as the reorder status does (on hand = AVAILABLE + RESERVED + QUARANTINED units, blocked = QUARANTINED, available = AVAILABLE units not under an open rework; an AVAILABLE unit under an open rework counts as blocked, since a build order can’t reserve it).
object
revisionId
required
string format: uuid
onHand
required
string
available
required
What a build order can still reserve: on hand less what open build orders hold and less the stock in blocked lots. The same figure reservations and reorder points use.
string
blocked
required
On-hand stock in lots whose latest lot inspection failed; it can’t be reserved.
string
Example generated
{ "revisionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "onHand": "example", "available": "example", "blocked": "example"}Bad request
Media typeapplication/json
object
error
required
string
Example generated
{ "error": "example"}Unauthorized