List the items of a stock take (v2)
Returns the items of a stocktake with v2 totals and filters. Use query, status, and the category/supplier/brand filters to drill into a specific slice of the stocktake while it's in progress. Compared to the v1 list (listStockTakeItems), the v2 response surfaces additional totals: total items, counted, uncounted, total adjustment value, and currency.
Query parameters
A comma-separated list of category IDs to filter the items by.
A comma-separated list of supplier IDs to filter the items by.
A comma-separated list of brand IDs to filter the items by.
A query to filter the products on. This searches the product name.
The status to filter the stock take items on.
Response
The stock take items were successfully retrieved.
Example response
{
"data": [
{
"name": "Blissful Body Butter",
"sku": "BB-001",
"unit_cost": 2000,
"counted_quantity": 50.5,
"expected_quantity": 70.5,
"adjusted_quantity": 20.5,
"adjusted_value": 70,
"created_at": "2024-06-01T00:00:00Z",
"updated_at": "2024-06-01T00:00:00Z"
}
],
"meta": {
"total_items": 100,
"total_counted": 50,
"total_uncounted": 50,
"total_adjustment_value": 50,
"currency": "gbp"
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.