Units of measure

Units-of-measure discovery provides the account-owned unit UUIDs that inventory items can reference. The endpoint is read-only and follows the API user's current inventory permissions.

The unit-of-measure object

Field	Type	Description
`id`	string	Unique unit-of-measure UUID.
`object`	string	Always `unit_of_measure`.
`full_name`	string	Full display name, such as `Kilogram`.
`short_name`	string	Quantity suffix, such as `kg`.
`display_order`	integer	Account-configured ordering value.

List units of measure

GET/api/v3/units-of-measure

Required scope: items:read

Returns units belonging to the current account, ordered by display_order, full name, and UUID.

Parameter	Type	Required	Description
`page`	integer	No	Page number. Defaults to `1`.
`limit`	integer	No	Records per page from `1` to `100`. Defaults to `20`.

{
  "object": "list",
  "url": "/api/v3/units-of-measure",
  "has_more": false,
  "data": [
    {
      "id": "1c7a84de-d045-43ae-b60f-67f75f655ba0",
      "object": "unit_of_measure",
      "full_name": "Kilogram",
      "short_name": "kg",
      "display_order": 1
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total_pages": 1,
    "total_records": 1
  }
}

Retrieve a unit of measure

GET/api/v3/units-of-measure/{unit_of_measure_id}

Required scope: items:read

Returns one account-owned unit.