iotoms Docs

List units of measure

GET
/api/v1/catalog/uom

Returns the merchant's units of measure sorted by code. Filter by category (count, weight, volume, length), status, or a text query; paginated with 0-based page and size (default 50).

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

category?string

Only return units of this category: COUNT, WEIGHT, VOLUME or LENGTH (upper case).

Value in"COUNT""WEIGHT""VOLUME""LENGTH"
status?string

Only return units in this status: ACTIVE, INACTIVE, ARCHIVED or DELETED.

Value in"ACTIVE""INACTIVE""ARCHIVED""DELETED"
query?string

Text to search for in the unit's code or name, ignoring case.

page?integer

Page number, starting at 0. See Paging.

Formatint32
Default0
size?integer

Number of records per page.

Formatint32
Default50

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?

One page of units of measure, sorted by code, with paging details.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/catalog/uom' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "content": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "code": "string",        "name": "string",        "category": "COUNT",        "decimalPrecision": 0,        "status": "ACTIVE",        "inUse": true      }    ],    "page": 0,    "size": 0,    "totalElements": 0,    "totalPages": 0,    "last": true  }}