Sign in
Stock

Get a stock details

Retrieves single stock details (required scope stock:read)

get/v1/stockDetails/{stockDetailsId}

Path parameters

stockDetailsIdinteger required

The unique identifier of the stock details

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the stock details

makestring nullable

The manufacturer or brand of the stock

modelstring

The model name of the stock details

sellingPricenumber 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>

departmentCodeIdinteger nullable

The department code of the stock

nominalCodeIdinteger nullable

The nominal code associated with the stock for accounting purposes

notesstring nullable

Notes associated with the stock

productCategoryIdinteger

The unique identifier of the product category related to this stock details

isConsumableboolean

Indicates whether the stock is a consumable item or not. Default is false

modelNumberstring nullable

The unique number assigned by the manufacturer to identify the model of the stock

stockCodestring nullable

The unique number or barcode assigned to each individual stock for identification and tracking

batchNumberstring nullable

The batch number of the stock

taxIdinteger nullable

The identifier of the tax (vat) associated with the stock

taxPercentagenumber double nullable

The tax (vat) percentage of the stock

sizenumber double nullable

The dimensions or volume of the stock (m3)

weightnumber double nullable

The weight of the stock (kg)

createdAtstring date-time

The UTC timestamp of when this stock details was created

Example response

{
  "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"
}