Items

List Items

GET
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.

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: itemIditemNameitemModelitemSku
sortDescendingbooleanOptional
True if the sort direction should be descending.
idintegerOptional
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.
itemSizeenumOptional
Lists only items with the provided sizes.
Allowed values: standardsmalllargeextraLargemedium
itemClassenumOptional
Lists only items with the provided classes.
readingTypeenumOptional
Lists only items with the provided reading types.
manufacturerIdintegerOptional
Lists only items created by the provided Manufacturer IDs.

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.
Built with