Returns the unit of measure group with the given identifier.

GET /inventory/unit-of-measure-groups/{id}

Group: Inventory › Unit of Measure Groups · Operation ID: getUnitOfMeasureGroup

The response is the whole group, with its base unit and every conversion line. GET inventory/unit-of-measure-groups returns the header only, so use this endpoint or POST inventory/unit-of-measure-groups/search when you need the conversion lines. Each line has its own id, which is what updateLines and deleteLines address on PATCH inventory/unit-of-measure-groups/:id.

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 group to return.

Response

200 Success

Under data (getUnitOfMeasureGroupOutput):

Field Type Required Description
id string yes The unique identifier for the unit of measure group.
name string yes The display name of the unit of measure group. Names are not unique.
description string no A free-form description of what the group covers. Absent when none was given.
baseUnitOfMeasureId string no The unique identifier for the base unit of measure that every conversion factor in the group is relative to. Absent when the group has no lines. See id on GET inventory/unit-of-measures/:id.
baseUnitCode string no The code of the base unit of measure. Absent when the group has no lines.
lines array of object yes The group's conversion lines, ordered by line id. An empty array when the group has none.
lines[].id string yes The unique identifier for the conversion line. This is what updateLines and deleteLines address on PATCH inventory/unit-of-measure-groups/:id, not the unit.
lines[].unitOfMeasureId string yes The unique identifier for the unit of measure this line converts. See id on GET inventory/unit-of-measures/:id.
lines[].unitCode string yes The code of that unit of measure.
lines[].unitName string yes The display name of that unit of measure.
lines[].conversionFactor string (decimal) yes How many base units of measure make up one of this unit. It is always greater than zero, and 1 on the base unit's own line.
lines[].isBaseUnit boolean yes Whether this line is for the group's own base unit of measure. Exactly one line has it, and its conversionFactor is 1.
lastModifiedDate string (date-time) 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.

Errors

Code Status
NOT_FOUND 400

Statuses