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

Scope: crm

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

Метод получает список полей товарных позиций.

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

Примеры кода

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

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 '{}' \
        https://**put_your_bitrix24_address**/rest/crm.item.productrow.fields?auth=**put_access_token_here**
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.item.productrow.fields', {}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(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>';

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

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":"Налог"
                 },
                 "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

Корневой элемент ответа

fields
object

Объект в формате {"field_1": "value_1", ... "field_N": "value_N"}, где field — идентификатор поля объекта crm_item_product_row, а value — объект типа crm_rest_field_descriptionon

time
time

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

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

HTTP-статус: 400

{
           "error":0,
           "error_description":"some error"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

0

Другие ошибки (например, фатальные ошибки)

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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

Предыдущая
Удалить товарную позицию
Следующая
Пользовательские поля в CRM