Получить список полей товарных позиций crm.item.productrow.fields

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

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

Scope: crm

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

Метод crm.item.productrow.fields получает описание полей товарной позиции: тип значения, обязательность и доступность для записи.

Вызовите метод перед crm.item.productrow.add, crm.item.productrow.update или crm.item.productrow.set, чтобы узнать, какие значения можно передать. Поля с isReadOnly: true метод рассчитывает сам и переданные значения игнорирует без ошибки.

Состав полей одинаковый для всех типов объектов CRM и не зависит от ownerType. Ограничения на длину текстовых полей — в статье Ограничения длины полей CRM.

Значение type — это тип данных поля из словаря типов. Поля с типом char принимают только Y или N.

Признак isRequired отражает описание поля в ядре и не всегда совпадает с проверками метода записи. Например, productId приходит с isRequired: true, но товарную позицию можно создать и без него — достаточно передать productName.

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

Без параметров.

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.productrow.fields

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.productrow.fields

// 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

type FieldItem = {
  type: string
  isRequired: boolean
  isReadOnly: boolean
  isImmutable: boolean
  isMultiple: boolean
  isDynamic: boolean
  title: string
}

// Shape of the payload returned in result (match the "response handling" section of the page)
type ProductRowFieldsResult = {
  fields: Record<string, FieldItem>
}

try {
  const response = await $b24.actions.v2.call.make<ProductRowFieldsResult>({
    method: 'crm.item.productrow.fields',
    params: {},
    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(Object.keys(result.fields))
  }
} 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 getProductRowFields() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.item.productrow.fields',
        params: {},
        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(Object.keys(result.fields))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.item.productrow.fields().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(
            'crm.item.productrow.fields',
            []
        );

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

    echo 'Success: ' . print_r($result, true);

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

BX24.callMethod(
    'crm.item.productrow.fields', {},
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.log(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'crm.item.productrow.fields',
    []
);

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

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

// Метод заворачивает ответ в объект с ключом "fields".
raw, ok := b24.Unwrap(res.Result, "fields")
if !ok {
	return fmt.Errorf("в ответе нет ключа fields")
}

fmt.Printf("%s\n", raw)

Ответ в случае успеха

HTTP-статус: 200

{
   "result":{
      "fields":{
         "id":{
            "type":"integer",
            "isRequired":false,
            "isReadOnly":true,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"ID"
         },
         "ownerId":{
            "type":"integer",
            "isRequired":true,
            "isReadOnly":false,
            "isImmutable":true,
            "isMultiple":false,
            "isDynamic":false,
            "title":"ID владельца"
         },
         "ownerType":{
            "type":"string",
            "isRequired":true,
            "isReadOnly":false,
            "isImmutable":true,
            "isMultiple":false,
            "isDynamic":false,
            "title":"Тип владельца"
         },
         "productId":{
            "type":"integer",
            "isRequired":true,
            "isReadOnly":false,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"Товар"
         },
         "productName":{
            "type":"string",
            "isRequired":false,
            "isReadOnly":false,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"Название товара"
         },
         "price":{
            "type":"double",
            "isRequired":false,
            "isReadOnly":false,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"Цена"
         },
         "priceExclusive":{
            "type":"double",
            "isRequired":false,
            "isReadOnly":true,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"Цена без налога со скидкой"
         },
         "priceNetto":{
            "type":"double",
            "isRequired":false,
            "isReadOnly":true,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"PRICE_NETTO"
         },
         "priceBrutto":{
            "type":"double",
            "isRequired":false,
            "isReadOnly":true,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"PRICE_BRUTTO"
         },
         "quantity":{
            "type":"double",
            "isRequired":false,
            "isReadOnly":false,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"Количество"
         },
         "discountTypeId":{
            "type":"integer",
            "isRequired":false,
            "isReadOnly":false,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"Тип скидки"
         },
         "discountRate":{
            "type":"double",
            "isRequired":false,
            "isReadOnly":false,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"Величина скидки"
         },
         "discountSum":{
            "type":"double",
            "isRequired":false,
            "isReadOnly":false,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"Сумма скидки"
         },
         "taxRate":{
            "type":"double",
            "isRequired":false,
            "isReadOnly":false,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"Налог"
         },
         "taxName":{
            "type":"string",
            "isRequired":false,
            "isReadOnly":false,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"TAX_NAME"
         },
         "taxIncluded":{
            "type":"char",
            "isRequired":false,
            "isReadOnly":false,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"Налог включен в цену"
         },
         "customized":{
            "type":"char",
            "isRequired":false,
            "isReadOnly":false,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"Изменен"
         },
         "measureCode":{
            "type":"integer",
            "isRequired":false,
            "isReadOnly":false,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"Код единицы измерения"
         },
         "measureName":{
            "type":"string",
            "isRequired":false,
            "isReadOnly":false,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"Единица измерения"
         },
         "sort":{
            "type":"integer",
            "isRequired":false,
            "isReadOnly":false,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"Сортировка"
         },
         "type":{
            "type":"integer",
            "isRequired":false,
            "isReadOnly":true,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"TYPE"
         },
         "storeId":{
            "type":"integer",
            "isRequired":false,
            "isReadOnly":true,
            "isImmutable":false,
            "isMultiple":false,
            "isDynamic":false,
            "title":"STORE_ID"
         }
      }
   },
   "time":{
      "start":1716812240.400023,
      "finish":1716812242.151703,
      "duration":1.7516798973083496,
      "processing":0.09682416915893555,
      "date_start":"2024-05-27T15:17:20+03:00",
      "date_finish":"2024-05-27T15:17:22+03:00"
   }
}

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

Название
тип

Описание

result
object

Корневой элемент ответа (подробное описание)

time
time

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

Объект result

Название
тип

Описание

fields
object

Объект в формате {"код поля": "описание поля"}, где ключ — идентификатор поля объекта crm_item_product_row, а значение — объект типа crm_rest_field_description

Чего в ответе нет: полей priceAccount и xmlId, которые нельзя записать, и признака upperName объекта crm_rest_field_description. Полный состав товарной позиции — в описании объекта crm_item_product_row.

Поля measureName и customized приходят с признаком isReadOnly: false, но методы записи их значения не сохраняют. Поле customized к тому же устаревшее — передавать его не нужно.

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

Своих кодов ошибок у метода нет: он не принимает параметров и не проверяет права на объекты CRM. В ответ приходят только системные ошибки — например, insufficient_scope, если у вебхука или приложения нет права crm.

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

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

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

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

Предыдущая
Получить неоплаченные товарные позиции
Следующая
Обзор методов