Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Stock

Update a stock details

Update the details of a single stock details (required scope stock:write)

patch/v1/stockDetails/{stockDetailsId}

Path parameters

stockDetailsIdinteger required

Headers

Customer-Idinteger required

The customer identifier

Request body

productCategoryIdinteger

The unique identifier of the product category associated to this stock details<br/><br/>Optional: Omit to retain current value

modelstring

The model name of the stock details<br/><br/>Optional: Omit to retain current value

makestring nullable

The manufacturer or brand of the stock<br/><br/>Optional: Omit to retain current value or provide null to unset

sellingPricenumber double nullable

The selling price of the stock. Cannot set to null if CurrencyCode is set<br/><br/>Optional: Omit to retain current value or provide null to unset

currencyCode'EUR' | 'AUD' | 'GBP' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ILS' | 'LVL' | 'LTL' | 'MXN' | 'NZD' | 'NOK' | 'PLN' | 'RON' | 'RUB' | 'ZAR' | 'SEK' | 'CHF' | 'AED' | 'USD'

CurrencyCode definitions enum, matches currencies available in the BigChange Client Site<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></ul>

departmentCodeIdinteger nullable

The department code of the stock<br/><br/>Optional: Omit to retain current value or provide null to unset

nominalCodeIdinteger nullable

The nominal code associated with the stock for accounting purposes<br/><br/>Optional: Omit to retain current value or provide null to unset

notesstring nullable

Notes associated with the stock<br/><br/>Optional: Omit to retain current value or provide null to unset

modelNumberstring nullable

The unique number assigned by the manufacturer to identify the model of the stock<br/><br/>Optional: Omit to retain current value or provide null to unset

stockCodestring nullable

The unique number or barcode assigned to each individual stock for identification and tracking<br/><br/>Optional: Omit to retain current value or provide null to unset

batchNumberstring nullable

The batch number of the stock<br/><br/>Optional: Omit to retain current value or provide null to unset

sizenumber double nullable

The dimensions or volume of the stock (m3)<br/><br/>Optional: Omit to retain current value or provide null to unset

weightnumber double nullable

The weight of the stock (kg)<br/><br/>Optional: Omit to retain current value or provide null to unset

taxIdinteger nullable

The identifier of the tax (vat) associated with the stock. If null, the user's default tax rate will be applied<br/><br/>Optional: Omit to retain current value or provide null to unset

Example request

{
  "productCategoryId": 5514123,
  "model": "F1 Cleaner",
  "make": "DustGone Solutions",
  "sellingPrice": 19.99,
  "currencyCode": "EUR",
  "departmentCodeId": 123,
  "nominalCodeId": 1234,
  "notes": "Great for cleaning windows",
  "modelNumber": "F1-00010",
  "stockCode": "B10",
  "batchNumber": "S8",
  "size": 199,
  "weight": 6.3,
  "taxId": 1234
}

Response

No Content