---
title: "Get a list of stock details"
method: GET
path: "/v1/stockDetails"
tags: ["Stock"]
---

# Get a list of stock details

`GET /v1/stockDetails`

Retrieves a paged collection of stock details (required scope stock:read)

## Query parameters

- `sortBy` 'model' — 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>
- `direction` 'ascending' | 'descending' — 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>
- `id` integer[]
- `productCategoryId` integer[]
- `modelNumber` string[]
- `isConsumable` boolean
- `stockCode` string[]
- `batchNumber` string[]
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- PagedResponseReadStockDetailsModel — A paged collection of items
  - `items` ReadStockDetailsModel[] — The items returned for the requested page
    - `id` integer — The unique identifier of the stock details
    - `make` string, nullable — The manufacturer or brand of the stock
    - `model` string — The model name of the stock details
    - `sellingPrice` number, double, nullable — The selling price of the stock
    - `currencyCode` 'EUR' | 'AUD' | 'GBP' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ILS' | 'LVL' | 'LTL' | 'MXN' | 'NZD' | 'NOK' | 'PLN' | 'RON' | 'RUB' | 'ZAR' | 'SEK' | 'CHF' | 'AED' | 'USD' | 'UNKNOWN' — CurrencyCode definitions enum, matches currencies available in the BigChange Client Site with an unknown value to handle unrecognised currencies returned from the database<p>Possible values:</p><ul><li><b>EUR</b>: Euro</li><li><b>AUD</b>: Australian Dollar</li><li><b>GBP</b>: Pound Sterling</li><li><b>BGN</b>: Bulgarian Lev</li><li><b>CAD</b>: Canadian Dollar</li><li><b>CZK</b>: Czech Koruna</li><li><b>DKK</b>: Danish Krone</li><li><b>HUF</b>: Forint</li><li><b>ILS</b>: New Israeli Sheqel</li><li><b>LVL</b>: Latvian Lats - replaced by Euro</li><li><b>LTL</b>: Lithuanian Litas - replaced by Euro</li><li><b>MXN</b>: Mexican Peso</li><li><b>NZD</b>: New Zealand Dollar</li><li><b>NOK</b>: Norwegian Krone</li><li><b>PLN</b>: Zloty</li><li><b>RON</b>: Romanian Leu</li><li><b>RUB</b>: Russian Ruble</li><li><b>ZAR</b>: Rand</li><li><b>SEK</b>: Swedish Krona</li><li><b>CHF</b>: Swiss Franc</li><li><b>AED</b>: UAE Dirham</li><li><b>USD</b>: US Dollar</li><li><b>UNKNOWN</b>: Unknown currency</li></ul>
    - `departmentCodeId` integer, nullable — The department code of the stock
    - `nominalCodeId` integer, nullable — The nominal code associated with the stock for accounting purposes
    - `notes` string, nullable — Notes associated with the stock
    - `productCategoryId` integer — The unique identifier of the product category related to this stock details
    - `isConsumable` boolean — Indicates whether the stock is a consumable item or not. Default is false
    - `modelNumber` string, nullable — The unique number assigned by the manufacturer to identify the model of the stock
    - `stockCode` string, nullable — The unique number or barcode assigned to each individual stock for identification and tracking
    - `batchNumber` string, nullable — The batch number of the stock
    - `taxId` integer, nullable — The identifier of the tax (vat) associated with the stock
    - `taxPercentage` number, double, nullable — The tax (vat) percentage of the stock
    - `size` number, double, nullable — The dimensions or volume of the stock (m3)
    - `weight` number, double, nullable — The weight of the stock (kg)
    - `createdAt` string, date-time — The UTC timestamp of when this stock details was created
  - `pageNumber` integer — The page number of the response where 1 is the first page
  - `pageSize` integer — The number of items requested for the current page
  - `pageItemCount` integer — The number of items returned in the current page

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)