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

Поиск свойств позиций корзины

POST /v1/basket-item-properties/search

Ищет свойства позиций корзины по условиям фильтрации и сортировки, переданным в теле JSON-запроса. Для списка GET /v1/basket-item-properties параметры передают в URL, а для поиска — в теле запроса.

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

Поле	Тип	По умолч.	Описание
`filter`	object	—	Фильтрация по полям `GET /v1/basket-item-properties/fields`. Синтаксис фильтрации. Пример: `{ "basketId": 1001 }`
`select`	string \| string[]	—	Массив имён полей или строка через запятую. В `data` останутся выбранные поля
`sort`	string \| object \| string[]	—	Сортировка строкой, объектом или массивом имён полей. Минус перед именем означает убывание
`order`	object	—	Сортировка объектом. Если передан `sort`, действует он
`limit`	number	`50`	Количество записей, от 1 до 5000. По умолчанию `50`. Ноль заменяется на `50`, отрицательное значение — на `1`, значение больше 5000 — на `5000`
`offset`	number	`0`	Количество записей, которые нужно пропустить. По умолчанию `0`
`withTotal`	boolean	—	Принимается как `true` или `false`, но для свойств позиций корзины не меняет подсчёт и наличие `meta.total`
`autoWindow`	boolean	—	Принимает `true` и `false`

Пагинация. При limit > 50 Вайбкод читает несколько страниц по 50 записей. Для следующей выборки увеличьте offset на количество полученных записей. Продолжайте, пока meta.hasMore равен true.

Примеры

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

Terminal

curl -X POST "https://vibecode.bitrix24.tech/v1/basket-item-properties/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"filter":{"basketId":1001},"select":["id","name","value"],"sort":"-id","limit":2}'

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

Terminal

curl -X POST "https://vibecode.bitrix24.tech/v1/basket-item-properties/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"filter":{"basketId":1001},"select":["id","name","value"],"sort":"-id","limit":2}'

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/basket-item-properties/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "filter": {
      "basketId": 1001
    },
    "select": [
      "id",
      "name",
      "value"
    ],
    "sort": "-id",
    "limit": 2
  }),
})

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

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/basket-item-properties/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "filter": {
      "basketId": 1001
    },
    "select": [
      "id",
      "name",
      "value"
    ],
    "sort": "-id",
    "limit": 2
  }),
})

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

Поля ответа

Поле	Тип	Описание
`success`	boolean	Всегда `true` при успехе
`data`	array	Массив найденных свойств. Все поля — Поля свойства позиции корзины. Без совпадений — пустой массив
`meta.total`	number	Общее количество свойств под фильтр
`meta.hasMore`	boolean	Есть ли записи за пределами текущей выборки
`meta.durationMs`	number	Длительность запроса в миллисекундах
`meta.warnings`	array	Предупреждения о параметрах. Приходит, только если есть предупреждения
`meta.pageErrorSample`	object	Сведения об ошибке чтения последующих страниц. Приходит, если такая ошибка возникла

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

JSON

{
  "success": true,
  "data": [
    {
      "id": 1007,
      "name": "Product XML_ID",
      "value": "6967"
    },
    {
      "id": 1005,
      "name": "Catalog XML_ID",
      "value": "FUTURE-1C-CATALOG"
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false,
    "durationMs": 64
  }
}

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

400 — фильтр по неизвестному полю: