iotoms Docs

Remove a unit of measure from an item

DELETE
/api/v1/catalog/items/{itemId}/uoms/{uomId}

Removes a conversion unit from an item. The base unit cannot be removed, and a unit that is still the default for purchasing, selling, receiving or counting must have that role cleared first.

How to use it

  1. Check the unit with List an item's units of measure; it must not be the base unit.
  2. If the unit is a purchase, sell, receive or count default, move that default to another unit with Update an item's unit of measure first.
  3. Remove it; the unit can no longer be used for this item until added again.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

itemId*string

Item code, from List items.

uomId*string

Unit to remove, as uomId from List an item's units of measure.

Formatuuid

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

Endpoint-specific payload: null when there is nothing to return (e.g. after removing a unit); for credit note PDFs it holds returnId, creditNoteNumber, templateId, templateVersion, pdfUrl and generatedAt.

Example Request
curl -X DELETE 'https://beta.iotoms.com/api/v1/catalog/items/string/uoms/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {}}