Returns a list of unit of measure groups.
GET /inventory/unit-of-measure-groups
Group: Inventory › Unit of Measure Groups · Operation ID: unitOfMeasureGroups
This collection returns the group header only, not its conversion lines or base unit. Use GET inventory/unit-of-measure-groups/:id or POST inventory/unit-of-measure-groups/search when you need the conversion table, and POST inventory/unit-of-measure-groups/search to find the groups that convert a given unit of measure.
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, likename— 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, name, description, lastModifiedDate
- Selectable: id, name, description, lastModifiedDate
Response
200 Success
Under data, an array of unitOfMeasureGroupsRow:
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | no | The unique identifier for the unit of measure group. |
name |
string | no | The display name of the unit of measure group. Names are not unique. |
description |
string or null | no | A free-form description of what the group covers. |
lastModifiedDate |
string (date-time) or null | no | The date and time the unit of measure group's own fields last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. Adding or changing a conversion line does not change it. |
Statuses
400— Invalid request or business failure401— Missing or invalid access token403— Not authorized404— Not found429— Too many requests500— Internal server error