Get a list of stock details
Retrieves a paged collection of stock details (required scope stock:read)
Query Parameters
Possible values: [model]
The field to sort items in the page by
Possible values: [ascending, descending]
The direction to apply the sort
Only return stock details where id matches the value(s) provided
Only return stock details where productCategoryId matches the value(s) provided
Only return stock details where modelNumber matches the value(s) provided
Only return stock details where isConsumable matches the value provided
Only return stock details where stockCode matches the value(s) provided
Only return stock details where batchNumber matches the value(s) provided
Possible values: >= 1 and <= 2147483
The page number being requested (minimum: 1, maximum: 2147483)
Possible values: >= 1 and <= 1000
The page size being requested (minimum: 1, maximum: 1000)
Header Parameters
The customer identifier
- 200
- 400
- 403
- 500
Success
Schema
- Array [
- 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
- ]
items object[]
The items returned for the requested page
The unique identifier of the stock details
The manufacturer or brand of the stock
The model name of the stock details
The selling price of the stock
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:
The department code of the stock
The nominal code associated with the stock for accounting purposes
Notes associated with the stock
The unique identifier of the product category related to this stock details
Indicates whether the stock is a consumable item or not. Default is false
The unique number assigned by the manufacturer to identify the model of the stock
The unique number or barcode assigned to each individual stock for identification and tracking
The batch number of the stock
The identifier of the tax (vat) associated with the stock
The tax (vat) percentage of the stock
The dimensions or volume of the stock (m3)
The weight of the stock (kg)
The UTC timestamp of when this stock details was created
The page number of the response where 1 is the first page
The number of items requested for the current page
The number of items returned in the current page
{
"items": [
{
"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"
}
],
"pageNumber": 2,
"pageSize": 100,
"pageItemCount": 55
}
Bad Request
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
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
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
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
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
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"
}