Получить список полей цены v 3.0 catalog.price.field.list

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

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

Scope: catalog

Кто может выполнять метод: любой пользователь

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

Метод catalog.price.field.list возвращает список доступных полей цены.

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

Название
тип

Описание

select
array

Массив строк с именами свойств описания, которые нужно вернуть для каждого поля.

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

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

name — имя поля
type — тип данных
title — заголовок
description — описание
validationRules — правила валидации
requiredGroups — группы обязательности
filterable — признак доступности в фильтре
sortable — признак доступности в сортировке
editable — признак редактируемости
editableGroups — группы операций, в которых поле редактируется
multiple — признак множественного значения
elementType — тип элемента для составных полей

Примеры кода

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

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

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

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 '{"select":["name","type","requiredGroups","editableGroups"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.price.field.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["name","type","requiredGroups","editableGroups"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.price.field.list

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

declare const $b24: B24Frame

type PriceFieldListResult = {
  items: Array<{
    name?: string
    type?: string
    requiredGroups?: string[] | null
    editableGroups?: string[] | null
  }>
}

try {
  const response = await $b24.actions.v3.call.make<PriceFieldListResult>({
    method: 'catalog.price.field.list',
    params: {
      select: [
        'name',
        'type',
        'requiredGroups',
        'editableGroups',
      ],
    },
    requestId: Text.getUuidRfc4122()
  })

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

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.price.field.list',
        params: {
          select: [
            'name',
            'type',
            'requiredGroups',
            'editableGroups',
          ],
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

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

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

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.price.field.list(
        select=[
            "name",
            "type",
            "requiredGroups",
            "editableGroups",
        ],
    ).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.price.field.list',
            [
                'select' => [
                    'name',
                    'type',
                    'requiredGroups',
                    'editableGroups',
                ],
            ]
        );

    $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.price.field.list',
    {
        select: [
            'name',
            'type',
            'requiredGroups',
            'editableGroups',
        ],
    },
    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.price.field.list',
    [
        'select' => [
            'name',
            'type',
            'requiredGroups',
            'editableGroups',
        ],
    ]
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.price.field.list", b24.Params{
	"select": []string{"name", "type", "requiredGroups", "editableGroups"},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("catalog.price.field.list: %w", err)
}

var result struct {
	Items []struct {
		Name           string   `json:"name"`
		Type           string   `json:"type"`
		RequiredGroups []string `json:"requiredGroups"`
		EditableGroups []string `json:"editableGroups"`
	} `json:"items"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, field := range result.Items {
	fmt.Println(field.Name, field.Type)
}

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

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "name": "id",
                "type": "int",
                "requiredGroups": null,
                "editableGroups": null
            },
            {
                "name": "productId",
                "type": "int",
                "requiredGroups": [
                    "add"
                ],
                "editableGroups": null
            },
            {
                "name": "catalogGroupId",
                "type": "int",
                "requiredGroups": [
                    "add"
                ],
                "editableGroups": null
            },
            {
                "name": "price",
                "type": "float",
                "requiredGroups": [
                    "add"
                ],
                "editableGroups": [
                    "add",
                    "update"
                ]
            },
            {
                "name": "currency",
                "type": "string",
                "requiredGroups": [
                    "add"
                ],
                "editableGroups": [
                    "add",
                    "update"
                ]
            },
            {
                "name": "extraId",
                "type": "int",
                "requiredGroups": null,
                "editableGroups": [
                    "add",
                    "update"
                ]
            },
            {
                "name": "quantityFrom",
                "type": "int",
                "requiredGroups": null,
                "editableGroups": [
                    "add",
                    "update"
                ]
            },
            {
                "name": "quantityTo",
                "type": "int",
                "requiredGroups": null,
                "editableGroups": [
                    "add",
                    "update"
                ]
            },
            {
                "name": "priceScale",
                "type": "float",
                "requiredGroups": null,
                "editableGroups": null
            },
            {
                "name": "timestampX",
                "type": "object",
                "requiredGroups": null,
                "editableGroups": null
            }
        ]
    },
    "time": {
        "start": 1792668103,
        "finish": 1792668103.710875,
        "duration": 0.7108750343322754,
        "processing": 0,
        "date_start": "2026-10-22T14:21:43+03:00",
        "date_finish": "2026-10-22T14:21:43+03:00",
        "operating_reset_at": 1792668660,
        "operating": 0
    }
}

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

Название `тип`	Описание
result `object`	Объект с данными ответа
result.items `array`	Массив описаний полей цены. Свойства каждого описания зависят от `select`. Описание элемента
time `time`	Информация о времени выполнения запроса

Элемент items

Состав описания зависит от select. Таблица содержит все свойства, которые можно запросить.

Название `тип`	Описание
name `string`	Имя поля: `id`, `productId`, `catalogGroupId`, `price`, `currency`, `extraId`, `quantityFrom`, `quantityTo`, `priceScale`, `timestampX`
type `string`	Тип в метаданных: `int`, `float`, `string`, `object`. Для `timestampX` возвращается `object`, хотя в ответах методов значение передается строкой ISO 8601
title `string`	Заголовок поля. Совпадает с `name`
description `string` или `null`	Описание поля. Для полей цены — `null`
validationRules `array`	Массив объектов с правилами валидации. Для `currency` возвращается `[{}]` — ограничение длины в три символа, параметры правила не сериализуются. Для остальных полей — `[]`
requiredGroups `array` или `null`	Массив операций, в которых поле обязательно. Для `productId`, `catalogGroupId`, `price` и `currency` — `["add"]`, для остальных полей — `null`
filterable `boolean`	`true` — поле доступно для фильтрации. Для всех полей цены — `true`
sortable `boolean`	`true` — поле доступно для сортировки. Для всех полей цены — `true`
editable `boolean`	`true` — поле можно передавать в операциях из `editableGroups`, `false` — нельзя
editableGroups `array` или `null`	Массив операций, в которых поле можно задавать. Для `price`, `currency`, `extraId`, `quantityFrom` и `quantityTo` — `["add", "update"]`, для остальных полей — `null`. Поля `productId` и `catalogGroupId` метод catalog.price.add принимает и требует, хотя `editableGroups` для них равно `null`
multiple `boolean`	Признак множественного значения. Для всех полей цены — `false`
elementType `string` или `null`	Тип элемента составного поля. Для всех полей цены — `null`

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION",
        "message": "Неизвестное поле `foo` для сущности `DtoFieldDto`"
    }
}

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

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

Ошибки в параметре `select`

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле	Описание ошибки	Как исправить
`select`	Неизвестное поле `#FIELD#` для сущности `DtoFieldDto`	Передайте в `select` массив строк только из списка параметра `select`

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION

Поле	Описание ошибки	Как исправить
`select`	Не удается распознать выражение select `#SELECT#`	Передайте `select` как массив строк, например `["name","type"]`

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

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

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

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.price.field.list

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

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

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

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

Элемент itemsЭлемент items

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

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

Ошибки в параметре Ошибки в параметре select

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

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

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

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

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

Примеры кода

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

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

Элемент items

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

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

Ошибки в параметре `select`

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

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

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