catalog.productPropertySection.list
Получить список секционных настроек свойств
Описание
Метод catalog.productPropertySection.list возвращает список секционных настроек свойств товаров и вариаций по фильтру.
Параметры
select
array
необязательный
Массив, содержащий список полей, которые необходимо выбрать.
Доступные поля:
displayExpanded— отображается ли свойство развернутым в фильтреdisplayType— вид свойства в умном фильтреfilterHint— подсказка в умном фильтре для посетителейpropertyId— идентификатор свойства товара или вариацииsmartFilter— отображается ли свойство в умном фильтре
По умолчанию возвращаются все доступные поля
filter
object
необязательный
Объект для фильтрации выбранных настроек в формате {"field_1": "value_1", ... "field_N": "value_N"}.
Возможные значения для field соответствуют полям, доступным в параметре select.
Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении
- %= — LIKE (аналогично =%)
- !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно
- !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении
- !%= — NOT LIKE (аналогично !=%)
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- ! — не равно
Если propertyId не передан, метод выбирает секционные настройки всех свойств торговых каталогов. Если передан propertyId, который не существует или не относится к торговому каталогу, метод вернет пустой список
order
object
необязательный
Объект для сортировки выбранных настроек в формате {"field_1": "order_1", ... "field_N": "order_N"}.
Возможные значения для field соответствуют полям, доступным в параметре select.
Возможные значения для order:
- ASC — в порядке возрастания
- DESC — в порядке убывания
Если параметр не передан, применяется сортировка propertyId 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":["propertyId","smartFilter","displayType","displayExpanded","filterHint"],"filter":{"propertyId":901},"order":{"propertyId":"ASC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productPropertySection.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["propertyId","smartFilter","displayType","displayExpanded","filterHint"],"filter":{"propertyId":901},"order":{"propertyId":"ASC"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.productPropertySection.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type ProductPropertySectionListResult = {
productPropertySections: {
displayExpanded: string
displayType: string
filterHint: string
propertyId: number
smartFilter: string
}[]
}
try {
// catalog.productPropertySection.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<ProductPropertySectionListResult>({
method: 'catalog.productPropertySection.list',
params: {
select: ['propertyId', 'smartFilter', 'displayType', 'displayExpanded', 'filterHint'],
filter: { propertyId: 901 },
order: { propertyId: 'ASC' },
start: 0,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.productPropertySections.length, result.productPropertySections)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function listProductPropertySections() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// catalog.productPropertySection.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'catalog.productPropertySection.list',
params: {
select: ['propertyId', 'smartFilter', 'displayType', 'displayExpanded', 'filterHint'],
filter: { propertyId: 901 },
order: { propertyId: 'ASC' },
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.productPropertySections.length, result.productPropertySections)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listProductPropertySections)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.product_property_section.list(
select=[
"propertyId",
"smartFilter",
"displayType",
"displayExpanded",
"filterHint",
],
filter={
"propertyId": 901,
},
order={
"propertyId": "ASC",
},
start=0,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'catalog.productPropertySection.list',
[
'select' => ['propertyId', 'smartFilter', 'displayType', 'displayExpanded', 'filterHint'],
'filter' => [
'propertyId' => 901,
],
'order' => ['propertyId' => 'ASC'],
]
);
print_r($response->getResponseData()->getResult());
} catch (\Throwable $exception) {
echo $exception->getMessage();
}
BX24.callMethod(
'catalog.productPropertySection.list',
{
select: ['propertyId', 'smartFilter', 'displayType', 'displayExpanded', 'filterHint'],
filter: {
propertyId: 901
},
order: { propertyId: 'ASC' }
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.productPropertySection.list',
[
'select' => ['propertyId', 'smartFilter', 'displayType', 'displayExpanded', 'filterHint'],
'filter' => ['propertyId' => 901],
'order' => ['propertyId' => 'ASC'],
]
);
print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.productPropertySection.list", b24.Params{
"select": []string{"propertyId", "smartFilter", "displayType", "displayExpanded", "filterHint"},
"filter": b24.Params{
"propertyId": 901,
},
"order": b24.Params{
"propertyId": "ASC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.productPropertySection.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "productPropertySections".
raw, ok := b24.Unwrap(res.Result, "productPropertySections")
if !ok {
return fmt.Errorf("в ответе нет ключа productPropertySections")
}
var items []struct {
DisplayExpanded string `json:"displayExpanded"`
DisplayType string `json:"displayType"`
FilterHint string `json:"filterHint"`
PropertyID b24.ID `json:"propertyId"`
SmartFilter string `json:"smartFilter"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.DisplayExpanded)
}
Ответ
HTTP-статус: 200
{
"result": {
"productPropertySections": [
{
"displayExpanded": "N",
"displayType": "F",
"filterHint": "Подсказка для фильтра",
"propertyId": 901,
"smartFilter": "Y"
}
]
},
"total": 1,
"time": {
"start": 1774266816,
"finish": 1774266816.883621,
"duration": 0.8836209774017334,
"processing": 0,
"date_start": "2026-03-23T14:53:36+03:00",
"date_finish": "2026-03-23T14:53:36+03:00",
"operating_reset_at": 1774267416,
"operating": 0
}
}
Возвращаемые данные
result
object
Корневой объект ответа
productPropertySections
catalog_product_property_section[]
Массив объектов секционных настроек свойства
next
integer
Смещение для следующей страницы. Поле возвращается, если есть еще записи
total
integer
Общее число записей. Поле не возвращается, если запрос выполнен со start = -1
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Access Denied"
}
| Код | Описание | Значение |
|---|---|---|
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 |

