Update a stock details

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

Path Parameters

stockDetailsId int64 required

Header Parameters

Customer-Id int64 required

The customer identifier

application/json

Request Body

productCategoryId int64

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

model string

The model name of the stock details
Optional: Omit to retain current value

make string nullable

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

sellingPrice double nullable

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

currencyCode CurrencyWrite

Possible values: [eur, aud, gbp, bgn, cad, czk, dkk, huf, ils, lvl, ltl, mxn, nzd, nok, pln, ron, rub, zar, sek, chf, aed, usd]

Currency definitions enum, matches currencies available in the BigChange Client Site

Possible values:

• eur: Euro
• aud: Australian Dollar
• gbp: Pound Sterling
• bgn: Bulgarian Lev
• cad: Canadian Dollar
• czk: Czech Koruna
• dkk: Danish Krone
• huf: Forint
• ils: New Israeli Sheqel
• lvl: Latvian Lats - replaced by Euro
• ltl: Lithuanian Litas - replaced by Euro
• mxn: Mexican Peso
• nzd: New Zealand Dollar
• nok: Norwegian Krone
• pln: Zloty
• ron: Romanian Leu
• rub: Russian Ruble
• zar: Rand
• sek: Swedish Krona
• chf: Swiss Franc
• aed: UAE Dirham
• usd: US Dollar

departmentCodeId int64 nullable

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

nominalCodeId int64 nullable

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

notes string nullable

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

modelNumber string nullable

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

stockCode string nullable

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

batchNumber string nullable

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

size double nullable

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

weight double nullable

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

taxId int64 nullable

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

Responses

• 204
• 400
• 403
• 404
• 422
• 500

---

No Content

Bad Request

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Forbidden

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Not Found

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Client Error

application/problem+json

Schema

Example (from schema)

---

Schema

errors object
property name* string[]
Array [
string
]
type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "errors": {},
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Server Error

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Loading...