Skip to content

Get stock by location

GET
/stock/by-location
curl --request GET \
--url 'https://app.buildtrace.eu/api/stock/by-location?revisionId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
--header 'Authorization: Bearer <token>'

Required scope: inventory:read.

revisionId
required
string format: uuid

OK

Media typeapplication/json
object
total
required
string
locations
required
Array<object>
object
locationId
required
string format: uuid
locationCode
required
string
locationName
required
string
locationKind
required
string
onHand
required
string

Example generated

{
"total": "example",
"locations": [
{
"locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"locationCode": "example",
"locationName": "example",
"locationKind": "example",
"onHand": "example"
}
]
}

Bad request

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}

Unauthorized