Create Price Rounding Rule v 3.0 catalog.roundingrule.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 the "Manage price types" permission

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 method catalog.roundingrule.add creates a price rounding rule for a price type and returns its fields.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Object with the fields of the new rounding rule. Field description

Parameter fields

Name
type

Description

catalogGroupId*
integer

Identifier of the price type the rule applies to. The price type must exist.

The identifier can be retrieved using the catalog.pricetype.list method

price*
double

Minimum price from which the rule applies. 0 — the rule applies to all prices of the type.

A negative value causes an error. A price type cannot have two rules with the same price

roundType*
integer

Rounding type.

Possible values:

  • 1 — mathematical rounding
  • 2 — rounding up, in favor of the store
  • 4 — rounding down, in favor of the customer

roundPrecision*
double

Rounding precision, for example, 10 — rounding to tens.

Possible values: 0.0001, 0.001, 0.005, 0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, 5000

The id, createdBy, dateCreate, modifiedBy, and dateModify fields are filled in automatically. If you pass them in fields, the method returns an error.

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.roundingrule.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"catalogGroupId":25,"price":1000,"roundType":2,"roundPrecision":10}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.roundingrule.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"catalogGroupId":25,"price":1000,"roundType":2,"roundPrecision":10},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.roundingrule.add
        
import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type RoundingRule = {
          id: number
          catalogGroupId: number
          price: number
          roundType: 1 | 2 | 4
          roundPrecision: number
          createdBy: number
          dateCreate: ISODate
          modifiedBy: number
          dateModify: ISODate
        }
        
        type RoundingRuleAddResult = {
          item: RoundingRule
        }
        
        try {
          const response = await $b24.actions.v3.call.make<RoundingRuleAddResult>({
            method: 'catalog.roundingrule.add',
            params: {
              fields: {
                catalogGroupId: 25,
                price: 1000,
                roundType: 2,
                roundPrecision: 10,
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Rounding rule 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 addRoundingRule() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.roundingrule.add',
                params: {
                  fields: {
                    catalogGroupId: 25,
                    price: 1000,
                    roundType: 2,
                    roundPrecision: 10,
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Rounding rule created:', result.item.id)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addRoundingRule)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.roundingrule.add(
                fields={
                    "catalogGroupId": 25,
                    "price": 1000,
                    "roundType": 2,
                    "roundPrecision": 10,
                },
            ).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.roundingrule.add',
                    [
                        'fields' => [
                            'catalogGroupId' => 25,
                            'price' => 1000,
                            'roundType' => 2,
                            'roundPrecision' => 10,
                        ],
                    ]
                );
        
            $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.roundingrule.add',
            {
                fields: {
                    catalogGroupId: 25,
                    price: 1000,
                    roundType: 2,
                    roundPrecision: 10,
                },
            },
            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.roundingrule.add',
            [
                'fields' => [
                    'catalogGroupId' => 25,
                    'price' => 1000,
                    'roundType' => 2,
                    'roundPrecision' => 10,
                ],
            ]
        );
        
        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.roundingrule.add", b24.Params{
        	"fields": b24.Params{
        		"catalogGroupId": 25,
        		"price":          1000,
        		"roundType":      2,
        		"roundPrecision": 10,
        	},
        })
        if err != nil {
        	return fmt.Errorf("catalog.roundingrule.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"`
        	CatalogGroupID int     `json:"catalogGroupId"`
        	Price          float64 `json:"price"`
        	RoundType      int     `json:"roundType"`
        	RoundPrecision float64 `json:"roundPrecision"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.RoundType, item.RoundPrecision)
        

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 3,
                    "catalogGroupId": 25,
                    "price": 1000,
                    "roundType": 2,
                    "roundPrecision": 10,
                    "createdBy": 1,
                    "dateCreate": "2026-10-22T14:20:16+02:00",
                    "modifiedBy": 1,
                    "dateModify": "2026-10-22T14:20:16+02:00"
                }
            },
            "time": {
                "start": 1792668016,
                "finish": 1792668016.576341,
                "duration": 0.576340913772583,
                "processing": 0,
                "date_start": "2026-10-22T14:20:16+02:00",
                "date_finish": "2026-10-22T14:20:16+02:00",
                "operating_reset_at": 1792668600,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with the response data

result.item
object

Fields of the created rounding rule. Field description

time
time

Information about the request execution time

Item Object

Name
type

Description

id
integer

Rounding rule identifier

catalogGroupId
integer

Identifier of the price type the rule applies to

price
double

Minimum price from which the rule applies. 0 — the rule applies to all prices of the type

roundType
integer

Rounding type: 1 — mathematical, 2 — up, 4 — down

roundPrecision
double

Rounding precision, for example, 10 — to tens

createdBy
integer

Identifier of the user who created the rule

dateCreate
datetime

Date and time the rule was created

modifiedBy
integer

Identifier of the user who last modified the rule

dateModify
datetime

Date and time the rule was last modified

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "A rounding rule with the same price threshold already exists for this price type",
                        "field": "price"
                    }
                ]
            }
        }
        

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

catalogGroupId

The specified price type does not exist

Pass the identifier of an existing price type. It can be retrieved using the catalog.pricetype.list method

catalogGroupId

This request requires data type int in field catalogGroupId

Pass an integer

price

The rounding rule price threshold cannot be negative

Pass a number of 0 or greater in price

price

A rounding rule with the same price threshold already exists for this price type

Change price or update the existing rule using the catalog.roundingrule.update method

roundType

Invalid rounding type provided. The available values are: 1, 2, 4

Pass 1, 2, or 4

roundPrecision

Invalid rounding precision provided. The available values are: 0.0001, 0.001, 0.005, 0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, 5000

Pass one of the values from the list

Object Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field

Error description

How to Fix

#FIELD#

Required field "#FIELD#" is empty

Pass the catalogGroupId, price, roundType, and roundPrecision fields in fields

#FIELD#

Field "#FIELD#" is read-only

Remove the read-only fields from fields: id, createdBy, dateCreate, modifiedBy, dateModify

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

-

Unknown field #FIELD# found in entity RoundingRuleDto

Pass only catalogGroupId, price, roundType, roundPrecision in fields

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field

Error description

How to Fix

-

Access denied

Make sure the user has the "Manage price types" permission

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