Add Product Price v 3.0 catalog.price.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 "Edit selling price" access permission and permission to modify product prices in the catalog information block

This 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.price.add adds a product price and returns its fields.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Object with the fields of the new price. Field description

Parameter fields

Name `type`	Description
productId* `integer`	Identifier of the product or variation. The identifier can be retrieved using the catalog.product.list method. After the price is created, `productId` cannot be changed
catalogGroupId* `integer`	Price type identifier. The identifier can be retrieved using the catalog.pricetype.list method. After the price is created, `catalogGroupId` cannot be changed
price* `double`	Price. A negative value causes an error. If `extraId` is passed and the price type is not the base one, the price is recalculated from the product's base price taking the markup into account
currency* `string`	Currency code, for example `EUR`. No longer than three characters. Currency codes can be retrieved using the crm.currency.list method
extraId `integer`	Markup identifier. The identifier can be retrieved using the catalog.extra.list method. The markup is not applied to the base price type, and the value is reset to `0`. A non-existent identifier is also reset to `0` without an error
quantityFrom `integer`	Lower bound of the product quantity range in which the price applies. `0` — no lower bound. The ranges of all price types of a product must match the ranges of the base price
quantityTo `integer`	Upper bound of the product quantity range in which the price applies. `0` — no upper bound

Without quantity ranges, a product can have only one price of each type.

The id, priceScale, and timestampX 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.price.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":{"productId":7525,"catalogGroupId":1,"price":1500,"currency":"EUR"}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.price.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"productId":7525,"catalogGroupId":1,"price":1500,"currency":"EUR"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.price.add

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type PriceAddResult = {
          item: {
            id: number
            productId: number
            catalogGroupId: number
            price: number
            currency: string
            extraId: number
            quantityFrom: number
            quantityTo: number
            priceScale: number
            timestampX: ISODate
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<PriceAddResult>({
            method: 'catalog.price.add',
            params: {
              fields: {
                productId: 7525,
                catalogGroupId: 1,
                price: 1500,
                currency: 'EUR',
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Price 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 addPrice() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.price.add',
                params: {
                  fields: {
                    productId: 7525,
                    catalogGroupId: 1,
                    price: 1500,
                    currency: 'EUR',
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Price created:', result.item.id)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addPrice)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.price.add(
                fields={
                    "productId": 7525,
                    "catalogGroupId": 1,
                    "price": 1500,
                    "currency": "EUR",
                },
            ).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.price.add',
                    [
                        'fields' => [
                            'productId' => 7525,
                            'catalogGroupId' => 1,
                            'price' => 1500,
                            'currency' => 'EUR',
                        ],
                    ]
                );
        
            $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.price.add',
            {
                fields: {
                    productId: 7525,
                    catalogGroupId: 1,
                    price: 1500,
                    currency: 'EUR',
                },
            },
            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.price.add',
            [
                'fields' => [
                    'productId' => 7525,
                    'catalogGroupId' => 1,
                    'price' => 1500,
                    'currency' => 'EUR',
                ],
            ]
        );
        
        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.price.add", b24.Params{
        	"fields": b24.Params{
        		"productId":      7525,
        		"catalogGroupId": 1,
        		"price":          1500,
        		"currency":       "EUR",
        	},
        })
        if err != nil {
        	return fmt.Errorf("catalog.price.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"`
        	ProductID      int     `json:"productId"`
        	CatalogGroupID int     `json:"catalogGroupId"`
        	Price          float64 `json:"price"`
        	Currency       string  `json:"currency"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Price, item.Currency)

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 891,
                    "productId": 7525,
                    "catalogGroupId": 1,
                    "price": 1500,
                    "currency": "EUR",
                    "extraId": 0,
                    "quantityFrom": 0,
                    "quantityTo": 0,
                    "priceScale": 1500,
                    "timestampX": "2026-10-22T14:19:56+02:00"
                }
            },
            "time": {
                "start": 1792667996,
                "finish": 1792667996.347515,
                "duration": 0.3475151062011719,
                "processing": 0,
                "date_start": "2026-10-22T14:19:56+02:00",
                "date_finish": "2026-10-22T14:19:56+02:00",
                "operating_reset_at": 1792668540,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Object with the response data
result.item `object`	Fields of the created price. Field description
time `time`	Information about the request execution time

Item Object

Name `type`	Description
id `integer`	Price identifier
productId `integer`	Identifier of the product or variation
catalogGroupId `integer`	Price type identifier
price `double`	Price
currency `string`	Currency code
extraId `integer`	Markup identifier. `0` if no markup is set
quantityFrom `integer`	Lower bound of the quantity range. `0` if the bound is not set
quantityTo `integer`	Upper bound of the quantity range. `0` if the bound is not set
priceScale `double`	Price in the base currency. Calculated automatically
timestampX `datetime`	Date and time of the last price change

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "Validate price error. Catalog product is allowed has only single price without ranges in price group.",
                        "field": "catalogGroupId"
                    }
                ]
            }
        }

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
`price`	This request requires data type `float` in field `price`	Pass a number
`catalogGroupId`	Validate price error. Catalog price group is wrong	There is no price type with this identifier. Check the identifier using the catalog.pricetype.list method
`catalogGroupId`	Validate price error. Catalog product is allowed has only single price without ranges in price group.	The product already has a price of this type. Change it using the catalog.price.update method
`quantityFrom`	Validate price error. Ranges of base price are not equal to another price group range	Set the quantity ranges the same as for the product's base price
`quantityTo`	Invalid quantity range entry: no price is specified for quantity over `#QUANTITY#`	Add a price for the quantity above the upper bound or pass `quantityTo` equal to `0`
`BX_ERROR`	Invalid price	Pass a number of `0` or greater in `price`
`BX_ERROR`	Invalid currency	Pass the code of an existing currency

Object Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field	Error description	How to Fix
`productId`	Required field "productId" is empty	Pass `productId` in `fields`
`catalogGroupId`	Required field "catalogGroupId" is empty	Pass `catalogGroupId` in `fields`
`price`	Required field "price" is empty	Pass `price` in `fields`
`currency`	Required field "currency" is empty	Pass `currency` in `fields`
`currency`	String must not be longer than 3 characters	Pass a three-letter currency code
`#FIELD#`	Field "#FIELD#" is read-only	Remove the `id`, `priceScale`, and `timestampX` fields from `fields`

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field	Error description	How to Fix
`-`	Unknown field `#FIELD#` found in entity `PriceDto`	Pass in `fields` only the fields from the Parameter fields table

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

HTTP status: 403

Field	Error description	How to Fix
`-`	Access denied	Check the user's permissions to modify prices. The error is also returned if there is no product with the `productId` identifier

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

Was the article helpful?

Add price

Update price

Add Product Price v 3.0 catalog.price.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Item ObjectItem Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Object Validation ErrorsObject Validation Errors

Unknown Field ErrorUnknown Field Error

Access ErrorAccess Error

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

Parameter fields

Code Examples

Response Handling

Returned Data

Item Object

Error Handling

Possible Error Codes

Request Validation Errors

Object Validation Errors

Unknown Field Error

Access Error

Statuses and System Error Codes

Continue Learning