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

Поиск услуг

POST /v1/catalog-services/search

Поиск услуг товарного каталога по условиям, переданным в теле запроса.

В отличие от GET /v1/catalog-services, параметры filter, select, sort, limit и offset передаются в JSON-теле, а не в строке адреса — условия по нескольким полям задаются вложенной структурой. Как и список, поиск требует filter.iblockId — без этого поля запрос возвращает 400. Формат ответа тот же, что у списка.

Поля dateCreate, timestampX, dateActiveFrom и dateActiveTo не принимаются в filter: запрос возвращает 400 UNKNOWN_FILTER_FIELD до обращения к Битрикс24. Эти даты можно запрашивать через select и читать в ответе.

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

Параметр Тип Обяз. По умолч. Описание
filter object да — Фильтрация по полям GET /v1/catalog-services/fields. Ключ iblockId обязателен — ID товарного каталога из GET /v1/catalogs, у этого каталога не заполнен productIblockId. Услуги одного раздела отбирает iblockSectionId с ID из GET /v1/catalog-sections.
Синтаксис фильтрации. Пример: { "iblockId": 25, "iblockSectionId": 281 }
select string[] нет — Выборка полей: ["iblockId", "id", "name", "code"]. Если параметр передан, в нём обязательны iblockId и id. Без select приходит сокращённый набор полей: символьный код, внешний код, сортировка, ставка НДС, тексты, картинки и свойства каталога возвращаются только по явному перечислению — какие именно, сказано в Полях услуги
sort string нет — Поле сортировки. Префикс - — по убыванию: "-id"
limit number нет 50 Количество записей (до 5000)
offset number нет 0 Смещение от начала выборки

Примеры

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

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-services/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25, "iblockSectionId": 281 },
    "limit": 10
  }'

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

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-services/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25, "iblockSectionId": 281 },
    "limit": 10
  }'

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-services/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 25, iblockSectionId: 281 },
    limit: 10,
  }),
})

const { success, data, meta } = await res.json()
console.log(`Найдено: ${meta.total}`)

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-services/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 25, iblockSectionId: 281 },
    limit: 10,
  }),
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив услуг. Состав полей элемента — см. Поля услуги
meta.total number Сколько записей подошло под фильтр
meta.hasMore boolean Есть ли ещё записи за пределами limit
meta.durationMs number Длительность запроса в миллисекундах

Поля meta лежат рядом с data, а не внутри него. Обходить страницы нужно по meta.hasMore: длина data, равная limit, последней страницы не исключает.

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

JSON
{
  "success": true,
  "data": [
    {
      "active": true,
      "available": false,
      "bundle": false,
      "createdBy": 1295,
      "dateActiveFrom": null,
      "dateActiveTo": null,
      "dateCreate": "2026-10-08T20:50:59.000Z",
      "iblockId": 25,
      "iblockSectionId": 281,
      "id": 7231,
      "measure": 9,
      "modifiedBy": 1295,
      "name": "Монтаж кондиционера",
      "timestampX": "2026-10-08T20:50:59.000Z",
      "type": 7,
      "vatIncluded": true
    },
    {
      "active": true,
      "available": false,
      "bundle": false,
      "createdBy": 1295,
      "dateActiveFrom": null,
      "dateActiveTo": null,
      "dateCreate": "2026-10-08T20:51:00.000Z",
      "iblockId": 25,
      "iblockSectionId": 281,
      "id": 7233,
      "measure": 9,
      "modifiedBy": 1295,
      "name": "Чистка кондиционера",
      "timestampX": "2026-10-08T20:51:00.000Z",
      "type": 7,
      "vatIncluded": true
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false,
    "durationMs": 165
  }
}

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

400 — не передан обязательный фильтр:

JSON
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FILTER",
    "message": "POST /v1/catalog-services/search requires filter fields: iblockId. Example body: { \"filter\": {\"iblockId\":\"...\"} }"
  }
}

Ошибки

HTTP Код Описание
400 MISSING_REQUIRED_FILTER Не передан обязательный фильтр filter.iblockId. Запрос отклоняется до обращения к Битрикс24 — сообщение содержит имя недостающего поля и пример тела запроса
400 UNKNOWN_FILTER_FIELD Неизвестное поле фильтра или поле даты: dateCreate, timestampX, dateActiveFrom, dateActiveTo. Сообщение содержит список доступных полей
400 UNKNOWN_SORT_FIELD Сортировка по полю, которого нет у услуги. Сообщение содержит список доступных полей
400 UNKNOWN_SELECT_FIELD В select передано имя, которого нет у услуги. Сообщение содержит список доступных полей
400 SELECT_FIELD_NOT_RETURNED В select передано iblockSection — это имя в выборке не поддерживается. Основной раздел приходит в iblockSectionId
422 BITRIX_ERROR В select нет iblockId (Required select fields: iblockId)
422 BITRIX_ERROR В select нет id (Required select fields: id)
422 BITRIX_ERROR В filter.iblockId передан ID каталога вариаций, а не товарного каталога (productType is not allowed for this catalog)
422 BITRIX_ERROR Каталога с указанным iblockId нет (iblock is not catalog)
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key
429 RATE_LIMITED Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке x-ratelimit-limit (потолок делится на реплики). Повторите после срока из заголовка Retry-After

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

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