Список версий МТ

Главная

api.tma

Промо акции и бонусы

Methods

api.tma.actionIdList(outletId, distributorIdList) → Result
api.tma.actionState(actionId, outletId, distributorId) → Result
api.tma.availableBonusSkuList(bonusId, outletId, distributorId) → Result
api.tma.availableBonusValue(bonusId, outletId, distributorId) → Result
api.tma.bonus(bonusId) → Result
api.tma.bonusIdList(mechanicsId) → Result
api.tma.calculateActions(actionIdList, outletId, distributorId) → Result
api.tma.condition(conditionId) → Result
api.tma.conditionIdList(mechanicsId) → Result
api.tma.confirmConditionAnswer(conditionId, outletId, distributorId, date) → Result
api.tma.isAnswerConfirmedByPhoto(conditionId, outletId) → Result
api.tma.mechanics(mechanicsId) → Result
api.tma.mechanicsIdList(actionId) → Result
api.tma.outletAgreementState(actionId, outletId, distributorId) → Result
api.tma.promoAction(actionId) → Result
api.tma.registerBonus(bonusId, outletId, distributorId, bonusData) → Result
api.tma.registerMechanicsTriggering(mechanicsId, outletId, distributorId) → Result
api.tma.setOutletAgreementState(actionId, outletId, distributorId, agreementState) → Result
api.tma.skuUsingByCondition(conditionId, bonusDocId) → Result
api.tma.unavailableSkuData(skuId, conditionId, baseDocId) → Result
api.tma.unregisterBonus(bonusId, outletId, distributorId, bonusData) → Result

Methods description

actionIdList(outletId, distributorIdList) → Result

Получить список идентификаторов акций, действующих в торговой точке для текущей позиции и данных дистрибьюторов

Parameters:
Name Type Description
outletId ID

Идентификатор торговой точки
distributorIdList IDList

Список идентификаторов дистрибьюторов
Return:
Result -

Результат выполнения операции.
В поле value - список идентификаторов акций (type IDList)

actionState(actionId, outletId, distributorId) → Result

Получить информацию о состоянии акции

Parameters:
Name Type Description
actionId ID

Идентификатор акции
outletId ID

Идентификатор торговой точки
distributorId ID

Идентификатор дистрибьютора
Return:
Result -

Результат выполнения операции.
В поле value - состояние акции (type ConditionState)

availableBonusSkuList(bonusId, outletId, distributorId) → Result

Получить информацию о бонусах, доступных для выдачи (или назначения скидки) в указанной ТТ

Parameters:
Name Type Description
bonusId ID

Идентификатор бонуса
outletId ID

Идентификатор торговой точки
distributorId ID

Идентификатор дистрибьютора
Return:
Result -

Результат выполнения операции.
В поле value - информация о доступных бонусах (type AvailableBonus)

availableBonusValue(bonusId, outletId, distributorId) → Result

Получить доступное значение бонуса в указанной ТТ

Parameters:
Name Type Description
bonusId ID

Идентификатор бонуса
outletId ID

Идентификатор торговой точки
distributorId ID

Идентификатор дистрибьютора
Return:
Result -

Результат выполнения операции.
В поле value - значение бонуса (type Number)

bonus(bonusId) → Result

Получить информацию о бонусе по его идентификатору

Parameters:
Name Type Description
bonusId ID

Идентификатор бонуса
Return:
Result -

Результат выполнения операции.
В поле value - информация о бонусе (type ActionBonus)

bonusIdList(mechanicsId) → Result

Получить список идентификаторов бонусов по идентификатору механики

Parameters:
Name Type Description
mechanicsId ID

Идентификатор механики
Return:
Result -

Результат выполнения операции.
В поле value - список идентификаторов бонусов (type IDList)

calculateActions(actionIdList, outletId, distributorId) → Result

Запустить расчет указанных акций. Возвращает результат расчёта только после того, как он закончен

Parameters:
Name Type Description
actionIdList IDList

Идентификаторы акций
outletId ID

Идентификатор торговой точки
distributorId ID

Идентификатор дистрибьютора
Return:
Result -

Результат выполнения операции.

condition(conditionId) → Result

Получить информацию об условии по идентификатору условия

Parameters:
Name Type Description
conditionId ID

Идентификатор условия
Return:
Result -

Результат выполнения операции.
Условие с товаром ConditionTypeSku В поле value - данные об условии (type ConditionSku) Условие с подтверждением ConditionTypeConfirm В поле value - данные об условии (type ConditionConfirm)

conditionIdList(mechanicsId) → Result

Получить список идентификаторов условий по идентификатору механики

Parameters:
Name Type Description
mechanicsId ID

Идентификатор механики
Return:
Result -

Результат выполнения операции.
В поле value - список идентификаторов условий (type IDList)

confirmConditionAnswer(conditionId, outletId, distributorId, date) → Result

Получить информацию о выполнении условия с подтверждением

Parameters:
Name Type Argument Description
conditionId ID

Идентификатор условия
outletId ID

Идентификатор торговой точки
distributorId ID

Идентификатор дистрибьютора
date Date optional 

Дата, на которую необходимо вернуть информацию
Return:
Result -

Результат выполнения операции.
В поле value - статус подтверждения (type ConfirmStatus)

isAnswerConfirmedByPhoto(conditionId, outletId) → Result

Получить признак подтверждения выполнения условия с фотографиями

Parameters:
Name Type Description
conditionId ID

Идентификатор условия
outletId ID

Идентификатор торговой точки
Return:
Result -

Результат выполнения операции.
В поле value - признак подтверждения с фотографиями (type Boolean)

mechanics(mechanicsId) → Result

Получить информацию о механике по ее идентификатору

Parameters:
Name Type Description
mechanicsId ID

Идентификатор механики
Return:
Result -

Результат выполнения операции.
В поле value - информация о механике (type ActionMechanics)

mechanicsIdList(actionId) → Result

Получить список идентификаторов механик по идентификатору акции

Parameters:
Name Type Description
actionId ID

Идентификатор акции
Return:
Result -

Результат выполнения операции.
В поле value - список идентификаторов механик (type IDList)

outletAgreementState(actionId, outletId, distributorId) → Result

Получить ответ торговой точки на предложение участия акции

Parameters:
Name Type Description
actionId ID

Идентификатор акции
outletId ID

Идентификатор торговой точки
distributorId ID

Идентификатор дистрибьютора
Return:
Result -

Результат выполнения операции.
В поле value - ответ TT (type AgreementState)

promoAction(actionId) → Result

Получить информацию об акции по ее идентификатору

Parameters:
Name Type Description
actionId ID

Идентификатор акции
Return:
Result -

Результат выполнения операции.
В поле value - информация об акции (type PromoAction)

registerBonus(bonusId, outletId, distributorId, bonusData) → Result

Зарегистрировать бонус (валидация документа "Бонус" при этом не производится!).

Parameters:
Name Type Description
bonusId ID

Идентификатор бонуса
outletId ID

Идентификатор торговой точки
distributorId ID

Идентификатор дистрибьютора
bonusData BonusList

Данные по бонусам
Return:
Result -

Результат выполнения операции.

registerMechanicsTriggering(mechanicsId, outletId, distributorId) → Result

Зарегистрировать механику акции

Parameters:
Name Type Description
mechanicsId ID

Идентификатор механики
outletId ID

Идентификатор торговой точки
distributorId ID

Идентификатор дистрибьютора
Return:
Result -

Результат выполнения операции.

setOutletAgreementState(actionId, outletId, distributorId, agreementState) → Result

Установить статус участия в акции для торговой точки

Parameters:
Name Type Description
actionId ID

Идентификатор акции
outletId ID

Идентификатор торговой точки
distributorId ID

Идентификатор дистрибьютора
agreementState AgreementState

Ответ торговой точки на предложение участия акции
Return:
Result -

Результат выполнения операции.

skuUsingByCondition(conditionId, bonusDocId) → Result

Получить информацию об использовании товаров

Parameters:
Name Type Description
conditionId ID

Идентификатор условия
bonusDocId ID

Идентификатор документа бонус акции
Return:
Result -

Результат выполнения операции.
В поле value - информация об использовании товаров (type UsedSkuDataList)

unavailableSkuData(skuId, conditionId, baseDocId) → Result

Получить информацию о недоступности товаров

Parameters:
Name Type Description
skuId ID

Идентификатор товара
conditionId ID

Идентификатор условия
baseDocId ID

Идентификатор документа-основания
Return:
Result -

Результат выполнения операции.
В поле value - информация о недоступности товаров (type UsedSkuDataList)

unregisterBonus(bonusId, outletId, distributorId, bonusData) → Result

Отменить регистрацию бонуса (валидация документа "Бонус" при этом не производится!).

Parameters:
Name Type Description
bonusId ID

Идентификатор бонуса
outletId ID

Идентификатор торговой точки
distributorId ID

Идентификатор дистрибьютора
bonusData BonusList

Данные по бонусам
Return:
Result -

Результат выполнения операции.