Получить список свойств товаров или вариаций catalog.productProperty.list

Scope: catalog

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

Метод catalog.productProperty.list возвращает список свойств товаров и вариаций по фильтру.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
select `array`	Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта catalog_product_property). Если параметр не передан, будут выбраны все поля
filter `object`	Объект для фильтрации выбранных свойств в формате `{"field_1": "value_1", ... "field_N": "value_N"}`. Возможные значения для `field` соответствуют полям объекта catalog_product_property. Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса: `>=` — больше либо равно `>` — больше `<=` — меньше либо равно `<` — меньше `%` — LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно `=%` — LIKE, поиск по подстроке. Символ `%` нужно передавать в значении `%=` — LIKE (аналогично `=%`) `!%` — NOT LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно `!=%` — NOT LIKE, поиск по подстроке. Символ `%` нужно передавать в значении `!%=` — NOT LIKE (аналогично `!=%`) `=` — равно, точное совпадение (используется по умолчанию) `!=` — не равно `!` — не равно Если `iblockId` не передан, метод выбирает свойства всех торговых каталогов. Если передан `iblockId`, который не является каталогом, метод вернет пустой список
order `object`	Объект для сортировки выбранных свойств в формате `{"field_1": "order_1", ... "field_N": "order_N"}`. Возможные значения для `field` соответствуют полям объекта catalog_product_property. Возможные значения для `order`: `ASC` — в порядке возрастания `DESC` — в порядке убывания Если параметр не передан, применяется сортировка `id ASC`
start `integer`	Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение `50`. Чтобы выбрать третью страницу результатов — `100` и так далее. Формула расчета значения параметра `start`: `start = (N - 1) * 50`, где `N` — номер нужной страницы. Если передать значение `-1`, в ответе не будет поля `total`

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"select":["id","name","iblockId","propertyType"],"filter":{"iblockId":19},"order":{"id":"ASC"}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productProperty.list

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"select":["id","name","iblockId","propertyType"],"filter":{"iblockId":19},"order":{"id":"ASC"},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/catalog.productProperty.list

try {
            const response = await $b24.callMethod('catalog.productProperty.list', {
                select: ['id', 'name', 'iblockId', 'propertyType'],
                filter: { iblockId: 19 },
                order: { id: 'ASC' }
            });
        
            console.log(response.getData().result);
        } catch (error) {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.productProperty.list',
                    [
                        'select' => ['id', 'name', 'iblockId', 'propertyType'],
                        'filter' => [
                            'iblockId' => 19,
                        ],
                        'order' => ['id' => 'ASC'],
                    ]
                );
        
            print_r($response->getResponseData()->getResult());
        } catch (\Throwable $exception) {
            echo $exception->getMessage();
        }

BX24.callMethod(
            'catalog.productProperty.list',
            {
                select: ['id', 'name', 'iblockId', 'propertyType'],
                filter: {
                    iblockId: 19
                },
                order: { id: 'ASC' }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.productProperty.list',
            [
                'select' => ['id', 'name', 'iblockId', 'propertyType'],
                'filter' => ['iblockId' => 19],
                'order' => ['id' => 'ASC'],
            ]
        );
        
        print_r($result);

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "productProperties": [
                    {
                        "iblockId": 19,
                        "id": 115,
                        "name": "Марка",
                        "propertyType": "L"
                    },
                    {
                        "iblockId": 19,
                        "id": 659,
                        "name": "Рубрика",
                        "propertyType": "S"
                    },
                    ... // описание для каждого свойства
                ]
            },
            "next": 50,
            "total": 51,
            "time": {
                "start": 1773933226,
                "finish": 1773933226.400275,
                "duration": 0.40027499198913574,
                "processing": 0,
                "date_start": "2026-03-19T18:13:46+03:00",
                "date_finish": "2026-03-19T18:13:46+03:00",
                "operating_reset_at": 1773933826,
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `object`	Корневой объект ответа
productProperties `catalog_product_property[]`	Массив объектов с информацией о выбранных свойствах
next `integer`	Смещение для следующей страницы. Поле возвращается, если есть еще записи
total `integer`	Общее число записей. Поле не возвращается, если запрос выполнен со `start = -1`
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error": "0",
            "error_description": "Access Denied"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

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

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

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

Удалить свойство

Получить список свойств товаров или вариаций catalog.productProperty.list

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

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

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение