Добавить привязку типа цен к группе покупателей v 3.0 catalog.pricetype.group.add

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

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

Scope: catalog

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

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

Метод catalog.pricetype.group.add добавляет привязку типа цены к группе покупателей и возвращает ее поля.

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

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

Название
тип

Описание

fields*
object

Объект с полями новой привязки. Описание полей

Параметр fields

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

Название
тип

Описание

catalogGroupId*
integer

Идентификатор типа цены.

Идентификатор можно получить методом catalog.pricetype.list

groupId*
integer

Идентификатор группы пользователей.

При создании типа цены Битрикс24 сам добавляет для него привязки к группе администраторов с идентификатором 1 с обоими типами доступа

access*
string

Тип доступа к цене.

Возможные значения:

  • Y — право на покупку по этому типу цены
  • N — право на просмотр этого типа цены

Значения в другом регистре, например y, вызывают ошибку валидации

Сочетание catalogGroupId, groupId и access должно быть уникальным. Поле id заполняется автоматически, если передать его в fields, метод вернет ошибку.

В ответе метода поле access приходит в другом формате: "1" для Y и пустая строка для N. Значение в формате Y или N возвращает метод catalog.priceTypeGroup.list прежней версии API.

Примеры кода

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

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

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"catalogGroupId":21,"groupId":2,"access":"Y"}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.pricetype.group.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"catalogGroupId":21,"groupId":2,"access":"Y"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.pricetype.group.add
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type PriceTypeGroupAddResult = {
  item: {
    id: number
    catalogGroupId: number
    groupId: number
    access: string
  }
}

try {
  const response = await $b24.actions.v3.call.make<PriceTypeGroupAddResult>({
    method: 'catalog.pricetype.group.add',
    params: {
      fields: {
        catalogGroupId: 21,
        groupId: 2,
        access: 'Y',
      },
    },
    requestId: Text.getUuidRfc4122()
  })

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

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.pricetype.group.add',
        params: {
          fields: {
            catalogGroupId: 21,
            groupId: 2,
            access: 'Y',
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

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

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

  document.addEventListener('DOMContentLoaded', addPriceTypeGroup)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.pricetype.group.add(
        fields={
            "catalogGroupId": 21,
            "groupId": 2,
            "access": "Y",
        },
    ).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.group.add',
            [
                'fields' => [
                    'catalogGroupId' => 21,
                    'groupId' => 2,
                    'access' => 'Y',
                ],
            ]
        );

    $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.group.add',
    {
        fields: {
            catalogGroupId: 21,
            groupId: 2,
            access: 'Y',
        },
    },
    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.group.add',
    [
        'fields' => [
            'catalogGroupId' => 21,
            'groupId' => 2,
            'access' => 'Y',
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.pricetype.group.add", b24.Params{
	"fields": b24.Params{
		"catalogGroupId": 21,
		"groupId":        2,
		"access":         "Y",
	},
})
if err != nil {
	return fmt.Errorf("catalog.pricetype.group.add: %w", err)
}

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

var item struct {
	ID             int    `json:"id"`
	CatalogGroupID int    `json:"catalogGroupId"`
	GroupID        int    `json:"groupId"`
	Access         string `json:"access"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.GroupID)

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

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 169,
            "catalogGroupId": 21,
            "groupId": 2,
            "access": "1"
        }
    },
    "time": {
        "start": 1792668012,
        "finish": 1792668012.406017,
        "duration": 0.4060170650482178,
        "processing": 0,
        "date_start": "2026-10-22T14:20:12+03:00",
        "date_finish": "2026-10-22T14:20:12+03:00",
        "operating_reset_at": 1792668600,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

Объект с данными ответа

result.item
object

Поля созданной привязки. Описание полей

time
time

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

Объект item

Название
тип

Описание

id
integer

Идентификатор привязки. Нужен для удаления привязки методом catalog.pricetype.group.delete

catalogGroupId
integer

Идентификатор типа цены

groupId
integer

Идентификатор группы пользователей

access
string

Тип доступа: "1" — покупка, Y в запросе; пустая строка — просмотр, N в запросе

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "The specified access type for this group already exists"
            }
        ]
    }
}

Название
тип

Описание

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_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

fields

Обязательное поле fields не указано

Передайте объект fields

catalogGroupId

В поле catalogGroupId требуется тип данных int для такого запроса

Передайте число

access

В поле access требуется тип данных string для такого запроса

Передайте строку Y или N

-

The specified price type does not exist

Проверьте идентификатор типа цены методом catalog.pricetype.list

-

The specified group does not exist

Передайте идентификатор существующей группы пользователей

-

Invalid access type provided. The available values are: Y, N

Передайте в access значение Y или N в верхнем регистре

-

The specified access type for this group already exists

Такая привязка уже есть. Привязки к группе 1 создаются вместе с типом цены

Если в запросе несколько ошибок, метод возвращает их все в массиве validation.

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

catalogGroupId

Не заполнено обязательное поле "catalogGroupId"

Передайте catalogGroupId в fields

groupId

Не заполнено обязательное поле "groupId"

Передайте groupId в fields

access

Не заполнено обязательное поле "access"

Передайте access в fields

id

Поле "id" не доступно к заполнению

Уберите id из fields

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

Описание ошибки

Как исправить

-

Неизвестное поле #FIELD# для сущности PriceTypeGroupDto

Передайте в fields только catalogGroupId, groupId, access

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

Код ошибки: 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

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

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