метод REST scope: catalog

catalog.productPropertyEnum.list

Получить список значений списочных свойств

Кто может выполнять: пользователь с правом «Просмотр каталога товаров»

Описание

Метод catalog.productPropertyEnum.list возвращает список значений списочных свойств по фильтру.

Параметры

select array необязательный

Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта catalog_product_property_enum).

Если параметр не передан, будут выбраны все поля

filter object необязательный

Объект для фильтрации выбранных значений в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Возможные значения для field соответствуют полям объекта catalog_product_property_enum.

Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении
- %= — LIKE (аналогично =%)
- !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно
- !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении
- !%= — NOT LIKE (аналогично !=%)
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- ! — не равно

Если propertyId не передан, метод выбирает значения всех списочных свойств торговых каталогов. Если передан propertyId, который не существует или не относится к торговому каталогу, метод вернет пустой список

order object необязательный

Объект для сортировки выбранных значений в формате {"field_1": "order_1", ... "field_N": "order_N"}.

Возможные значения для field соответствуют полям объекта catalog_product_property_enum.

Возможные значения для order:
- ASC — в порядке возрастания
- DESC — в порядке убывания

Если параметр не передан, применяется сортировка id ASC

start integer необязательный

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, передайте значение 50. Чтобы выбрать третью страницу результатов — 100 и так далее.

Формула расчета значения параметра start: start = (N - 1) * 50, где N — номер нужной страницы.

Если передать значение -1, в ответе не будет поля total

Примеры запроса

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"select":["id","propertyId","value","def","sort","xmlId"],"filter":{"propertyId":431},"order":{"id":"ASC"}}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productPropertyEnum.list

Ответ

HTTP-статус: 200

{
    "result": {
        "productPropertyEnums": [
        {
            "def": "N",
            "id": 433,
            "propertyId": 431,
            "sort": 500,
            "value": "первое",
            "xmlId": "1"
        },
        {
            "def": "N",
            "id": 435,
            "propertyId": 431,
            "sort": 500,
            "value": "второе",
            "xmlId": "2"
        },
        {
            "def": "N",
            "id": 437,
            "propertyId": 431,
            "sort": 500,
            "value": "третье",
            "xmlId": "3"
        },
        {
            "def": "N",
            "id": 439,
            "propertyId": 431,
            "sort": 500,
            "value": "четвертое",
            "xmlId": "4"
        },
        {
            "def": "N",
            "id": 441,
            "propertyId": 431,
            "sort": 500,
            "value": "пятое",
            "xmlId": "5"
        }
        ]
    },
    "total": 5,
    "time": {
        "start": 1774339997,
        "finish": 1774339997.456867,
        "duration": 0.456866979598999,
        "processing": 0,
        "date_start": "2026-03-24T11:13:17+03:00",
        "date_finish": "2026-03-24T11:13:17+03:00",
        "operating_reset_at": 1774340597,
        "operating": 0
    }
}

Возвращаемые данные

result object

Корневой объект ответа

productPropertyEnums catalog_product_property_enum[]

Массив объектов с информацией о выбранных значениях списочных свойств

next integer

Смещение для следующей страницы. Поле возвращается, если есть еще записи

total integer

Общее число записей. Поле не возвращается, если запрос выполнен со start = -1

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "100",
    "error_description": "Invalid value string to match with parameter filter. Should be value of type array."
}
Код Описание Значение
0 Access Denied Недостаточно прав для просмотра каталога
100 Invalid value {wrong_type} to match with parameter {filter}. Should be value of type array. Неверный тип данных у значения параметра filter
100 Invalid value {wrong_type} to match with parameter {select}. Should be value of type array. Неверный тип данных у значения параметра select
100 Invalid value {wrong_type} to match with parameter {order}. Should be value of type array. Неверный тип данных у значения параметра order

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.