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

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

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

Scope: catalog

Кто может выполнять метод: пользователь с правом «Управление типами цен»

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

Метод catalog.pricetype.add создает тип цены и возвращает его поля.

В REST 3.0 имя метода пишется в нижнем регистре: catalog.pricetype.add. Вызов catalog.priceType.add по адресу /rest/api/ возвращает ошибку BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION.

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

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

Название `тип`	Описание
fields* `object`	Объект с полями нового типа цены. Описание полей

Параметр fields

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

Поля id, timestampX, modifiedBy, dateCreate и createdBy заполняются автоматически. Если передать их в fields, метод вернет ошибку.

Новый тип цены доступен для просмотра и покупки только группе администраторов. Чтобы открыть его другим группам пользователей, используйте методы catalog.pricetype.group.*.

Примеры кода

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

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

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

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 '{"fields":{"name":"Оптовая цена","sort":200,"xmlId":"wholesale-opt"}}' \
https://**put_your_bitrix24_address**/rest/api/**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":"Оптовая цена","sort":200,"xmlId":"wholesale-opt"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.pricetype.add

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

declare const $b24: B24Frame

type PriceTypeAddResult = {
  item: {
    id: number
    name: string
    base: boolean
    sort: number
    xmlId: string
    timestampX: ISODate
    modifiedBy: number
    dateCreate: ISODate
    createdBy: number
  }
}

try {
  const response = await $b24.actions.v3.call.make<PriceTypeAddResult>({
    method: 'catalog.pricetype.add',
    params: {
      fields: {
        name: 'Оптовая цена',
        sort: 200,
        xmlId: 'wholesale-opt',
      },
    },
    requestId: Text.getUuidRfc4122()
  })

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

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.pricetype.add',
        params: {
          fields: {
            name: 'Оптовая цена',
            sort: 200,
            xmlId: 'wholesale-opt',
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

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

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

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.pricetype.add(
        fields={
            "name": "Оптовая цена",
            "sort": 200,
            "xmlId": "wholesale-opt",
        },
    ).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.pricetype.add',
            [
                'fields' => [
                    'name' => 'Оптовая цена',
                    'sort' => 200,
                    'xmlId' => 'wholesale-opt',
                ],
            ]
        );

    $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.pricetype.add',
    {
        fields: {
            name: 'Оптовая цена',
            sort: 200,
            xmlId: 'wholesale-opt',
        },
    },
    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.pricetype.add',
    [
        'fields' => [
            'name' => 'Оптовая цена',
            'sort' => 200,
            'xmlId' => 'wholesale-opt',
        ],
    ]
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.pricetype.add", b24.Params{
	"fields": b24.Params{
		"name":  "Оптовая цена",
		"sort":  200,
		"xmlId": "wholesale-opt",
	},
})
if err != nil {
	return fmt.Errorf("catalog.pricetype.add: %w", err)
}

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

var item struct {
	ID   int    `json:"id"`
	Name string `json:"name"`
	Base bool   `json:"base"`
	Sort int    `json:"sort"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Name)

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

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 31,
            "name": "Оптовая цена",
            "base": false,
            "sort": 200,
            "xmlId": "wholesale-opt",
            "timestampX": "2026-10-22T14:23:07+03:00",
            "modifiedBy": 1,
            "dateCreate": "2026-10-22T14:23:07+03:00",
            "createdBy": 1
        }
    },
    "time": {
        "start": 1792668187,
        "finish": 1792668187.97024,
        "duration": 0.9702401161193848,
        "processing": 0,
        "date_start": "2026-10-22T14:23:07+03:00",
        "date_finish": "2026-10-22T14:23:07+03:00",
        "operating_reset_at": 1792668780,
        "operating": 0
    }
}

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

Название `тип`	Описание
result `object`	Объект с данными ответа
result.item `object`	Поля созданного типа цены. Описание полей
time `time`	Информация о времени выполнения запроса

Объект item

Название `тип`	Описание
id `integer`	Идентификатор типа цены
name `string`	Название типа цены
base `boolean`	Признак базового типа цены: `true` — базовый, `false` — обычный
sort `integer`	Сортировка
xmlId `string`	Внешний код типа цены. Пустая строка, если код не задан
timestampX `datetime`	Дата и время последнего изменения
modifiedBy `integer`	Идентификатор пользователя, который последним изменил тип цены
dateCreate `datetime`	Дата и время создания
createdBy `integer`	Идентификатор пользователя, который создал тип цены

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта",
        "validation": [
            {
                "message": "Не заполнено обязательное поле \"name\"",
                "field": "name"
            }
        ]
    }
}

Название `тип`	Описание
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_DTOVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`name`	Не заполнено обязательное поле "name"	Передайте `name` в `fields`
`#FIELD#`	Поле "#FIELD#" не доступно к заполнению	Уберите из `fields` поля только для чтения: `id`, `timestampX`, `modifiedBy`, `dateCreate`, `createdBy`

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`fields`	Обязательное поле `fields` не указано	Передайте объект `fields`
`name`	The field name must not be null	Передайте в `name` непустую строку
`-`	Не указан код типа цен`<br>`	Передайте в `name` непустую строку
`base`	В поле `base` требуется тип данных `bool` для такого запроса	Передайте `true` или `false`, а не `Y` или `N`
`base`	The field base must be true or false	Не передавайте `null` в `base`
`sort`	The field sort must be an integer	Не передавайте `null` в `sort`

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Неизвестное поле `#FIELD#` для сущности `PriceTypeDto`	Передайте в `fields` только `name`, `base`, `sort`, `xmlId`

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

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

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

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

Создать тип цены

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

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

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

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

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

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

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

Объект itemОбъект item

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

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

Ошибки валидации объектаОшибки валидации объекта

Ошибки валидации запросаОшибки валидации запроса

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

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

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

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

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

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

Параметр fields

Примеры кода

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

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

Объект item

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

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

Ошибки валидации объекта

Ошибки валидации запроса

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

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

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

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