Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Stock

Get a list of distinct stock make and model combinations

Retrieves a paged collection of distinct stock make models (required scope stock:read)

get/v1/stock/make-models

Query parameters

sortBy'make' | 'model' | 'modelNumber' | 'creationDate'

Represents the fields that can be used to sort stock make-models.<p>Possible values:</p><ul><li><b>make</b>: Sort by stock make</li><li><b>model</b>: Sort by stock model</li><li><b>modelNumber</b>: Sort by model number (stock number)</li><li><b>creationDate</b>: Sort by creation date</li></ul>

Example:make

The field to sort items in the page by

direction'ascending' | 'descending'

Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>

Example:ascending

The direction to apply the sort (defaults to ascending)

searchQuerystring

Only return stock where make or model or stock number matches the value provided

productCategoryIdinteger

Only return stock where productCategoryId matches the value provided

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "id": 12345,
      "type": 10,
      "make": "Bosch",
      "model": "GBH 2-26 DRE",
      "number": "611253703",
      "createdAt": "2024-01-15T10:30:00.0000000+00:00"
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}