Search units of measure

Operation ID: searchUnitOfMeasures

Group: Inventory › Units of Measure

Open in the interactive reference

POST /inventory/unit-of-measures/search

Read-only: A read that takes its filters in the body. Changes nothing, and ignores Idempotency-Key.

Searches units of measure. The filters are the exact code and when the unit of measure last changed.

Parameters

Name In Type Required Description
Api-Version header string · 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.

Request body

Required, application/json: searchUnitOfMeasuresInput.

Field Type Required Description
filters object yes The filters to apply. A unit of measure must match every filter you send. Send an empty object to return all units of measure. Example: {"unitCode":"KG"}.
filters.unitCode string no Limits results to the unit of measure with this code. The match is exact. Codes are unique, so this matches at most one unit of measure.
filters.modifiedSince date-time no Limits results to units of measure changed on or after this time. Format YYYY-MM-DDTHH:mm:ss.sssZ.
page object no The pagination controls. Omit for the first page. Example: {"size":50}.
page.cursor string no The cursor from the previous response's pagination.nextCursor. Omit for the first page.
page.size number no The number of units of measure per page. Defaults to 50. A value above 200 is treated as 200, not rejected. 
{
  "filters": {
    "unitCode": "KG"
  },
  "page": {
    "size": 50
  }
}

Response

200 Success

Under data (searchUnitOfMeasuresOutput):

Field Type Required Description
items array<object> yes The units of measure on this page, ordered by id. An empty array when nothing matches. Example: [{"id":"3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45","unitCode":"KG","unitName":"Kilogram","lastModifiedDate":"2026-05-12T09:30:00.000Z"}].
items[].id string yes The unique identifier for the unit of measure.
items[].unitCode string yes The short code of the unit of measure, for example 'KG'. It is unique within the tenant.
items[].unitName string yes The display name of the unit of measure, for example 'Kilogram'.
items[].lastModifiedDate date-time no The date and time the unit of measure record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
pagination object yes The pagination cursor for this page. Example: {"hasMore":false}.
pagination.nextCursor string no The cursor for the next page. Pass it as page.cursor. Absent on the last page.
pagination.hasMore boolean yes True when more units of measure remain beyond this page. 
{
  "data": {
    "items": [
      {
        "id": "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45",
        "unitCode": "KG",
        "unitName": "Kilogram",
        "lastModifiedDate": "2026-05-12T09:30:00.000Z"
      }
    ],
    "pagination": {
      "hasMore": false
    }
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Statuses