Получить значения полей свойства товара или вариации v 3.0 catalog.product.property.get

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

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

Scope: catalog

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

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

Метод catalog.product.property.get возвращает по идентификатору поля свойства товаров или вариаций, например название, тип и символьный код.

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

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

Название
тип

Описание

id*
integer

Идентификатор свойства.

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

select
array

Список полей свойства, которые нужно вернуть в ответе.

Доступные поля:

  • id — идентификатор свойства
  • timestampX — дата и время последнего изменения
  • iblockId — идентификатор торгового каталога
  • name — название
  • active — активность
  • sort — сортировка
  • code — символьный код
  • defaultValue — значение по умолчанию
  • propertyType — базовый тип
  • userType — пользовательский тип
  • userTypeSettings — настройки пользовательского типа
  • rowCount — число строк поля ввода
  • colCount — число колонок поля ввода
  • listType — внешний вид списка
  • multiple — множественное свойство
  • multipleCnt — число полей для множественных значений
  • xmlId — внешний идентификатор
  • fileType — расширения файлов
  • linkIblockId — идентификатор связанного инфоблока
  • withDescription — можно ли добавить описание к значению
  • searchable — участие в поиске
  • filtrable — участие в фильтрации
  • isRequired — обязательно ли для заполнения
  • hint — подсказка
  • controlId — имя поля свойства в формах инфоблока

По умолчанию: все поля

Примеры кода

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

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

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/catalog.product.property.get

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":295,"select":["id","iblockId","name","code","propertyType","listType","multiple","controlId"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.property.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":295,"select":["id","iblockId","name","code","propertyType","listType","multiple","controlId"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.product.property.get
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type ProductPropertyGetResult = {
  item: {
    id: number
    iblockId: number
    name: string
    code: string | null
    propertyType: string
    listType: string
    multiple: boolean
    controlId: string
  }
}

try {
  const response = await $b24.actions.v3.call.make<ProductPropertyGetResult>({
    method: 'catalog.product.property.get',
    params: {
      id: 295,
      select: ['id', 'iblockId', 'name', 'code', 'propertyType', 'listType', 'multiple', 'controlId'],
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Property:', result.item.id, result.item.name, result.item.propertyType)
  }
} 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 getProductProperty() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.product.property.get',
        params: {
          id: 295,
          select: ['id', 'iblockId', 'name', 'code', 'propertyType', 'listType', 'multiple', 'controlId'],
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

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

      const result = response.getData().result
      console.info('Property:', result.item.id, result.item.name, result.item.propertyType)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

У методов catalog.product.property.* REST 3.0 нет готовых оберток в b24pysdk, и SDK отправляет в REST 3.0 только методы из списка Config().api_v3_methods. Добавьте метод в этот список и вызовите его через call_method токена клиента с prefer_version=3.

from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError

method = "catalog.product.property.get"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
bitrix_token = client.get_token()

try:
    response = bitrix_token.call_method(
        api_method=method,
        params={
            "id": 295,
            "select": ["id", "iblockId", "name", "code", "propertyType", "listType", "multiple", "controlId"],
        },
        prefer_version=3,
    )
    result = response["result"]
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"code: {error.code}",
        f"message: {error.error.message}",
        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.property.get',
            [
                'id' => 295,
                'select' => ['id', 'iblockId', 'name', 'code', 'propertyType', 'listType', 'multiple', 'controlId'],
            ]
        );

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

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}

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

BX24.callMethod(
    'catalog.product.property.get',
    {
        id: 295,
        select: ['id', 'iblockId', 'name', 'code', 'propertyType', 'listType', 'multiple', 'controlId'],
    },
    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.property.get',
    [
        'id' => 295,
        'select' => ['id', 'iblockId', 'name', 'code', 'propertyType', 'listType', 'multiple', 'controlId'],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.product.property.get", b24.Params{
	"id":     295,
	"select": []string{"id", "iblockId", "name", "code", "propertyType", "listType", "multiple", "controlId"},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("catalog.product.property.get: %w", err)
}

var result struct {
	Item struct {
		ID           int    `json:"id"`
		Name         string `json:"name"`
		PropertyType string `json:"propertyType"`
		ControlID    string `json:"controlId"`
	} `json:"item"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(result.Item.ID, result.Item.Name, result.Item.PropertyType, result.Item.ControlID)

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

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 295,
            "iblockId": 25,
            "name": "Новинка",
            "code": "NEWPRODUCT",
            "propertyType": "L",
            "listType": "C",
            "multiple": false,
            "controlId": "PROPERTY_295"
        }
    },
    "time": {
        "start": 1794924748,
        "finish": 1794924748.634806,
        "duration": 0.6348059177398682,
        "processing": 0,
        "date_start": "2026-11-17T17:12:28+03:00",
        "date_finish": "2026-11-17T17:12:28+03:00",
        "operating_reset_at": 1794925320,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

Объект с данными ответа

result.item
object

Поля свойства. Состав зависит от select. Описание полей

time
time

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

Объект item

Название
тип

Описание

id
integer

Идентификатор свойства

timestampX
datetime

Дата и время последнего изменения свойства

iblockId
integer

Идентификатор торгового каталога, к которому относится свойство

name
string

Название свойства

active
boolean

Активность свойства:

  • true — свойство активно
  • false — свойство неактивно

sort
integer

Сортировка

code
string или null

Символьный код свойства

defaultValue
string или null

Значение по умолчанию

propertyType
string

Базовый тип свойства:

  • N — число
  • S — строка
  • L — список
  • F — файл
  • E — привязка к элементам
  • G — привязка к разделам

userType
string или null

Пользовательский тип свойства, например Money или DateTime. У свойства без пользовательского типа и у свойства-флажка — null

userTypeSettings
object или array

Настройки пользовательского типа. Если настроек нет — пустой массив []

rowCount
integer

Число строк поля ввода

colCount
integer

Число колонок поля ввода

listType
string

Внешний вид списка:

  • L — выпадающий список
  • C — флажки

multiple
boolean

Множественное свойство:

  • true — свойство хранит несколько значений
  • false — одно значение

multipleCnt
integer или null

Число полей для ввода множественных значений

xmlId
string или null

Внешний идентификатор свойства

fileType
string или null

Расширения файлов для свойства типа F

linkIblockId
integer или null

Для свойств типа E и G — идентификатор инфоблока, к элементам или разделам которого привязано свойство

withDescription
boolean

true — к значению свойства можно добавить описание

searchable
boolean

true — значения свойства участвуют в поиске

filtrable
boolean

true — свойство участвует в фильтрации товаров

isRequired
boolean

true — свойство обязательно для заполнения в карточке товара

hint
string или null

Подсказка к полю свойства

controlId
string

Имя поля свойства в формах инфоблока в формате PROPERTY_<id>, например PROPERTY_1291

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
        "message": "Запись с ID = `99999` не найдена"
    }
}

Название
тип

Описание

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

Поле

Описание ошибки

Как исправить

id

Обязательное поле id не указано

Передайте id — целое число больше 0

Ошибка отсутствия объекта

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Поле

Описание ошибки

Как исправить

id

Запись с ID = #ID# не найдена

Свойство не найдено или не относится к торговому каталогу. Проверьте идентификатор методом catalog.product.property.list

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

Описание ошибки

Как исправить

select

Неизвестное поле #FIELD# для сущности ProductPropertyDto

Укажите в select только поля из описания параметра select

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле

Описание ошибки

Как исправить

-

Доступ запрещен

Проверьте, что у пользователя есть право «Просмотр каталога товаров»

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

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

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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