iotoms Docs

List units of measure for many items

POST
/api/v1/catalog/item-uoms/batch

Returns the unit lists for all itemIds in one call. Use it instead of calling the single-item endpoint in a loop, for example when syncing a catalog.

How to use it

  1. Collect the item codes, for example from List items.
  2. Send them in itemIds and read one unit list per item from the response. Nothing is changed.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Header Parameters

X-TenantID*string

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

Request Body

application/json
  1. body
itemIds*array<string>

Item codes to fetch unit lists for. Blank and repeated codes are ignored, unknown codes are skipped, and results come back in the order you sent.

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?array<>|

One unit list per requested item code.

Example Request
curl -X POST 'https://beta.iotoms.com/api/v1/catalog/item-uoms/batch' \  -H 'X-TenantID: your-tenant-code' \  -H 'Content-Type: application/json' \  -d '{  "itemIds": [    "string"  ]}'
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"      ]    }  ]}