Alpha API ReferenceReporting
Get stock report
Stock levels, expiring items, and site summaries
AuthorizationBearer <token>
In: header
Query Parameters
siteId?string
siteIds?array<string>
subsidiaryIds?array<string>
storageTypes?array<>
daysToExpiry?integer
Default
30Format
int32targetCurrency?string
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/reporting/stock"{
"accessRestricted": true,
"currencyMeta": {
"baseCurrency": "string",
"convertedAt": "2019-08-24T14:15:22Z",
"displayCurrency": "string",
"warnings": [
{
"asOfDate": "string",
"fromCurrency": "string",
"pivotCurrency": "string",
"reason": "MISSING_RATE",
"rowId": "string",
"toCurrency": "string"
}
]
},
"expiringItems": [
{
"batchNumber": "string",
"daysUntilExpiry": 0,
"expirationDate": "string",
"productId": "string",
"productInfo": {
"brand": "string",
"category": "string",
"description": "string",
"imageBlobId": "string",
"name": "string",
"productId": "string",
"salesPrice": 0.1,
"stockInfo": {
"amountAvailable": 0.1,
"amountReserved": 0.1,
"baseUnit": {
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
},
"currency": "string",
"destinationProductInfo": {
"amountAvailable": 0.1,
"amountReserved": 0.1,
"maximum": 0.1,
"minimum": 0.1,
"stockSiteId": "string",
"stockSiteName": "string",
"totalAmount": 0.1
},
"imageBlobId": "string",
"maximum": 0.1,
"minimum": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"salesPrice": 0.1,
"stockSiteId": "string",
"stockSiteName": "string",
"subsidiaryId": "string",
"totalAmount": 0.1,
"unitPrice": 0.1,
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
},
"unitPrice": 0.1,
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
},
"quantity": 0.1,
"siteId": "string",
"siteName": "string",
"unitPrice": 0.1
}
],
"expiringSoonCount": 0,
"outOfStockCount": 0,
"stockBySite": [
{
"siteId": "string",
"siteName": "string",
"totalItems": 0,
"totalValue": 0.1
}
],
"stockStatusBreakdown": {
"property1": 0,
"property2": 0
},
"totalItems": 0,
"totalStockValue": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}