Для AI-агентов: markdown этой страницы — /docs-content/entities/catalog-measures/list.md индекс документации — /llms.txt

Список единиц измерения

GET /v1/catalog-measures

Возвращает список единиц измерения торгового каталога.

Параметры

Параметр Тип По умолч. Описание
limit (query) number 50 Количество записей, от 1 до 5000. Нечисловое значение заменяется на 50
offset (query) number 0 Пропустить N записей. Значение не обязано быть кратным странице: ?offset=4 начинает выдачу с пятой записи
select (query) string — Выборка полей через запятую: ?select=id,code. Имена полей — из GET /v1/catalog-measures/fields
sort (query) string id Сортировка кратким синтаксисом: ?sort=-code, минус означает убывание. Без параметра записи идут по возрастанию id
order (query) object — Сортировка в форме объекта: ?order[code]=desc
filter (query) object — Фильтрация по полям GET /v1/catalog-measures/fields.
Синтаксис фильтрации. Пример: ?filter[code]=796
withTotal (query) string — Нужно ли количество записей: true или false. Параметр принимается, но на выдачу единиц измерения не влияет: meta.total приходит всегда. Листание и количество

Примеры

curl — личный ключ

Terminal 
curl -g "https://vibecode.bitrix24.tech/v1/catalog-measures?sort=-code&limit=3" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl -g "https://vibecode.bitrix24.tech/v1/catalog-measures?sort=-code&limit=3" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-measures?sort=-code&limit=3', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Найдено ${meta.total} единиц измерения`)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-measures?sort=-code&limit=3', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив единиц измерения
data[].id number Идентификатор единицы. Его передают в поле measure товара
data[].code number Код единицы по Общероссийскому классификатору единиц измерения (ОКЕИ)
data[].measureTitle string | null Название единицы измерения
data[].symbol string | null Краткое обозначение
data[].symbolIntl string | null Международное обозначение
data[].symbolLetterIntl string | null Международное буквенное обозначение
data[].isDefault string Единица по умолчанию: Y или N
meta.total number Количество записей под фильтром. Приходит всегда, в том числе при withTotal=false
meta.hasMore boolean Есть ли ещё записи за пределами limit
meta.warnings array Предупреждения о разборе запроса. Приходит, когда в select есть имя вне схемы — код UNKNOWN_SELECT_FIELD, имя поля в field. При limit=0 — код LIMIT_ZERO_IGNORED: значение не применяется, отдаётся страница по умолчанию

Пример ответа

Запрос ?sort=-code&limit=3:

JSON 
{
  "success": true,
  "data": [
    {
      "code": 796,
      "id": 9,
      "isDefault": "Y",
      "measureTitle": null,
      "symbol": null,
      "symbolIntl": "pc. 1",
      "symbolLetterIntl": "PCE. NMB"
    },
    {
      "code": 166,
      "id": 7,
      "isDefault": "N",
      "measureTitle": null,
      "symbol": null,
      "symbolIntl": "kg",
      "symbolLetterIntl": "KGM"
    },
    {
      "code": 163,
      "id": 5,
      "isDefault": "N",
      "measureTitle": null,
      "symbol": null,
      "symbolIntl": "g",
      "symbolLetterIntl": "GRM"
    }
  ],
  "meta": {
    "total": 6,
    "hasMore": true
  }
}

Пример ответа при ошибке

400 — фильтр по полю, которого нет в схеме:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'nope' for entity 'catalog-measures'. Available: id, code, measureTitle, symbol, symbolIntl, symbolLetterIntl, isDefault"
  }
}

Ошибки

HTTP Код Описание
400 UNKNOWN_FILTER_FIELD Фильтр по полю, которого нет в схеме единицы измерения. Сообщение перечисляет доступные поля
400 UNKNOWN_SORT_FIELD Сортировка по полю, которого нет в схеме. Сообщение перечисляет доступные поля
400 INVALID_FILTER В одном запросе смешаны две формы фильтра — filter[поле]=… и filter={...}. Передайте все условия в одной форме
400 INVALID_FILTER Значение filter не скобочная запись и не JSON-объект, например ?filter=notjson. Такой фильтр не применяется, поэтому запрос отклоняется
400 INVALID_FILTER_OPERATOR Неизвестный оператор в условии фильтра, например $foo. Сообщение перечисляет поддерживаемые операторы
400 INVALID_FILTER_OPERATOR Логический ключ $or, $and или $not в фильтре. Условие ИЛИ по одному полю задаётся оператором $in, по разным полям — параллельными запросами через POST /v1/batch
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
401 MISSING_API_KEY Не передан заголовок X-Api-Key
429 RATE_LIMITED Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке x-ratelimit-limit (потолок делится на реплики). Повторите после срока из заголовка Retry-After

Полный список общих ошибок API — Ошибки.

Известные особенности

Неизвестное имя в select не отклоняет запрос. В отличие от filter и sort, ответ приходит с кодом 200: в записях остаются только поля из схемы, а в meta.warnings появляется предупреждение UNKNOWN_SELECT_FIELD. Проверяйте meta.warnings, чтобы опечатка в имени поля не прошла незамеченной.

Смотрите также