Retrieve a unit of measure

Operation ID: getUnitOfMeasure

Group: Inventory › Units of Measure

Open in the interactive reference

GET /inventory/unit-of-measures/{id}

Read-only: Reads and returns; changes nothing.

Retrieves a unit of measure. Use the unit of measure's id, not its unitCode.

The response gives the unit of measure's code and display name.

GET inventory/unit-of-measures and POST inventory/unit-of-measures/search return the same fields. To look up a unit of measure by its code, filter GET inventory/unit-of-measures on unitCode.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier of the unit of measure you want to retrieve.

Response

200 Success

Under data (getUnitOfMeasureOutput):

Field Type Required Description
id string yes The unique identifier for the unit of measure. Example: "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45".
unitCode string yes The short code of the unit of measure, for example 'KG'. It is unique within the tenant. Example: "KG".
unitName string yes The display name of the unit of measure, for example 'Kilogram'. Example: "Kilogram".
lastModifiedDate date-time no The date and time the unit of measure record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. Example: "2026-05-12T09:30:00.000Z". 
{
  "data": {
    "id": "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45",
    "unitCode": "KG",
    "unitName": "Kilogram",
    "lastModifiedDate": "2026-05-12T09:30:00.000Z"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Errors

Code Status
NOT_FOUND 400

Statuses