916e669fc527
Get a list of stock details
Retrieves a paged collection of stock details (required scope stock:read)
Query parameters
Represents the fields that can be used to sort stock details<p>Possible values:</p><ul><li><b>model</b>: The name of the stock details model</li></ul>
The field to sort items in the page by
Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>
The direction to apply the sort
Only return stock details where id matches the value(s) provided (Max items: 50)
Only return stock details where productCategoryId matches the value(s) provided (Max items: 50)
Only return stock details where modelNumber matches the value(s) provided (Max items: 50)
Only return stock details where isConsumable matches the value provided
Only return stock details where stockCode matches the value(s) provided (Max items: 50)
Only return stock details where batchNumber matches the value(s) provided (Max items: 50)
The page number being requested (minimum: 1, maximum: 2147483)
The page size being requested (minimum: 1, maximum: 1000)
Headers
The customer identifier
Response
OK
Example response
{
"items": [
{
"id": 5514123,
"make": "DustGone Solutions",
"model": "F1 Cleaner",
"sellingPrice": 19.99,
"currencyCode": "EUR",
"departmentCodeId": 123,
"nominalCodeId": 1234,
"notes": "Great for cleaning windows",
"productCategoryId": 5514123,
"isConsumable": true,
"modelNumber": "F1-00010",
"stockCode": "B10",
"batchNumber": "S8",
"taxId": 1234,
"taxPercentage": 20,
"size": 199,
"weight": 6.3,
"createdAt": "2022-11-29T16:50:16.0000000+00:00"
}
],
"pageNumber": 2,
"pageSize": 100,
"pageItemCount": 55
}