iotoms Docs

List an item's units of measure

GET
/api/v1/catalog/items/{itemId}/uoms

Returns the item's base unit and every additional conversion unit, with conversion factors and which unit is the default for each role.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

itemId*string

Item code, from List items.

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 it worked, ERROR when it failed.

message*string

Short human-readable message describing the outcome, for example "Vendor created". Do not parse it.

data?

The item's full unit list (base unit plus every conversion unit) after the change.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/catalog/items/string/uoms' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "itemId": "string",    "catchWeight": true,    "baseUomId": "0c43b7c4-22c4-4b37-9c1a-485778bd5b04",    "units": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "uomId": "4df47f00-a69d-4ff2-b50d-4a7649a4b70c",        "code": "string",        "name": "string",        "category": "COUNT",        "decimalPrecision": 0,        "factorToBase": 0,        "isBase": true,        "isPurchaseDefault": true,        "isReceiveDefault": true,        "isCountDefault": true,        "nominalWeight": 0,        "tareWeight": 0,        "isSellDefault": true      }    ],    "warnings": [      "string"    ]  }}