Get

[POST] .../v1/unit/get

Returns information about units of measure. Use this method to retrieve units of measure for item cards, document operations, quantity validation and reference selectors. The response returns paged Unit records with next_offset and total and supports filters, sort_orders, search, limit and offset for unit id, type and name selection. The caller must have unit select permission; missing body, denied access, invalid filters or sorting and persistent storage errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of records to return. The value is limited by server settings.
offset Int32 Optional Offset from the beginning of the result set.
search String Optional Search string for the name field.
sort_orders Array of UnitSortOrder Optional Output data sorting.

Filterable Fields

Field Type Description
id int Unit of measure IDs.
name string
type string Unit type: non_pcs - non-piece or weighted, pcs - piece.

Sortable Fields

Field
id
last_update
name
type

Request Example

{
  "filters": [
    {
      "Field": "name",
      "Operator": "Equal",
      "Value": "pcs"
    }
  ],
  "sort_orders": [
    {
      "column": "name",
      "direction": "ASC"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of Unit Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 1,
      "name": "pcs",
      "type": "pcs",
      "description": "Pieces",
      "kkm_code": 1,
      "last_update": 1712345600
    }
  ],
  "next_offset": 0,
  "total": 1
}