Добавить единицу измерения v 3.0 catalog.measure.add

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

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

Scope: catalog

Кто может выполнять метод: пользователь с правом чтения каталога или просмотра складов и правом изменения единиц измерения

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

Метод catalog.measure.add добавляет единицу измерения и возвращает ее данные.

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

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

Название
тип

Описание

fields*
object

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

Параметр fields

Название
тип

Описание

code*
integer

Код единицы измерения. Значение должно быть уникальным: если единица с таким кодом уже есть, метод вернет ошибку.

Коды существующих единиц можно получить методом catalog.measure.list

measureTitle*
string

Название единицы измерения

symbol
string

Условное обозначение

symbolIntl
string

Международное условное обозначение

symbolLetterIntl
string

Международное кодовое буквенное обозначение

isDefault
boolean

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

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

  • true — единица по умолчанию
  • false — обычная единица

Единица по умолчанию может быть только одна. Если в Битрикс24 она уже есть, значение true вызовет ошибку. Чтобы назначить новую единицу по умолчанию, сначала передайте false текущей единице методом catalog.measure.update.

По умолчанию: false

Примеры кода

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

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

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"code":778,"measureTitle":"Упаковка","symbol":"упак","symbolIntl":"pack","symbolLetterIntl":"NMP"}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.measure.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"code":778,"measureTitle":"Упаковка","symbol":"упак","symbolIntl":"pack","symbolLetterIntl":"NMP"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.measure.add
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type MeasureAddResult = {
  item: {
    id: number
    code: number
    measureTitle: string
    symbol: string
    symbolIntl: string
    symbolLetterIntl: string
    isDefault: boolean
  }
}

try {
  const response = await $b24.actions.v3.call.make<MeasureAddResult>({
    method: 'catalog.measure.add',
    params: {
      fields: {
        code: 778,
        measureTitle: 'Упаковка',
        symbol: 'упак',
        symbolIntl: 'pack',
        symbolLetterIntl: 'NMP',
      },
    },
    requestId: Text.getUuidRfc4122()
  })

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

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.measure.add',
        params: {
          fields: {
            code: 778,
            measureTitle: 'Упаковка',
            symbol: 'упак',
            symbolIntl: 'pack',
            symbolLetterIntl: 'NMP',
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

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

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

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

try:
    bitrix_response = client.catalog.measure.add(
        fields={
            "code": 778,
            "measureTitle": "Упаковка",
            "symbol": "упак",
            "symbolIntl": "pack",
            "symbolLetterIntl": "NMP",
        },
    ).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.measure.add',
            [
                'fields' => [
                    'code' => 778,
                    'measureTitle' => 'Упаковка',
                    'symbol' => 'упак',
                    'symbolIntl' => 'pack',
                    'symbolLetterIntl' => 'NMP',
                ],
            ]
        );

    $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.measure.add',
    {
        fields: {
            code: 778,
            measureTitle: 'Упаковка',
            symbol: 'упак',
            symbolIntl: 'pack',
            symbolLetterIntl: 'NMP',
        },
    },
    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.measure.add',
    [
        'fields' => [
            'code' => 778,
            'measureTitle' => 'Упаковка',
            'symbol' => 'упак',
            'symbolIntl' => 'pack',
            'symbolLetterIntl' => 'NMP',
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.measure.add", b24.Params{
	"fields": b24.Params{
		"code":             778,
		"measureTitle":     "Упаковка",
		"symbol":           "упак",
		"symbolIntl":       "pack",
		"symbolLetterIntl": "NMP",
	},
})
if err != nil {
	return fmt.Errorf("catalog.measure.add: %w", err)
}

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

var item struct {
	ID           int    `json:"id"`
	Code         int    `json:"code"`
	MeasureTitle string `json:"measureTitle"`
	IsDefault    bool   `json:"isDefault"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Code, item.MeasureTitle)

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

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 21,
            "code": 778,
            "measureTitle": "Упаковка",
            "symbol": "упак",
            "symbolIntl": "pack",
            "symbolLetterIntl": "NMP",
            "isDefault": false
        }
    },
    "time": {
        "start": 1792665552,
        "finish": 1792665552.76453,
        "duration": 0.7645299434661865,
        "processing": 0,
        "date_start": "2026-10-22T13:39:12+03:00",
        "date_finish": "2026-10-22T13:39:12+03:00",
        "operating_reset_at": 1792666140,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

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

result.item
object

Созданная единица измерения. Описание полей

time
time

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

Объект item

Название
тип

Описание

id
integer

Идентификатор единицы измерения

code
integer

Код единицы измерения

measureTitle
string

Название единицы измерения

symbol
string

Условное обозначение. Пустая строка, если значение не задано

symbolIntl
string

Международное условное обозначение. Пустая строка, если значение не задано

symbolLetterIntl
string

Международное кодовое буквенное обозначение. Пустая строка, если значение не задано

isDefault
boolean

true — единица измерения по умолчанию, false — обычная единица

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Duplicate entry for key [code]"
            }
        ]
    }
}

Название
тип

Описание

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 с полями code и measureTitle

code

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

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

isDefault

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

Передайте true или false, а не Y или N

-

Duplicate entry for key [code]

Единица с таким кодом уже есть. Укажите другой code

-

default value can be set once [isDefault]

В Битрикс24 уже есть единица по умолчанию. Передайте false или сначала снимите признак с текущей единицы методом catalog.measure.update

Ошибки валидации полей

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Поле

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

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

code

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

Добавьте code в fields

measureTitle

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

Добавьте measureTitle в fields

id

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

Уберите id из fields: идентификатор назначается автоматически

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

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

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

fields

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

Передайте в fields только поля из таблицы параметра fields

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

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

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

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