Inventory

List Site Inventory

GET
Returns a paginated list of a Customer's inventory by Item type across each of the Customer Sites that there is inventory held. One record per Item-Site combination.

Query parameters

itemIdintegerOptional
The Item ID to filter the content by.
siteIdintegerOptional
The Site ID to filter the content by.
pageintegerOptional
The page number of the content returned.
sizeintegerOptional
The size of the page returned. Max size is 100.

Response

This endpoint returns an object
content
list of objectsOptional
The content of the page, consisting of a list of objects.
page
integerOptional
The current page number. The first page has value 1.
size
integerOptional
The current page size. Default 15, maximum 250.
total
integerOptional
The number of objects matching the request.
first
booleanOptional
True if this is the first page, false otherwise.
last
booleanOptional
True if this is the last page, false otherwise.