Обновить коллекцию цен товара catalog.price.modify
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: пользователь с правом «Изменение цены продажи товара» и правом изменять цены товара в инфоблоке каталога
Метод catalog.price.modify изменяет коллекцию цен товара. Позволяет добавлять, обновлять и удалять разные цены товара за один запрос.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Объект с данными для модификации цен (подробное описание) |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
product* |
Данные товара и его цен (подробное описание) |
Параметр product
Обязательные параметры отмечены *
|
Название |
Описание |
|
Идентификатор товара, можно получить методами catalog.product.list, catalog.product.offer.list, catalog.product.service.list, catalog.product.sku.list |
|
|
prices* |
Массив цен товара (подробное описание) |
Параметр prices
Обязательные параметры отмечены *
|
Название |
Описание |
|
Идентификатор цены. Если указан, то цена будет обновлена. Если не указан, то будет создана новая цена. Цена, идентификатор которой не был передан, будет удалена. Получить идентификаторы цен можно методом catalog.price.list. Сейчас передача |
|
|
catalogGroupId* |
Идентификатор типа цены, можно получить методом catalog.priceType.list |
|
price* |
Значение цены |
|
currency* |
Идентификатор валюты, можно получить методом crm.currency.list |
Сейчас метод не обновляет существующие цены. Если передать в prices цену с id, метод вернет ошибку Validate price error. Catalog price group is wrong, и цены товара не изменятся.
Передавайте все цены товара без id. Метод удалит текущие цены товара и создаст новые с переданными значениями, поэтому идентификаторы цен изменятся. Чтобы изменить одну цену и сохранить ее идентификатор, используйте метод catalog.price.update.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"product":{"id":8,"prices":[{"catalogGroupId":1,"currency":"RUB","price":2001},{"catalogGroupId":3,"currency":"RUB","price":2001},{"catalogGroupId":5,"currency":"RUB","price":2001}]}}}' \
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":"RUB","price":2001},{"catalogGroupId":3,"currency":"RUB","price":2001},{"catalogGroupId":5,"currency":"RUB","price":2001}]},"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: 'RUB',
price: 2001,
},
{
catalogGroupId: 3,
currency: 'RUB',
price: 2001,
},
{
catalogGroupId: 5,
currency: 'RUB',
price: 2001,
},
],
},
},
},
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: 'RUB',
price: 2001,
},
{
catalogGroupId: 3,
currency: 'RUB',
price: 2001,
},
{
catalogGroupId: 5,
currency: 'RUB',
price: 2001,
},
],
},
},
},
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": "RUB",
"price": 2001,
},
{
"catalogGroupId": 3,
"currency": "RUB",
"price": 2001,
},
{
"catalogGroupId": 5,
"currency": "RUB",
"price": 2001,
},
],
},
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'catalog.price.modify',
[
'fields' => [
'product' => [
'id' => 8,
'prices' => [
[
'catalogGroupId' => 1,
'currency' => 'RUB',
'price' => 2001
],
[
'catalogGroupId' => 3,
'currency' => 'RUB',
'price' => 2001
],
[
'catalogGroupId' => 5,
'currency' => 'RUB',
'price' => 2001,
]
]
]
]
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'catalog.price.modify',
{
fields: {
product: {
id: 8,
prices: [
{
catalogGroupId: 1,
currency: 'RUB',
price: 2001
},
{
catalogGroupId: 3,
currency: 'RUB',
price: 2001
},
{
catalogGroupId: 5,
currency: 'RUB',
price: 2001,
},
]
},
}
},
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' => 'RUB',
'price' => 2001
],
[
'catalogGroupId' => 3,
'currency' => 'RUB',
'price' => 2001
],
[
'catalogGroupId' => 5,
'currency' => 'RUB',
'price' => 2001,
],
]
],
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
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": "RUB",
"price": 2001,
},
{
"catalogGroupId": 3,
"currency": "RUB",
"price": 2001,
},
{
"catalogGroupId": 5,
"currency": "RUB",
"price": 2001,
},
},
},
},
})
if err != nil {
return fmt.Errorf("catalog.price.modify: %w", err)
}
// Метод заворачивает ответ в объект с ключом "prices".
raw, ok := b24.Unwrap(res.Result, "prices")
if !ok {
return fmt.Errorf("в ответе нет ключа prices")
}
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("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.CatalogGroupID)
}
Обработка ответа
HTTP-статус: 200
{
"result": {
"prices": [
{
"catalogGroupId": 1,
"currency": "RUB",
"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": "RUB",
"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": "RUB",
"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
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
result.prices |
Массив объектов с информацией о ценах товара |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Product prices are empty"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Access Denied |
Нет права «Изменение цены продажи товара» |
|
|
|
Access Denied |
Нет права изменять цены этого товара в инфоблоке каталога или товара с указанным |
|
|
|
Could not find value for parameter |
Не передан обязательный параметр |
|
|
|
Required fields: [product][id], [product][prices][] |
В |
|
|
|
Product prices are empty |
В |
|
|
|
Validate price error. Catalog price group is wrong |
Типа цены с указанным |
|
|
|
Validate price error. Catalog product is allowed has only single price without ranges in price group. |
В |
|
|
|
Validate price error. Ranges of base price are not equal to another price group range |
Переданы |
|
|
|
Неверная цена |
В |
|
|
|
Неверная валюта |
Валюты с кодом из |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |