Update Product Price Collection catalog.price.modify
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: user with the "Modify product sale price" permission
The method catalog.price.modify updates the product price collection. It allows adding, updating, and deleting different product prices in a single request.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Object containing data for modifying prices (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
product* |
Product data and its prices (detailed description) |
Parameter product
Required parameters are marked with *
|
Name |
Description |
|
Product identifier, can be obtained using the methods catalog.product.list, catalog.product.offer.list, catalog.product.service.list, catalog.product.sku.list |
|
|
prices* |
Array of product prices (detailed description) |
Parameter prices
Required parameters are marked with *
|
Name |
Description |
|
Price identifier. If specified, the price will be updated. If not specified, a new price will be created. The price whose identifier was not provided will be deleted. Price identifiers can be obtained using the method catalog.price.list |
|
|
catalogGroupId* |
Identifier of the price type, 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":{"product":{"id":8,"prices":[{"catalogGroupId":1,"currency":"USD","price":2001},{"catalogGroupId":3,"currency":"USD","price":2001},{"catalogGroupId":5,"currency":"USD","price":2001,"id":122}]}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.price.modify
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"product":{"id":8,"prices":[{"catalogGroupId":1,"currency":"USD","price":2001},{"catalogGroupId":3,"currency":"USD","price":2001},{"catalogGroupId":5,"currency":"USD","price":2001,"id":122}]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.price.modify
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type ModifyPricesResult = {
prices: {
catalogGroupId: number
currency: string
extraId: string | null
id: number
price: number
priceScale: number
productId: number
quantityFrom: number | null
quantityTo: number | null
timestampX: ISODate | null
}[]
}
try {
const response = await $b24.actions.v2.call.make<ModifyPricesResult>({
method: 'catalog.price.modify',
params: {
fields: {
product: {
id: 8,
prices: [
{
catalogGroupId: 1,
currency: 'USD',
price: 2001,
},
{
catalogGroupId: 3,
currency: 'USD',
price: 2001,
},
{
catalogGroupId: 5,
currency: 'USD',
price: 2001,
id: 122,
},
],
},
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Modified prices:', result.prices)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function modifyPrices() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.price.modify',
params: {
fields: {
product: {
id: 8,
prices: [
{
catalogGroupId: 1,
currency: 'USD',
price: 2001,
},
{
catalogGroupId: 3,
currency: 'USD',
price: 2001,
},
{
catalogGroupId: 5,
currency: 'USD',
price: 2001,
id: 122,
},
],
},
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Modified prices:', result.prices)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', modifyPrices)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.price.modify(
fields={
"product": {
"id": 8,
"prices": [
{
"catalogGroupId": 1,
"currency": "USD",
"price": 2001,
},
{
"catalogGroupId": 3,
"currency": "USD",
"price": 2001,
},
{
"catalogGroupId": 5,
"currency": "USD",
"price": 2001,
"id": 122,
},
],
},
},
).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}")
try {
$response = $b24Service
->core
->call(
'catalog.price.modify',
[
'fields' => [
'product' => [
'id' => 8,
'prices' => [
[
'catalogGroupId' => 1,
'currency' => 'USD',
'price' => 2001
],
[
'catalogGroupId' => 3,
'currency' => 'USD',
'price' => 2001
],
[
'catalogGroupId' => 5,
'currency' => 'USD',
'price' => 2001,
'id' => 122
]
]
]
]
]
);
$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 modifying prices: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.price.modify',
{
fields: {
product: {
id: 8,
prices: [
{
catalogGroupId: 1,
currency: 'USD',
price: 2001
},
{
catalogGroupId: 3,
currency: 'USD',
price: 2001
},
{
catalogGroupId: 5,
currency: 'USD',
price: 2001,
id: 122
},
]
},
}
},
function(result)
{
if(result.error())
console.error(result.error().ex);
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.price.modify',
[
'fields' => [
'product' => [
'id' => 8,
'prices' => [
[
'catalogGroupId' => 1,
'currency' => 'USD',
'price' => 2001
],
[
'catalogGroupId' => 3,
'currency' => 'USD',
'price' => 2001
],
[
'catalogGroupId' => 5,
'currency' => 'USD',
'price' => 2001,
'id' => 122
],
]
],
]
]
);
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.modify", b24.Params{
"fields": b24.Params{
"product": b24.Params{
"id": 8,
"prices": []b24.Params{
{
"catalogGroupId": 1,
"currency": "EUR",
"price": 2001,
},
{
"catalogGroupId": 3,
"currency": "EUR",
"price": 2001,
},
{
"catalogGroupId": 5,
"currency": "EUR",
"price": 2001,
"id": 122,
},
},
},
},
})
if err != nil {
return fmt.Errorf("catalog.price.modify: %w", err)
}
// The method wraps the response in an object with the "prices" key.
raw, ok := b24.Unwrap(res.Result, "prices")
if !ok {
return fmt.Errorf("no prices key in the response")
}
var items []struct {
CatalogGroupID b24.ID `json:"catalogGroupId"`
Currency string `json:"currency"`
ID b24.ID `json:"id"`
Price int `json:"price"`
PriceScale int `json:"priceScale"`
ProductID b24.ID `json:"productId"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.CatalogGroupID)
}
Response Handling
HTTP Status: 200
{
"result": {
"prices": [
{
"catalogGroupId": 1,
"currency": "USD",
"extraId": null,
"id": 123,
"price": 2001,
"priceScale":2001,
"productId": 8,
"quantityFrom": null,
"quantityTo": null,
"timestampX": "2024-05-27T16:29:35+02:00"
},
{
"catalogGroupId": 3,
"currency": "USD",
"extraId": null,
"id": 124,
"price": 2001,
"priceScale":2001,
"productId": 8,
"quantityFrom": null,
"quantityTo": null,
"timestampX": "2024-05-27T16:29:35+02:00"
},
{
"catalogGroupId": 5,
"currency": "USD",
"extraId": null,
"id": 122,
"price": 2001,
"priceScale":2001,
"productId": 8,
"quantityFrom": null,
"quantityTo": null,
"timestampX": "2024-05-27T16:29:35+02:00"
}
]
},
"time": {
"start": 1712327086.69665,
"finish": 1712327086.95303,
"duration": 0.256376028060913,
"processing": 0.0112268924713135,
"date_start": "2024-05-27T16:29:35+02:00",
"date_finish": "2024-05-27T16:29:35+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
prices |
Array of objects containing product price information |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": 0,
"error_description": "Required fields: price, currency"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Access Denied |
Insufficient rights to edit price |
|
|
Access Denied |
Insufficient rights to edit product |
|
|
Could not find value for parameter |
Parameter |
|
|
Required fields: |
Required fields are not provided |
|
|
Validate price error. Catalog price group is wrong |
Incorrect price type |
|
|
Validate price error. Catalog product is allowed to have only a single price without ranges in the price group |
Duplicate price type. Two or more records with the same |
|
|
Other errors |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |