Returns the unit of measure with the given identifier.
GET /inventory/unit-of-measures/{id}
Group: Inventory › Units of Measure · Operation ID: getUnitOfMeasure
The response has the same fields as GET inventory/unit-of-measures and POST inventory/unit-of-measures/search. To look a unit of measure up by its code instead of its id, filter the collection GET inventory/unit-of-measures on unitCode.
Open in the interactive reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Api-Version |
header | "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 for the unit of measure to return. |
Response
200 Success
Under data (getUnitOfMeasureOutput):
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | yes | The unique identifier for the unit of measure. |
unitCode |
string | yes | The short code of the unit of measure, for example 'KG'. It is unique within the tenant. |
unitName |
string | yes | The display name of the unit of measure, for example 'Kilogram'. |
lastModifiedDate |
string (date-time) | no | The date and time the unit of measure record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
Errors
| Code | Status |
|---|---|
NOT_FOUND |
400 |
Statuses
400— Invalid request or business failure. Codes: NOT_FOUND401— Missing or invalid access token403— Not authorized404— Not found429— Too many requests500— Internal server error