База знаний
Войдите в личный кабинет для возможности задавать вопросы и отвечать на комментарии.
Полезная информация

Хелперы для интеграции плагина Цены PRO

Поддержка Bodysite
Поддержка Bodysite
20 декабря 2023 12:33
+1

На данной странице перечисленны хелперы, с помощью которых можно получать или перезаписывать цены, созданные плагином "Цены PRO". 

Основной класс-хелпер для работы с ценами: shopPricexIntegrationHelper.

Проверка на доступность плагина

shopPricexIntegrationHelper::isEnabled();

Описание: Возвращает включен ли плагин в настройках.

Возвращаемое значение: bool

Список статичных цен

shopPricexIntegrationHelper::getStaticPriceTypes();

Описание: возвращает список статичных типов цен в порядке указанном в настройках. Статичные - это те, что можно изменять, и они не расчитываются по формуле и не зависят от других цен.

Возвращаемое значение: shopPricexPriceType[] 

Поля:

  • id - ID типа цены
  • name - название
  • type - тип (static или dynamic)

Остальные поля носят служебный характер

Список всех новых цен (типов цен)

shopPricexIntegrationHelper::getPriceTypes();

Описание: возвращает список всех типов цен в порядке указанном в настройках.

Возвращаемое значение: shopPricexPriceType[] 

Поля:

  • id - ID типа цены
  • name - название
  • type - тип (static или dynamic)

Остальные поля носят служебный характер

Объект цены (типа цены) по id

shopPricexIntegrationHelper::getPriceType($id);

Описание: возвращает тип цены по его ID. Если тип цены не найден, возвращается null.

Параметры:

  • $id - ID цены (типа цены)

Возвращаемое значение: shopPricexPriceType|null

Поля:

  • id - ID
  • name - название
  • type - тип (static или dynamic)

Остальные поля носят служебный характер

Получить цену по id артикула

shopPricexIntegrationHelper::getPriceBySkuId($sku_id, $price_type);

Описание: возвращает значение типа цены для конкретного артикула по ID

Параметры:

  • $sku_id - ID артикула
  • shopPricexPriceType $price_type - объект цены (типа цены)

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

  • return['price'] - цена артикула в валюте товара
  • return['currency'] - валюта товара
  • return['input_currency'] - валюта, которая выбрана для данной цены
  • return['input_price'] - значение цены артикула, в выбранной валюте для этой цены
  • return['primary_price'] - цена артикула в основной валюте

Пример получения значения цены по ID артикула:

$price_type = shopPricexIntegrationHelper::getPriceType($price_type_id);
$price = shopPricexIntegrationHelper::getPriceBySkuId($sku_id, $price_type);

Получить цену артикула

shopPricexIntegrationHelper::getPrice($sku, $product_currency, $price_type);

Описание: возвращает значение типа цены для конкретного артикула

Параметры:

  • $sku - данные артикула
  • $product_currency - валюта товара (из базы данных)
  • shopPricexPriceType $price_type - тип цены

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

  • return['price'] - цена артикула в валюте товара
  • return['currency'] - валюта товара
  • return['input_currency'] - валюта, которая выбрана для данной цены
  • return['input_price'] - значение цены артикула, в выбранной валюте для этой цены
  • return['primary_price'] - цена артикула в основной валюте


Записать цену по Id артикула

shopPricexIntegrationHelper::updatePrice($sku_id, $price_type_id, $price, $currency);

Описание: обновляет значение типа цены для конкретного артикула

Обновлять цены можно только для статичных типов цен.

Параметры:

  • $sku_id - ID артикула
  • $price_type_id - ID типа цены
  • $price - новая цена в указанной валюте
  • $currency - валюта новой цены

Массово записать цены

shopPricexIntegrationHelper::updatePrices($prices);

Описание: массово обновляет значения типов цен

Обновлять цены можно только для статичных типов цен.

Формат:

  • $prices[]['sku_id'] - ID артикула
  • $prices[]['price_type_id'] - ID типа цены
  • $prices[]['price'] - новая цена в указанной валюте
  • $prices[]['currency'] - валюта новой цены

Параметры:

$prices - массив обновлений.