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

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

POST /v1/catalog-measures/search

Ищет единицы измерения торгового каталога по условиям, переданным в теле запроса JSON-объектом.

Поля запроса (body)

Поле Тип Обяз. Описание
filter object нет Фильтрация по полям GET /v1/catalog-measures/fields.
Синтаксис фильтрации. Пример: {"isDefault": "N"}
sort string | object | array нет Сортировка строкой "-code", где минус означает убывание, объектом {"code": "desc"} или массивом строк ["-code"]. Без поля записи идут по возрастанию id
order object нет Синоним sort в форме объекта: {"code": "desc"}
select string[] нет Выборка полей: ["id", "code"]. Принимается и строка через запятую: "id,code"
limit number нет Количество записей, от 1 до 5000. По умолчанию 50
offset number нет Пропустить N записей. По умолчанию 0
autoWindow boolean нет Разбиение выборки по окнам дат. В схеме единицы измерения нет полей с датой, поэтому значение на выдачу не влияет

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-measures/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "isDefault": "N" },
    "sort": "-code",
    "limit": 2
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-measures/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "isDefault": "N" },
    "sort": "-code",
    "limit": 2
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-measures/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { isDefault: 'N' },
    sort: '-code',
    limit: 2,
  }),
})

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/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { isDefault: 'N' },
    sort: '-code',
    limit: 2,
  }),
})

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 Количество записей под фильтром
meta.hasMore boolean Есть ли ещё записи за пределами limit
meta.durationMs number Длительность запроса в миллисекундах
meta.warnings array Предупреждения о разборе запроса. Приходит, когда в select есть имя вне схемы — код UNKNOWN_SELECT_FIELD, или при limit: 0 — код LIMIT_ZERO_IGNORED: значение не применяется, отдаётся страница по умолчанию

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

JSON 
{
  "success": true,
  "data": [
    {
      "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": 5,
    "hasMore": true,
    "durationMs": 192
  }
}

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_SORT_FIELD",
    "message": "Unknown sort 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_OPERATOR Неизвестный оператор в условии фильтра, например $foo. Сообщение перечисляет поддерживаемые операторы
400 INVALID_FILTER_OPERATOR Логический ключ $or, $and или $not в фильтре. Условие ИЛИ по одному полю задаётся оператором $in, по разным полям — параллельными запросами через POST /v1/batch
400 INVALID_SORT_TYPE sort не строка, не объект и не массив строк
400 INVALID_SELECT_TYPE select не строка и не массив строк
400 INVALID_LIMIT limit не число
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 — Ошибки.

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