Add Unit of Measurement v 3.0 catalog.measure.add

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: catalog

Who can execute the method: a user with permission to read the catalog or view warehouses and to modify measurement units

The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The catalog.measure.add method adds a unit of measurement and returns its data.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Object with the fields of the new unit of measurement. Field description

Parameter fields

Name
type

Description

code*
integer

Unit of measurement code. The value must be unique: if a unit with this code already exists, the method returns an error.

Codes of existing units can be retrieved using the catalog.measure.list method

measureTitle*
string

Name of the unit of measurement

symbol
string

Symbol

symbolIntl
string

International symbol

symbolLetterIntl
string

International letter code symbol

isDefault
boolean

Default unit of measurement flag. The default unit is selected automatically in a new product form.

Possible values:

  • true — default unit
  • false — regular unit

There can be only one default unit. If Bitrix24 already has one, the value true causes an error. To make a new unit the default one, first pass false for the current default unit using the catalog.measure.update method.

Default: false

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/catalog.measure.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"code":778,"measureTitle":"Package","symbol":"pkg","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":"Package","symbol":"pkg","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: 'Package',
                symbol: 'pkg',
                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: 'Package',
                    symbol: 'pkg',
                    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": "Package",
                    "symbol": "pkg",
                    "symbolIntl": "pack",
                    "symbolLetterIntl": "NMP",
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.measure.add',
                    [
                        'fields' => [
                            'code' => 778,
                            'measureTitle' => 'Package',
                            'symbol' => 'pkg',
                            '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();
        }
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

BX24.callMethod(
            'catalog.measure.add',
            {
                fields: {
                    code: 778,
                    measureTitle: 'Package',
                    symbol: 'pkg',
                    symbolIntl: 'pack',
                    symbolLetterIntl: 'NMP',
                },
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.measure.add',
            [
                'fields' => [
                    'code' => 778,
                    'measureTitle' => 'Package',
                    'symbol' => 'pkg',
                    'symbolIntl' => 'pack',
                    'symbolLetterIntl' => 'NMP',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "catalog.measure.add", b24.Params{
        	"fields": b24.Params{
        		"code":             778,
        		"measureTitle":     "Package",
        		"symbol":           "pkg",
        		"symbolIntl":       "pack",
        		"symbolLetterIntl": "NMP",
        	},
        })
        if err != nil {
        	return fmt.Errorf("catalog.measure.add: %w", err)
        }
        
        // The method wraps the response in an object with the "item" key.
        raw, ok := b24.Unwrap(res.Result, "item")
        if !ok {
        	return fmt.Errorf("the response has no item key")
        }
        
        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("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Code, item.MeasureTitle)
        

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 21,
                    "code": 778,
                    "measureTitle": "Package",
                    "symbol": "pkg",
                    "symbolIntl": "pack",
                    "symbolLetterIntl": "NMP",
                    "isDefault": false
                }
            },
            "time": {
                "start": 1792665552,
                "finish": 1792665552.76453,
                "duration": 0.7645299434661865,
                "processing": 0,
                "date_start": "2026-10-22T13:39:12+02:00",
                "date_finish": "2026-10-22T13:39:12+02:00",
                "operating_reset_at": 1792666140,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with the response data

result.item
object

The created unit of measurement. Field description

time
time

Information about the request execution time

Item Object

Name
type

Description

id
integer

Unit of measurement identifier

code
integer

Unit of measurement code

measureTitle
string

Name of the unit of measurement

symbol
string

Symbol. An empty string if the value is not set

symbolIntl
string

International symbol. An empty string if the value is not set

symbolLetterIntl
string

International letter code symbol. An empty string if the value is not set

isDefault
boolean

true — default unit of measurement, false — regular unit

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "Duplicate entry for key [code]"
                    }
                ]
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

fields

Required field fields is missing

Pass the fields object with the code and measureTitle fields

code

This request requires data type int in field code

Pass the code as a number

isDefault

This request requires data type bool in field isDefault

Pass true or false, not Y or N

-

Duplicate entry for key [code]

A unit with this code already exists. Specify a different code

-

default value can be set once [isDefault]

Bitrix24 already has a default unit. Pass false, or first clear the flag on the current unit using the catalog.measure.update method

Field Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field

Error description

How to Fix

code

Required field code is empty

Add code to fields

measureTitle

Required field measureTitle is empty

Add measureTitle to fields

id

Field id is read-only

Remove id from fields: the identifier is assigned automatically

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

fields

Unknown field #FIELD# found in entity MeasureDto

Pass only the fields from the fields parameter table in fields

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field

Error description

How to Fix

-

Access denied

The user does not have permission to read the catalog or view warehouses, or permission to modify measurement units

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

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

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning