Получить список единиц измерения

POST /v1/units/list

POST/v1/units/list

Возвращает список всех единиц измерения с возможностью фильтрации по физической величине (Quantity). Глобальный справочник.

Тело запроса

filter
[ "object", "null" ]
Показать свойства
quantity
code
[ "string", "null" ]
Точное совпадение по коду
pagination
object
Cursor-пагинация. Первый запрос - без cursor (или пустой). Для получения следующей страницы - передать cursor из ответа (pagination.next_cursor). Если has_next: false - достигнут конец списка.
Показать свойства
cursor
[ "string", "null" ]
Курсор для следующей страницы (opaque-токен, генерируется сервером). Пусто или отсутствие - первая страница.
limit
integer
required
Лимит элементов на странице

Успешный ответ

200Список единиц
application/json
object
units
array
required
Единица измерения (объект, не строка). Позволяет конвертировать единицы одной физической величины. Конвертация: value_in_base = Number * Unit.Factor. Пример: 1500 мм (Factor=0.001) = 1.5 м; 150 см (Factor=0.01) = 1.5 м -> эквивалентны. Локализация: поля name, symbol и description локализуются через массив locales (одна единица может иметь разные названия/символы на разных языках: «метр»/«м» в ru, «meter»/«m» в en, «米»/«米» в zh). Поля name и symbol на верхнем уровне - значения по умолчанию (для обратной совместимости); locale-переводы в locales[].
Показать свойства
code
string
required
Уникальный код единицы
name
string
required
Название единицы (по умолчанию, обычно для основного языка маркетплейса)
symbol
string
required
Символ (по умолчанию, обычно для основного языка маркетплейса)
description
[ "string", "null" ]
Описание единицы (по умолчанию, опц.)
quantity
string
required
Физическая величина. Базовые СИ: length, mass, time, temperature, current, amount, luminous Производные механические: area, volume, velocity, acceleration, force, pressure, energy, power, frequency, angle, angular_velocity Электрические: voltage, resistance, capacitance, inductance, charge, conductance, magnetic_flux, magnetic_field Оптические: luminance, illuminance, wavelength Тепловые: thermal_conductivity, heat_capacity, thermal_expansion Химические/физические: density, area_density, concentration, viscosity, humidity, ph, radioactivity Бытовые: count, volume_per_count, weight_per_count, area_per_count, fraction, ratio, pixel, dpi, resolution, bitrate, data_size, data_rate Информационные: frequency_range, memory_clock, refresh_rate, response_time, screen_size Размеры: clothing_size, shoe_size Геометрические: diameter, radius, thickness, gauge, thread Электрические производные: battery_capacity, power_factor, efficiency Торговые: currency, price_per_unit, tax, discount Безразмерные: dimensionless
Допустимые значения
lengthmasstimetemperaturecurrentamountluminousareavolumevelocityaccelerationforcepressureenergypowerfrequencyangleangular_velocityvoltageresistancecapacitanceinductancechargeconductancemagnetic_fluxmagnetic_fieldluminanceilluminancewavelengththermal_conductivityheat_capacitythermal_expansiondensityarea_densityconcentrationviscosityhumidityphradioactivitycountvolume_per_countweight_per_countarea_per_countfractionratiopixeldpiresolutionbitratedata_sizedata_ratefrequency_rangememory_clockrefresh_rateresponse_timescreen_sizeclothing_sizeshoe_sizediameterradiusthicknessgaugethreadbattery_capacitypower_factorefficiencycurrencyprice_per_unittaxdiscountdimensionless
base_unit
string
required
Код базовой единицы величины (для конвертации)
factor
number
required
Коэффициент пересчёта в базовую единицу (1 мм = 0.001 м -> 0.001)
locales
[ "array", "null" ]
Локализованные названия/символы/описания единицы по языкам (ISO 639-1). Порядок ООН: ru, zh, en, fr, затем остальные. Пусто/отсутствует - нет переводов (использовать name/symbol/description на верхнем уровне).
Показать свойства
Свойства не описаны
pagination
object
required
Результат cursor-пагинации
Показать свойства
next_cursor
[ "string", "null" ]
Курсор для следующей страницы. Передать в pagination.cursor следующего запроса. Пусто (или null), если has_next: false (достигнут конец списка).
has_next
boolean
required
true - есть следующая страница; false - достигнут конец списка.
total
[ "integer", "null" ]
Общее количество элементов (опционально). Может быть неточным (приблизительная оценка на момент запроса). Не возвращается, если сервер не может оценить общее количество.
POST/v1/units/list
1curl https://api.omninet.ru/v1/units/list \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "filter": {6    "quantity": null,7    "code": null8  },9  "pagination": {10    "cursor": null,11    "limit": 10012  }13}'
{
  "units": [
    {
      "code": "mm",
      "name": "миллиметр",
      "symbol": "мм",
      "description": null,
      "quantity": "string",
      "base_unit": "m",
      "factor": 0.001,
      "locales": [
        {
          "lang": "ru",
          "name": "миллиметр",
          "symbol": "мм",
          "description": null
        }
      ]
    }
  ],
  "pagination": {
    "next_cursor": null,
    "has_next": true,
    "total": null
  }
}

Список единиц