Добавить цену товара catalog.price.add

Scope: catalog

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

Метод catalog.price.add добавляет новую цену товара.

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

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

Название `тип`	Описание
fields* `object`	Значения полей для создания новой цены товара (подробное описание)

Параметр fields

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

Название `тип`	Описание
productId* `catalog_product.id`	Идентификатор товара, можно получить методами catalog.product.list, catalog.product.offer.list, catalog.product.service.list, catalog.product.sku.list
catalogGroupId* `catalog_price_type.id`	Идентификатор типа цены, можно получить методом catalog.priceType.list
price* `double`	Значение цены
currency* `string`	Идентификатор валюты, можно получить методом crm.currency.list

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"catalogGroupId":1,"currency":"RUB","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":"RUB","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: "RUB",
        				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'       => "RUB",
                            '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: "RUB",
                    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' => 'RUB',
                    'price' => 2000,
                    'productId' => 1
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 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
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `object`	Корневой элемент ответа
price `catalog_price`	Объект с информацией о созданной цене товара
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error": 200040300020,
            "error_description": "Access Denied"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание	Значение
`200040300020`	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	Цена с таким типом уже существует у товара

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

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

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

Обзор методов

Изменить цену

Добавить цену товара catalog.price.add

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

Параметр fieldsПараметр fields

Примеры кодаПримеры кода

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

Возвращаемые данныеВозвращаемые данные

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

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

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

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