Get a stock details

Retrieves single stock details (required scope stock:read)

Path Parameters

stockDetailsId int64 required

Possible values: >= 1

The unique identifier of the stock details

Header Parameters

Customer-Id int64 required

The customer identifier

Responses

• 200
• 400
• 403
• 404
• 500

---

Success

application/json

Schema

Example (from schema)

---

Schema

id int64

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 double nullable

The selling price of the stock

currencyCode CurrencyRead

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

Currency definitions enum, matches currencies available in the BigChange Client Site with an unknown value to handle unrecognised currencies returned from the database

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
• unknown: Unknown currency

departmentCodeId int64 nullable

The department code of the stock

nominalCodeId int64 nullable

The nominal code associated with the stock for accounting purposes

notes string nullable

Notes associated with the stock

productCategoryId int64

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 int64 nullable

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

taxPercentage double nullable

The tax (vat) percentage of the stock

size double nullable

The dimensions or volume of the stock (m3)

weight double nullable

The weight of the stock (kg)

createdAt date-time

The UTC timestamp of when this stock details was created

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

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

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