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

Поиск позиций складских документов

POST /v1/catalog-document-elements/search

Ищет позиции складских документов по условиям из тела запроса.

Отбирает те же записи, что GET /v1/catalog-document-elements, но условия передаются JSON-объектом, а не строкой запроса: списки значений через $in, диапазоны через $gte и $lte, несколько условий сразу.

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

Поле Тип По умолч. Описание
filter object — Фильтрация по полям GET /v1/catalog-document-elements/fields.
Синтаксис фильтрации. Пример: {"docId": {"$in": [75, 79]}} — позиции двух документов, docId берётся из GET /v1/catalog-documents
select string[] — Поля в ответе: ["id", "docId", "amount"]. Принимается и строка через запятую: "id,docId,amount". Поле id возвращается всегда. Имена — из GET /v1/catalog-document-elements/fields
sort string | object | string[] — Сортировка: "-id" — по убыванию, "amount" — по возрастанию. Принимается и объект {"amount": "desc"}, и массив строк ["-amount", "id"], а также имя поля order вместо sort
limit number 50 Количество записей, от 1 до 5000
offset number 0 Сколько записей пропустить от начала выборки

При limit больше 50 Вайбкод собирает ответ из нескольких страниц автоматически. Следующую страницу запрашивайте с offset, пока meta.hasMore равно true.

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-document-elements/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "docId": { "$in": [75, 79] } },
    "select": ["id", "docId", "elementId", "amount", "storeTo"],
    "sort": "-id",
    "limit": 10
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-document-elements/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "docId": { "$in": [75, 79] } },
    "select": ["id", "docId", "elementId", "amount", "storeTo"],
    "sort": "-id",
    "limit": 10
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-document-elements/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { docId: { $in: [75, 79] } },
    select: ['id', 'docId', 'elementId', 'amount', 'storeTo'],
    sort: '-id',
    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-document-elements/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { docId: { $in: [75, 79] } },
    select: ['id', 'docId', 'elementId', 'amount', 'storeTo'],
    sort: '-id',
    limit: 10,
  }),
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив позиций. При заданном select — только перечисленные поля и id
data[].id number Идентификатор позиции
data[].docId number Идентификатор складского документа. Документ — GET /v1/catalog-documents/:id
data[].elementId number Идентификатор товара. Товар — GET /v1/catalog-products/:id
data[].amount number | null Количество товара, null — не задано
data[].purchasingPrice number | null Закупочная цена за единицу, null — не задана
data[].storeFrom number | null Склад отправления, null — склад не задан. Склады — GET /v1/warehouses
data[].storeTo number | null Склад получения, null — склад не задан. Склады — GET /v1/warehouses
meta.total number Общее количество позиций, подходящих под фильтр
meta.hasMore boolean Есть ли ещё позиции за пределами limit
meta.durationMs number Длительность запроса в миллисекундах
meta.warnings array Предупреждения о запросе, каждое с полями code, message, field. Приходит, когда в select есть имя, которого нет в схеме, — код UNKNOWN_SELECT_FIELD

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 27,
      "docId": 75,
      "elementId": 6907,
      "amount": 5,
      "storeTo": 1
    },
    {
      "id": 21,
      "docId": 79,
      "elementId": 6907,
      "amount": 5,
      "storeTo": 3
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false,
    "durationMs": 138
  }
}

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'bogus' for entity 'catalog-document-elements'. Available: id, docId, elementId, amount, purchasingPrice, storeFrom, storeTo"
  }
}

Ошибки

HTTP Код Описание
400 UNKNOWN_FILTER_FIELD Фильтр по полю, которого нет в схеме. Сообщение перечисляет допустимые поля
400 UNKNOWN_SORT_FIELD Сортировка по полю, которого нет в схеме. Сообщение перечисляет допустимые поля
400 INVALID_FILTER_OPERATOR В фильтре передан неподдерживаемый оператор. Сообщение перечисляет поддерживаемые
400 INVALID_LIMIT limit не число, например строка "abc"
400 INVALID_SELECT_TYPE select не строка и не массив строк
400 INVALID_SORT_TYPE sort не строка, не объект и не массив строк
400 INVALID_REQUEST Тело запроса — не JSON-объект, например массив
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Переданный API-ключ не найден
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
429 RATE_LIMITED Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Действующее значение — в заголовке x-ratelimit-limit. Повторите после срока из заголовка Retry-After

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

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