GetOptimalPrice

Описание и параметры

array
CCatalogProduct::GetOptimalPrice(
	int intProductID[,
	int|float quantity = 1[,
	array arUserGroups = array()[,
	string renewal = "N"[,
	array arPrices = array()[,
	bool|string siteID = false[,
	bool|array arDiscountCoupons = false]]]]]]
);

Метод возвращает параметры наименьшей цены товара productID с учетом скидок в количестве quantity для посетителя, входящего в группы пользователей arUserGroups. Метод статический.

Параметры вызова

Возвращаемые значения

Массив вида:

array(
	"PRICE" =>  массив параметров цены, из которой была получена минимальная. Ключ сохранен для обратной совместимости; для новых сценариев используйте RESULT_PRICE. Содержит ключи
		"ID" - ID ценового предложения,
		"CATALOG_GROUP_ID" - ID типа цены,
		"PRICE" - величина исходной цены,
		"CURRENCY" - валюта исходной цены,
		"ELEMENT_IBLOCK_ID" - ID инфоблока товара, которому принадлежит ценовое предложение,
		"VAT_INCLUDED" - включен ли НДС в цену (Y/N),
		"VAT_RATE" - величина ставки НДС в процентах,
	"DISCOUNT_PRICE" => минимальная цена в базовой_валюте,
	"DISCOUNT" => самая первая скидка из DISCOUNT_LIST. Устарел, не используется с версии 12.5.0,
	"DISCOUNT_LIST" => список скидок, примененных к товару. Инкрементный массив, скидки идут в порядке применения. Каждая запись описывает скидку, 
>array(
		"ID" => ID скидки
		"TYPE" => тип (накопительная или нет),
		"SITE_ID" => сайт,
		"ACTIVE" => активность,
		"ACTIVE_FROM", "ACTIVE_TO" => даты активности скидки,
		"RENEWAL" => применяется к товару или к продлению подписки,
		"NAME" =>название,
		"SORT" => сортировка,
		"MAX_DISCOUNT" => максимальная величина скидки в валюте,
		"VALUE_TYPE" => процентная, абсолютная скидка либо фиксированная цена,
		"VALUE" => величина скидки,
		"CURRENCY" => валюта скидки,
		"PRIORITY" => приоритет,
		"LAST_DISCOUNT" => прекратить или нет применения скидок,
		"COUPON" => купон (если есть),
		"COUPON_ONE_TIME" => тип купона,
		"COUPON_ACTIVE" => активность купона,
		"MODULE_ID" => модуль, к которому относится скидка
		"HANDLERS" => массив модулей, требуемых для условий скидки
	)
	"PRODUCT_ID" => ID товара,
	"RESULT_PRICE" => array(   
		"PRICE_TYPE_ID" => ID типа цены
		"BASE_PRICE" => исходная цена
		"DISCOUNT_PRICE" => цена со скидкой
		"CURRENCY" => валюта результата
		"DISCOUNT" => величина скидки
		"PERCENT" => процент скидки
		"VAT_RATE" => ставка НДС в виде доли (например, 0.2 для 20%)
		"VAT_INCLUDED" => включен ли НДС в цену (Y/N)
		"NO_VAT" => товар без НДС (Y/N)
		"UNROUND_BASE_PRICE" => базовая цена до округления
		"UNROUND_DISCOUNT_PRICE" => цена со скидкой до округления
		)
)

Особенности применения скидок и купонов

1. Метод рассчитывает минимальную цену товара для отображения в каталоге и не изменяет правила корзины или их состояние..
2. Если перед вызовом указан CCatalogProduct::setUseDiscount(false), то каталоговые скидки в расчете GetOptimalPrice не применяются.
3. Если setUseDiscount(false) не вызывался или задан true, скидки учитываются, а купоны берутся из параметра arDiscountCoupons.
4. При arDiscountCoupons = false купоны берутся из менеджера купонов.
5. Чтобы исключить купонные скидки из расчета GetOptimalPrice, передайте пустой массив купонов: array().
6. Расчет GetOptimalPrice выполняется в контексте каталога. Поэтому результат может отличаться от расчета скидок в корзине/заказе, особенно для правил, которые применяются именно на уровне корзины.

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

<?
$arPrice = CCatalogProduct::GetOptimalPrice($productID, $quantity, $USER->GetUserGroupArray(), $renewal);
if (!$arPrice || count($arPrice) <= 0)
{
	if ($nearestQuantity = CCatalogProduct::GetNearestQuantityPrice($productID, $quantity, $USER->GetUserGroupArray()))
	{
		$quantity = $nearestQuantity;
		$arPrice = CCatalogProduct::GetOptimalPrice($productID, $quantity, $USER->GetUserGroupArray(), $renewal);
	}
}
echo "<pre>";
print_r($arPrice);
echo "</pre>";
?>