Создать тип цены catalog.priceType.add

Scope: catalog

Кто может выполнять метод: администратор

Метод добавляет новый тип цены.

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

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

Название `тип`	Описание
fields* `object`	Значения полей для создания нового типа цены (подробное описание)

Параметр fields

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

Название `тип`	Описание
name* `string`	Код типа цены. Чтобы обеспечить стабильную работу внутренних сервисов, код типа цены необходимо указывать только английскими символами
base `string`	Является ли тип цены базовым. Возможные значения: `Y` — да `N` — нет По умолчанию `N`. Одновременно может существовать только один базовый тип цены. При добавлении нового базового типа предыдущий потеряет это свойство и перестанет быть базовым
sort `integer`	Сортировка. По умолчанию `100`
xmlId `string`	Внешний код. Можно использовать для синхронизации текущего типа цены с аналогичной позицией во внешней системе

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"Wholesale price","base":"N","sort":10,"xmlId":"wholesale"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.priceType.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"Wholesale price","base":"N","sort":10,"xmlId":"wholesale"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.priceType.add

try
        {
        	const response = await $b24.callMethod(
        		'catalog.priceType.add', 
        		{
        			fields: {
        				name: "Wholesale price",
        				base: "N",
        				sort: 10,
        				xmlId: "wholesale"
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error.ex);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.priceType.add',
                    [
                        'fields' => [
                            'name'  => "Wholesale price",
                            'base'  => "N",
                            'sort'  => 10,
                            'xmlId' => "wholesale",
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error()->ex);
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding price type: ' . $e->getMessage();
        }

BX24.callMethod(
            'catalog.priceType.add', 
            {
                fields: {
                    name: "Wholesale price",
                    base: "N",
                    sort: 10,
                    xmlId: "wholesale"
                }
            },
            function(result) {
                if (result.error())
                    console.error(result.error().ex);
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.priceType.add',
            [
                'fields' => [
                    'name' => 'Wholesale price',
                    'base' => 'N',
                    'sort' => 10,
                    'xmlId' => 'wholesale'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "priceType": {
                    "base": "N",
                    "createdBy": 1,
                    "dateCreate": "2024-10-02T17:49:44+02:00",
                    "id": 2,
                    "modifiedBy": 1,
                    "name": "Wholesale price",
                    "sort": 10,
                    "timestampX": "2024-10-02T17:49:44+02:00",
                    "xmlId": "wholesale"
                }
            },
            "time": {
                "start": 1716552521.40908,
                "finish": 1716552521.69852,
                "duration": 0.289434909820557,
                "processing": 0.011207103729248,
                "date_start": "2024-10-02T17:49:44+02:00",
                "date_finish": "2024-10-02T17:49:44+02:00",
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `object`	Корневой элемент ответа
priceType `catalog_price_type`	Объект с информацией о созданном типе цены
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error": 200040300020,
            "error_description": "Access Denied"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание
`200040300020`	Недостаточно прав для редактирования
`100`	Не передан обязательный параметр `fields`
`0`	Не установлены обязательные поля
`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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Обзор методов

Обновить тип цены

Создать тип цены catalog.priceType.add

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

Параметр fieldsПараметр fields

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

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

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

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

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

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

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