Получить поля товара по фильтру v 3.0 catalog.product.fields.getbyfilter

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: catalog

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

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод catalog.product.fields.getbyfilter возвращает описание полей простого товара в указанном торговом каталоге, включая свойства каталога.

Имя метода в REST 3.0 пишется в нижнем регистре: catalog.product.fields.getbyfilter. Вызов catalog.product.fields.getByFilter по адресу /rest/api/ вернет ошибку BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION.

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

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

Название
тип

Описание

filter*
object

Объект с идентификатором каталога. Описание параметра.

Массив условий в формате REST 3.0 метод не принимает

Параметр filter

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

Название
тип

Описание

iblockId*
integer

Идентификатор торгового каталога товаров. Ключ можно передать и в виде IBLOCK_ID.

Идентификатор можно получить методом catalog.catalog.list.

Для каталога вариаций метод возвращает ошибку

Метод всегда возвращает поля простого товара. Тип товара из фильтра не учитывается.

Примеры кода

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

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{user_id}/{токен_вебхука}/catalog.product.fields.getbyfilter

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"iblockId":25}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.fields.getbyfilter

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"iblockId":25},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.product.fields.getbyfilter

import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type ProductFieldsResult = {
  fields: Record<string, {
    TYPE: string
    IS_REQUIRED: boolean
    IS_READ_ONLY: boolean
    IS_IMMUTABLE: boolean
    NAME: string
    IS_DYNAMIC?: boolean
    IS_MULTIPLE?: boolean
    PROPERTY_TYPE?: string
    USER_TYPE?: string | null
  }>
}

try {
  const response = await $b24.actions.v3.call.make<ProductFieldsResult>({
    method: 'catalog.product.fields.getbyfilter',
    params: {
      filter: {
        iblockId: 25,
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Fields:', Object.keys(result.fields))
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getProductFields() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.product.fields.getbyfilter',
        params: {
          filter: {
            iblockId: 25,
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Fields:', Object.keys(result.fields))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getProductFields)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.product.fields.getbyfilter(
        filter={
            "iblockId": 25,
        },
    ).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}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'catalog.product.fields.getbyfilter',
            [
                'filter' => [
                    'iblockId' => 25,
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'catalog.product.fields.getbyfilter',
    {
        filter: {
            iblockId: 25,
        },
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'catalog.product.fields.getbyfilter',
    [
        'filter' => [
            'iblockId' => 25,
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.product.fields.getbyfilter", b24.Params{
	"filter": b24.Params{
		"iblockId": 25,
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("catalog.product.fields.getbyfilter: %w", err)
}

var result struct {
	Fields map[string]struct {
		Type       string `json:"TYPE"`
		IsRequired bool   `json:"IS_REQUIRED"`
		Name       string `json:"NAME"`
	} `json:"fields"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for code, field := range result.Fields {
	fmt.Println(code, field.Type, field.IsRequired)
}

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

HTTP-статус: 200

Метод возвращает описание всех полей товара и свойств каталога. В примере показана часть полей.

{
    "result": {
        "fields": {
            "ID": {
                "TYPE": "integer",
                "IS_REQUIRED": false,
                "IS_READ_ONLY": true,
                "IS_IMMUTABLE": false,
                "NAME": "Идентификатор"
            },
            "NAME": {
                "TYPE": "string",
                "IS_REQUIRED": true,
                "IS_READ_ONLY": false,
                "IS_IMMUTABLE": false,
                "NAME": "Наименование"
            },
            "IBLOCK_ID": {
                "TYPE": "integer",
                "IS_REQUIRED": true,
                "IS_READ_ONLY": false,
                "IS_IMMUTABLE": true,
                "NAME": "Идентификатор инфоблока"
            },
            "PREVIEW_PICTURE": {
                "TYPE": "file",
                "IS_REQUIRED": false,
                "IS_READ_ONLY": false,
                "IS_IMMUTABLE": false,
                "NAME": "Картинка анонса"
            },
            "PROPERTY_301": {
                "TYPE": "productproperty",
                "IS_REQUIRED": false,
                "IS_READ_ONLY": false,
                "IS_IMMUTABLE": false,
                "NAME": "Артикул",
                "IS_DYNAMIC": true,
                "IS_MULTIPLE": false,
                "PROPERTY_TYPE": "S",
                "USER_TYPE": ""
            },
            "PROPERTY_305": {
                "TYPE": "productproperty",
                "IS_REQUIRED": false,
                "IS_READ_ONLY": false,
                "IS_IMMUTABLE": false,
                "NAME": "Материал",
                "IS_DYNAMIC": true,
                "IS_MULTIPLE": true,
                "PROPERTY_TYPE": "S",
                "USER_TYPE": null
            },
            "TYPE": {
                "TYPE": "integer",
                "IS_REQUIRED": false,
                "IS_READ_ONLY": true,
                "IS_IMMUTABLE": false,
                "NAME": "Тип товара"
            },
            "QUANTITY": {
                "TYPE": "double",
                "IS_REQUIRED": false,
                "IS_READ_ONLY": false,
                "IS_IMMUTABLE": false,
                "NAME": "Доступное количество"
            },
            "VAT_ID": {
                "TYPE": "integer",
                "IS_REQUIRED": false,
                "IS_READ_ONLY": false,
                "IS_IMMUTABLE": false,
                "NAME": "Идентификатор НДС"
            },
            "MEASURE": {
                "TYPE": "integer",
                "IS_REQUIRED": false,
                "IS_READ_ONLY": false,
                "IS_IMMUTABLE": false,
                "NAME": "Единица измерения"
            }
        }
    },
    "time": {
        "start": 1792660854,
        "finish": 1792660854.262779,
        "duration": 0.26277899742126465,
        "processing": 0,
        "date_start": "2026-10-22T12:20:54+03:00",
        "date_finish": "2026-10-22T12:20:54+03:00",
        "operating_reset_at": 1792661400,
        "operating": 0
    }
}

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

Название `тип`	Описание
result `object`	Объект с данными ответа
result.fields `object`	Описания полей. Ключ — код поля в верхнем регистре, например `IBLOCK_ID`, для свойства — `PROPERTY_{id}`. Описание значения
time `time`	Информация о времени выполнения запроса

Описание поля

Название `тип`	Описание
TYPE `string`	Тип поля: `integer`, `double`, `string`, `char`, `datetime`, `file`, `list`. Для свойств — `productproperty`
IS_REQUIRED `boolean`	`true` — поле обязательно при создании товара
IS_READ_ONLY `boolean`	`true` — поле только для чтения
IS_IMMUTABLE `boolean`	`true` — поле можно задать только при создании товара
NAME `string`	Название поля
IS_DYNAMIC `boolean`	Только для свойств. `true` — поле является свойством каталога
IS_MULTIPLE `boolean`	Только для свойств. `true` — свойство множественное
PROPERTY_TYPE `string`	Только для свойств. Базовый тип свойства: `S` — строка `N` — число `L` — список `F` — файл `E` — привязка к элементам `G` — привязка к разделам
USER_TYPE `string`	Только для свойств. Пользовательский тип свойства, например `directory` или `Date`. `null` или пустая строка, если тип не задан

Коды полей возвращаются в формате прежней версии API, и их состав не совпадает с полями REST 3.0. Поля товара для методов REST 3.0 возвращает catalog.product.field.list. Ключи свойств PROPERTY_{id} из ответа передавайте в поле properties методов catalog.product.add и catalog.product.update.

В прежней версии API для каждого типа товара есть свой метод: catalog.product.getFieldsByFilter, catalog.product.sku.getFieldsByFilter, catalog.product.offer.getFieldsByFilter и catalog.product.service.getFieldsByFilter. Они возвращают поля в объекте с именем типа, например result.product или result.service, с ключами в формате iblockId и признаками isRequired, isReadOnly, isImmutable. В REST 3.0 метод один и возвращает только поля простого товара.

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "productType is not allowed for this catalog"
            }
        ]
    }
}

Название `тип`	Описание
error.code `string`	Строковый код ошибки. Используйте для идентификации типа исключения
error.message `string`	Текстовое описание ошибки
error.validation `array`	Массив c деталями ошибки. Присутствует только в ошибках валидации данных `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Название поля, в котором возникла ошибка валидации
error.validation[].message `string`	Описание ошибки, связанной с указанным полем

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

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`filter`	Обязательное поле `filter` не указано	Передайте объект `filter` с идентификатором каталога
`-`	Incorrect filter format	Передайте в `filter` ключ `iblockId`
`-`	parameter - iblockId is empty	Передайте `filter` объектом вида `{"iblockId": 25}` с числовым значением
`-`	iblock is not catalog	Инфоблок не является торговым каталогом. Передайте идентификатор торгового каталога
`-`	productType is not allowed for this catalog	Передайте идентификатор каталога товаров, а не каталога вариаций

Ошибка доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

HTTP-статус: 403

Поле	Описание ошибки	Как исправить
`-`	Доступ запрещен	Проверьте права пользователя на просмотр каталога

Ошибка имени метода

Код ошибки: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION

HTTP-статус: 404

Поле	Описание ошибки	Как исправить
`-`	Метод `catalog.product.fields.getByFilter` не найден	Вызовите метод в нижнем регистре: `catalog.product.fields.getbyfilter`

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Была ли статья полезна?

Получить поле товара

Получить список типов товаров

Получить поля товара по фильтру v 3.0 catalog.product.fields.getbyfilter

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

Параметр filterПараметр filter

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

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

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

Описание поляОписание поля

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

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

Ошибки валидации запросаОшибки валидации запроса

Ошибка доступаОшибка доступа

Ошибка имени методаОшибка имени метода

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

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

Была ли статья полезна?

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

Параметр filter

Примеры кода

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

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

Описание поля

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

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

Ошибки валидации запроса

Ошибка доступа

Ошибка имени метода

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

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