API ReferenceInventory

List Inventory Summary

Returns a paginated list that aggregates all Used and New inventory across all Impilo and Customer locations by Item type. One entry per Item ID.

Headers

Impilo-API-KeystringRequired

Query parameters

itemIdlongOptional

The Item ID to filter the content by.

pageintegerOptionalDefaults to 1

The page number of the content returned.

sizeintegerOptionalDefaults to 15

The size of the page returned. Max size is 100.

Response

OK

contentlist of objectsOptional

The content of the page, consisting of a list of objects.

firstbooleanOptional

True if this is the first page, false otherwise.

lastbooleanOptional

True if this is the last page, false otherwise.

pageintegerOptional

The current page number. The first page has value 1.

sizeintegerOptional

The current page size. Default 15, maximum 250.

totalintegerOptional

The number of objects matching the request.