Update Product Price Collection catalog.price.modify
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
try {
const response = await $b24.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
},
]
},
}
}
);
const result = response.getData().result;
console.log('Modified prices:', result);
processResult(result);
} catch (error) {
console.error('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>';
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 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 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: 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 allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Add Product Price catalog.price.add
- 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