Returns a list of units of measure.
GET /inventory/unit-of-measures
Group: Inventory › Units of Measure · Operation ID: unitOfMeasures
This collection returns the same fields as GET inventory/unit-of-measures/:id and POST inventory/unit-of-measures/search.
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. |
Query surface
id— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likeunitCode— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likelastModifiedDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like- Orderable: id, unitCode, unitName, lastModifiedDate
- Selectable: id, unitCode, unitName, lastModifiedDate
Response
200 Success
Under data, an array of unitOfMeasuresRow:
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | no | The unique identifier for the unit of measure. |
unitCode |
string | no | The short code of the unit of measure, for example 'KG'. It is unique within the tenant. |
unitName |
string | no | The display name of the unit of measure, for example 'Kilogram'. |
lastModifiedDate |
string (date-time) or null | no | The date and time the unit of measure record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
Statuses
400— Invalid request or business failure401— Missing or invalid access token403— Not authorized404— Not found429— Too many requests500— Internal server error