StockOnHand
Stock on Hand report
This endpoint provides a report of stock on hand for the given parameters.
get/inventory/reports/stock-on-hand
Query parameters
site_idstring uuid required
Filter stock on hand by site.
datestring date required
The date to filter stock on hand by.
brand_idsstring[]
A comma-separated list of brand IDs to filter stock on hand by.
category_idsstring[]
A comma-separated list of category IDs to filter stock on hand by.
supplier_idsstring[]
A comma-separated list of supplier IDs to filter stock on hand by.
Response
The stock on hand was successfully retrieved
Example response
{
"data": [
{
"name": "Blissful Body Butter",
"stock_level": 100.5,
"stock_value": 2000,
"average_cost": 2000
}
],
"meta": {
"total_stock_value": 2000,
"currency": "gbp"
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.