Add Product Price catalog.price.add
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
catalogWho can execute the method: a user with the "Change product sale price" access permission
The method catalog.price.add adds a new price for a product.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Field values for creating a new product price (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
productId* |
Product identifier, can be obtained using the methods catalog.product.list, catalog.product.offer.list, catalog.product.service.list, catalog.product.sku.list |
|
catalogGroupId* |
Price type identifier, can be obtained using the method catalog.priceType.list |
|
price* |
Price value |
|
currency* |
Currency identifier, can be obtained using the method crm.currency.list |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"catalogGroupId":1,"currency":"USD","price":2000,"productId":1}}' \
https://**put_your_bitrix24_address**/rest/**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":{"catalogGroupId":1,"currency":"USD","price":2000,"productId":1},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.price.add
try
{
const response = await $b24.callMethod(
'catalog.price.add',
{
fields: {
catalogGroupId: 1,
currency: "USD",
price: 2000,
productId: 1
}
}
);
const result = response.getData().result;
console.log(result);
}
catch( error )
{
console.error(error.ex);
}
try {
$response = $b24Service
->core
->call(
'catalog.price.add',
[
'fields' => [
'catalogGroupId' => 1,
'currency' => "USD",
'price' => 2000,
'productId' => 1
]
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error()->ex);
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding price: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.price.add',
{
fields: {
catalogGroupId: 1,
currency: "USD",
price: 2000,
productId: 1
}
},
function(result) {
if (result.error())
console.error(result.error().ex);
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.price.add',
[
'fields' => [
'catalogGroupId' => 1,
'currency' => 'USD',
'price' => 2000,
'productId' => 1
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"price": {
"catalogGroupId": 1,
"currency": "USD",
"extraId": null,
"id": 3,
"price": 100.5,
"productId": 1,
"quantityFrom": null,
"quantityTo": null,
"timestampX": "2024-05-27T15:49:44+02:00"
}
},
"time": {
"start": 1716552521.40908,
"finish": 1716552521.69852,
"duration": 0.289434909820557,
"processing": 0.011207103729248,
"date_start": "2024-05-27T15:49:44+02:00",
"date_finish": "2024-05-27T15:49:44+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
price |
Object containing information about the created product price |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": 200040300020,
"error_description": "Access Denied"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Access Denied |
Insufficient permissions |
|
|
Could not find value for parameter |
Parameter |
|
|
Required fields: |
Required fields are not set |
|
|
Validate price error. Catalog price group is wrong |
Incorrect price type |
|
|
Validate price error. Catalog product is allowed has only single price without ranges in price group |
A price of this type already exists for the product |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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
- Update Product Price catalog.price.update
- Get Product Price by ID catalog.price.get
- Get a List of Prices by Filter catalog.price.list
- Delete Product Price catalog.price.delete
- Get Price Fields catalog.price.getFields
- Update Product Price Collection catalog.price.modify