api.tma

Подробное описание

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

api.tma

Открытые члены
	actionIdList (outletId, distributorIdList)
	Получить список идентификаторов акций, действующих в торговой точке для текущей позиции и данных дистрибьюторов Подробнее...
	actionState (actionId, outletId, distributorId)
	Получить информацию о состоянии акции Подробнее...
	availableBonusSkuList (bonusId, outletId, distributorId)
	Получить информацию о бонусах, доступных для выдачи (или назначения скидки) в указанной торговой точке Подробнее...
	availableBonusValue (bonusId, outletId, distributorId)
	Получить доступное значение бонуса в указанной торговой точке Подробнее...
	bonus (bonusId)
	Получить информацию о бонусе по его идентификатору Подробнее...
	bonusIdList (mechanicsId)
	Получить список идентификаторов бонусов по идентификатору механики Подробнее...
	calculateActions (actionIdList, outletId, distributorId)
	Запустить расчет указанных акций. Возвращает результат расчета только после того, как он закончен Подробнее...
	condition (conditionId)
	Получить информацию об условии по идентификатору условия Подробнее...
	conditionIdList (mechanicsId)
	Получить список идентификаторов условий по идентификатору механики Подробнее...
	confirmConditionAnswer (conditionId, outletId, distributorId, date)
	Получить информацию о выполнении условия с подтверждением Подробнее...
	isAnswerConfirmedByPhoto (conditionId, outletId)
	Получить признак подтверждения выполнения условия с фотографиями Подробнее...
	mechanics (mechanicsId)
	Получить информацию о механике по ее идентификатору Подробнее...
	mechanicsIdList (actionId)
	Получить список идентификаторов механик по идентификатору акции Подробнее...
	outletAgreementState (actionId, outletId, distributorId)
	Получить ответ торговой точки на предложение участия акции Подробнее...
	promoAction (actionId)
	Получить информацию об акции по ее идентификатору Подробнее...
	registerBonus (bonusId, outletId, distributorId, bonusDataList)
	Зарегистрировать бонус (валидация документа "Бонус" при этом не производится!) Подробнее...
	registerMechanicsTriggering (mechanicsId, outletId, distributorId)
	Зарегистрировать механику акции Подробнее...
	setOutletAgreementState (actionId, outletId, distributorId, agreementState)
	Установить статус участия в акции для торговой точки Подробнее...
	skuUsingByCondition (conditionId, bonusDocId)
	Получить информацию об использовании товаров Подробнее...
	unavailableSkuData (skuId, baseDocId, conditionId, considerCurrentCondition)
	Получить информацию о недоступности товаров Подробнее...
	unregisterBonus (bonusId, outletId, distributorId, bonusDataList)
	Отменить регистрацию бонуса (валидация документа "Бонус" при этом не производится!) Подробнее...

Методы

actionIdList (outletId, distributorIdList)

actionIdList	(	outletId	,
		distributorIdList
	)

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

Аргументы

outletId	[ID] - Идентификатор торговой точки
distributorIdList	[IDList] - Список идентификаторов дистрибьюторов

Возвращает

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

actionState (actionId, outletId, distributorId)

struct ConditionState * actionState	(	actionId	,
		outletId	,
		distributorId
	)

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

Аргументы

actionId	[ID] - Идентификатор акции
outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] - Идентификатор дистрибьютора

Возвращает

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

availableBonusSkuList (bonusId, outletId, distributorId)

* availableBonusSkuList	(	bonusId	,
		outletId	,
		distributorId
	)

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

Аргументы

bonusId	[ID] - Идентификатор бонуса
outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] - Идентификатор дистрибьютора

Возвращает

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

availableBonusValue (bonusId, outletId, distributorId)

availableBonusValue	(	bonusId	,
		outletId	,
		distributorId
	)

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

Аргументы

bonusId	[ID] - Идентификатор бонуса
outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] - Идентификатор дистрибьютора

Возвращает

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

bonus (bonusId)

* bonus

(

bonusId

)

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

Аргументы

bonusId

[ID] - Идентификатор бонуса

Возвращает

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

bonusIdList (mechanicsId)

bonusIdList

(

mechanicsId

)

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

Аргументы

mechanicsId

[ID] - Идентификатор механики

Возвращает

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

calculateActions (actionIdList, outletId, distributorId)

calculateActions	(	actionIdList	,
		outletId	,
		distributorId
	)

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

Аргументы

actionIdList	[IDList] - Список идентификаторов акций
outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] - Идентификатор дистрибьютора

Возвращает

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

condition (conditionId)

* condition

(

conditionId

)

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

Аргументы

conditionId

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

Возвращает

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

conditionIdList (mechanicsId)

conditionIdList

(

mechanicsId

)

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

Аргументы

mechanicsId

[ID] - Идентификатор механики

Возвращает

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

confirmConditionAnswer (conditionId, outletId, distributorId, date)

struct ConfirmStatus * confirmConditionAnswer	(	conditionId	,
		outletId	,
		distributorId	,
		date
	)

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

Аргументы

conditionId	[ID] - Идентификатор условия
outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] - Идентификатор дистрибьютора
date	[Date] - Дата, на которую необходимо вернуть информацию

Возвращает

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

isAnswerConfirmedByPhoto (conditionId, outletId)

isAnswerConfirmedByPhoto	(	conditionId	,
		outletId
	)

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

Уст.:

(2021-03-22) Необходимо использовать #api.tma.isAnswerConfirmedByPhoto(conditionId, outletId, start, end)

Аргументы

conditionId	[ID] - Идентификатор условия
outletId	[ID] - Идентификатор торговой точки

Возвращает

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

mechanics (mechanicsId)

* mechanics

(

mechanicsId

)

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

Аргументы

mechanicsId

[ID] - Идентификатор механики

Возвращает

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

mechanicsIdList (actionId)

mechanicsIdList

(

actionId

)

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

Аргументы

actionId

[ID] - Идентификатор акции

Возвращает

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

outletAgreementState (actionId, outletId, distributorId)

struct AgreementState * outletAgreementState	(	actionId	,
		outletId	,
		distributorId
	)

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

Аргументы

actionId	[ID] - Идентификатор акции
outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] - Идентификатор дистрибьютора

Возвращает

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

promoAction (actionId)

* promoAction

(

actionId

)

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

Аргументы

actionId

[ID] - Идентификатор акции

Возвращает

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

registerBonus (bonusId, outletId, distributorId, bonusDataList)

* registerBonus	(	bonusId	,
		outletId	,
		distributorId	,
		bonusDataList
	)

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

Аргументы

bonusId	[ID] - Идентификатор бонуса
outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] - Идентификатор дистрибьютора
bonusDataList	[Bonus[]] - Данные по бонусам

Возвращает

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

registerMechanicsTriggering (mechanicsId, outletId, distributorId)

registerMechanicsTriggering	(	mechanicsId	,
		outletId	,
		distributorId
	)

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

Аргументы

mechanicsId	[ID] - Идентификатор механики
outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] - Идентификатор дистрибьютора

Возвращает

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

setOutletAgreementState (actionId, outletId, distributorId, agreementState)

setOutletAgreementState	(	actionId	,
		outletId	,
		distributorId	,
		agreementState
	)

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

Аргументы

actionId	[ID] - Идентификатор акции
outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] - Идентификатор дистрибьютора
agreementState	[AgreementState] - Ответ торговой точки на предложение участия акции

Возвращает

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

skuUsingByCondition (conditionId, bonusDocId)

* skuUsingByCondition	(	conditionId	,
		bonusDocId
	)

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

Аргументы

conditionId	[ID] - Идентификатор условия
bonusDocId	[ID] - Идентификатор документа бонус акции

Возвращает

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

unavailableSkuData (skuId, baseDocId, conditionId, considerCurrentCondition)

unavailableSkuData	(	skuId	,
		baseDocId	,
		conditionId	,
		considerCurrentCondition
	)

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

Аргументы

skuId	[ID] - Идентификатор товара
baseDocId	[ID] - Идентификатор документа-основания
conditionId	[ID] - Идентификатор условия
considerCurrentCondition	[Boolean] optional - Рассматривать ли текущее условие (по умолчанию true)

Возвращает

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

unregisterBonus (bonusId, outletId, distributorId, bonusDataList)

unregisterBonus	(	bonusId	,
		outletId	,
		distributorId	,
		bonusDataList
	)

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

Аргументы

bonusId	[ID] - Идентификатор бонуса
outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] - Идентификатор дистрибьютора
bonusDataList	[Bonus[]] - Данные по бонусам

Возвращает

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