iotoms Docs

List items

GET
/api/v1/catalog/items

Returns catalog items as a page (0-based page, size 1 to 100, default 20), not wrapped in a status envelope. Filter by attribute ID or partial name, item code, barcode, status, type or stored modified time. With no filters every status is returned; with any filter only ACTIVE items unless you pass status.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

departmentId?integer

Only items in this department (ID from List departments).

Formatint64
departmentName?string

Only items whose department name contains this text (case-insensitive).

categoryId?integer

Only items in this category (ID from List categories).

Formatint64
categoryName?string

Only items whose category name contains this text (case-insensitive).

subcategoryId?integer

Only items in this subcategory (ID from List subcategories).

Formatint64
subcategoryName?string

Only items whose subcategory name contains this text (case-insensitive).

styleId?integer

Only items with this style (ID from List styles).

Formatint64
styleName?string

Only items whose style name contains this text (case-insensitive).

brandId?integer

Only items of this brand (ID from List brands).

Formatint64
brandName?string

Only items whose brand name contains this text (case-insensitive).

sizeId?integer

Only items with this size (ID from List sizes).

Formatint64
sizeName?string

Only items whose size name contains this text (case-insensitive).

colorId?integer

Only items with this colour (ID from List colors).

Formatint64
colorName?string

Only items whose colour name contains this text (case-insensitive).

itemId?string

Only the item with exactly this item code.

itemName?string

Only items whose name contains this text (case-insensitive).

upc?string

Only items with exactly this barcode.

status?array<string>

One or more of ACTIVE, INACTIVE, ARCHIVED, DELETED (repeat the parameter). With other filters it defaults to ACTIVE.

updatedSince?string

Only items whose stored modified time is at or after this time (ISO 8601 with offset, e.g. 2026-01-31T00:00:00Z). That time is set at creation and not refreshed by item edits, so this finds new items, not edited ones.

updatedFrom?string

Start of a modified-time window (ISO 8601 with offset), inclusive. Use with updatedTo. The modified time is set at creation and not refreshed by item edits.

updatedTo?string

End of a modified-time window (ISO 8601 with offset), inclusive.

type?string

Only items of this type: STORE_ITEM or MODIFIER_ITEM.

page?integer

Page number, starting at 0. See Paging.

Formatint32
Default0
size?integer

Number of records per page.

Formatint32
Default20

Response Body

OK

*/*
  1. response
content?array<>|

The records on this page.

page?

Paging details: page size, current page number, total matching records and total pages.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/catalog/items'
Example Response
{  "content": [    {}  ],  "page": {    "size": 0,    "number": 0,    "totalElements": 0,    "totalPages": 0  }}