Документация для разработчиков

DiscountCouponsManager

DiscountCouponsManager - класс для работы с купонами при расчетах.

Методы класса

МетодОписание С версии
addМетод добавляет купон, чтобы учесть его в расчетах. 14.11.0
clearМетод убирает введенные купоны на текущем хите. 14.11.0
clearApplyМетод убирает примененные данные купонов. 15.5.1
clearApplyCouponМетод убирает примененные данные купона. 15.5.1
clearByOrderМетод убирает введенные купоны в заказе. 15.5.1
clearErrorsМетод очищает список ошибок. 14.11.0
deleteМетод удаляет купон из проводимых расчетов. 14.11.0
deleteApplyByProductМетод убирает примененную информацию для товара. 14.11.0
finalApplyМетод изменяет статус сохраняемых купонов. 14.11.0
getМетод возвращает список купонов. 14.11.0
getCheckCodeListМетод возвращает список кодов состояния купона. 14.11.0
getDataМетод возвращает информацию по купону. 14.11.0
getEnteredCouponЕсли купон еще не добавлен, то метод выполнит попытку его добавления и, в случае успеха, вернет данные купона. 14.11.9
getErrorsМетод возвращает список ошибок. 14.11.0
getForApplyМетод возвращает с учетом фильтра список купонов для применения. 14.11.0
getOrderIdВ случае работы с купонами сохраненного заказа (сохраненного) метод вернет идентификатор этого заказа. 14.11.0
getStatusListМетод возвращает список статусов купона. 14.11.0
getUseModeМетод возвращает режим работы с купонами. 14.11.0
getUserIdМетод возвращает идентификатор пользователя. 14.11.0
initМетод инициализирует менеджер купонов. 14.11.0
initUseModeМетод устанавливает режим работы с купонами и идентификатор пользователя. 14.11.0
isEnteredЕсли купон вводили, то метод возвращает true, в противном случае - false. 14.11.0
isExistЕсли купон с кодом $coupon существует, то метод возвращает массив параметров купона. 14.11.0
isSuccessМетод возвращает true, если проводимая операция выполнена успешно. 14.11.0
loadМетод загружает купоны для существующего заказа. 14.11.0
logoutМетод очищает хранилище купонов при выходе из авторизованного сеанса в публичном разделе сайта. 14.11.9
migrateStorageМетод изменяет идентификатор хранилища после смены клиента в заказе в административной части. 14.11.0
reInitМетод реинициализирует менеджер купонов. 14.11.9
saveAppliedМетод сохраняет примененные купоны. 14.11.0
setApplyМетод сохраняет в памяти информацию о том, к чему применился купон на хите. 14.11.0
setApplyByProductМетод сохраняет в памяти информацию о применении купонов к товару. 14.11.0
usedByClientМетод возвращает true, если менеджер купонов запущен из публичного раздела сайта. 14.11.0
usedByExternalМетод возвращает true, если заказ был оформлен во внешней торговой платформе. 14.11.9
usedByManagerМетод возвращает true, если работа с купонами ведется из административного раздела сайта. 14.11.0


Пользовательские комментарии

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

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2019, «1С-Битрикс», 2019
Наверх