GET
View a unit of measure
Company space For: Manager · Permission: uom_units.retrieve Part of Units of measure.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uom_category
string
required

Identifier of the unit-of-measure category (27-character KSUID).

unit
string
required

Identifier of the unit (27-character KSUID). It must belong to the category.

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, category_id, name, code, conversion_factor, is_reference, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

200 - application/json

Resource.

id

Identifier of the unit (27-character KSUID).

category_id

Identifier of the category that owns the unit (27-character KSUID).

name

Lowercase name of the unit, unique within its category.

code

Short symbol of the unit, unique among the organization's units ignoring case.

conversion_factor
integer

Whole number of reference units in one of this unit; 1 for the reference unit.

is_reference
boolean

True when this unit is the base unit of its category.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).