Обновить коллекцию цен товара catalog.price.modify

Scope: catalog

Кто может выполнять метод: пользователь с правом «Изменение цены продажи товара»

Метод catalog.price.modify изменяет коллекцию цен товара. Позволяет добавлять, обновлять и удалять разные цены товара за один запрос.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Объект с данными для модификации цен (подробное описание)

Параметр fields

Обязательные параметры отмечены *

Название
тип

Описание

product*
object

Данные товара и его цен (подробное описание)

Параметр product

Обязательные параметры отмечены *

Название
тип

Описание

id*
catalog_product.id

Идентификатор товара, можно получить методами catalog.product.list, catalog.product.offer.list, catalog.product.service.list, catalog.product.sku.list

prices*
array

Массив цен товара (подробное описание)

Параметр prices

Обязательные параметры отмечены *

Название
тип

Описание

id
catalog_price.id

Идентификатор цены. Если указан, то цена будет обновлена. Если не указан, то будет создана новая цена. Цена, идентификатор которой не был передан, будет удалена. Получить идентификаторы цен можно методом catalog.price.list

catalogGroupId*
catalog_price_type.id

Идентификатор типа цены, можно получить методом catalog.priceType.list

price*
double

Значение цены

currency*
string

Идентификатор валюты, можно получить методом crm.currency.list

Примеры кода

Как использовать примеры в документации

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,"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":"RUB","price":2001},{"catalogGroupId":3,"currency":"RUB","price":2001},{"catalogGroupId":5,"currency":"RUB","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: 'RUB',
                                    price: 2001
                                },
                                {
                                    catalogGroupId: 3,
                                    currency: 'RUB',
                                    price: 2001
                                },
                                {
                                    catalogGroupId: 5,
                                    currency: 'RUB',
                                    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' => 'RUB',
                                        'price' => 2001
                                    ],
                                    [
                                        'catalogGroupId' => 3,
                                        'currency' => 'RUB',
                                        'price' => 2001
                                    ],
                                    [
                                        'catalogGroupId' => 5,
                                        'currency' => 'RUB',
                                        '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: 'RUB',
                                price: 2001
                            },
                            {
                                catalogGroupId: 3,
                                currency: 'RUB',
                                price: 2001               
                            },
                            {
                                catalogGroupId: 5,
                                currency: 'RUB',
                                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' => 'RUB',
                                'price' => 2001
                            ],
                            [
                                'catalogGroupId' => 3,
                                'currency' => 'RUB',
                                'price' => 2001
                            ],
                            [
                                'catalogGroupId' => 5,
                                'currency' => 'RUB',
                                'price' => 2001,
                                'id' => 122
                            ],
                        ]
                    ],
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Обработка ответа

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
object

Корневой элемент ответа

prices
catalog_price[]

Массив объектов с информацией о ценах товара

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error": 0,
            "error_description": "Required fields: price, currency"
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

200040300020

Access Denied

Недостаточно прав на редактирование цены

200040300030

Access Denied

Недостаточно прав на редактирование товара

100

Could not find value for parameter

Не указан или пустой параметр fields

0

Required fields:

Не переданы обязательные поля

0

Validate price error. Catalog price group is wrong

Неправильный тип цены

0

Validate price error. Catalog product is allowed has only single price without ranges in price group

Дублирование типа цены. Были переданы в массиве prices две или более записей с одинаковым catalogGroupId

0

Другие ошибки

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение