API ReferenceItems

List Items

This endpoint returns a paginated list of all items in a customer's catalog with various filtering options including pagination, sorting, and specific attributes such as IDs, names, models, SKUs, sizes, classes, reading types, and manufacturer IDs.

Headers

Impilo-API-KeystringRequired

Query parameters

pageintegerOptional
The page number of the content returned.
sizeintegerOptional
The size of the page of content returned. Max value is 100.
sortenumOptional
The attribute to sort on.
Allowed values:
sortDescendingbooleanOptional
True if the sort direction should be descending.
idlist of longsOptional
Lists only items with the provided Item IDs.
namestringOptional
Lists only items with the provided name.
modelstringOptional
Lists only items with the provided model.
skustringOptional
Lists only items with the provided SKU.
itemSizelist of enumsOptional
Lists only items with the provided sizes.
Allowed values:
itemClasslist of enumsOptional
Lists only items with the provided classes.
readingTypelist of enumsOptional
Lists only items with the provided reading types.
manufacturerIdlist of longsOptional
Lists only items created by the provided Manufacturer IDs.

Response

OK
contentlist of objects or null
The content of the page, consisting of a list of objects.
firstboolean or null
True if this is the first page, false otherwise.
lastboolean or null
True if this is the last page, false otherwise.
pageinteger or null
The current page number. The first page has value 1.
sizeinteger or null
The current page size. Default 15, maximum 250.
totalinteger or null
The number of objects matching the request.