api.tma

Methods

api.tma.actionIdList(outletId, distributorIdList) → Result

api.tma.actionState(actionId, outletId, distributorId) → Result

api.tma.bonus(bonusId) → Result

api.tma.bonusIdList(mechanicsId) → 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.promoAction(actionId) → Result

api.tma.skuUsingByCondition(conditionId, bonusDocId) → Result

api.tma.unavailableSkuData(skuId, conditionId, baseDocId) → Result

Methods description

actionIdList(outletId, distributorIdList) → Result

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

Parameters:

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

Return:

Result -

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

actionState(actionId, outletId, distributorId) → Result

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

Parameters:

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

Return:

Result -

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

bonus(bonusId) → Result

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

Parameters:

Name	Type	Description
bonusId	ID	Идентификатор бонуса

Return:

Result -

Результат выполнения операции. В поле value структура ActionBonus

bonusIdList(mechanicsId) → Result

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

Parameters:

Name	Type	Description
mechanicsId	ID	Идентификатор механики

Return:

Result -

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

conditionIdList(mechanicsId) → Result

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

Parameters:

Name	Type	Description
mechanicsId	ID	Идентификатор механики

Return:

Result -

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

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

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

Parameters:

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

Return:

Result -

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

isAnswerConfirmedByPhoto(conditionId, outletId) → Result

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

Parameters:

Name	Type	Description
conditionId	ID	Идентификатор условия
outletId	ID	Идентификатор торговой точки

Return:

Result -

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

mechanics(mechanicsId) → Result

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

Parameters:

Name	Type	Description
mechanicsId	ID	Идентификатор механики

Return:

Result -

Результат выполнения операции. В поле value структура ActionMechanics

mechanicsIdList(actionId) → Result

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

Parameters:

Name	Type	Description
actionId	ID	Идентификатор акции

Return:

Result -

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

promoAction(actionId) → Result

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

Parameters:

Name	Type	Description
actionId	ID	Идентификатор акции

Return:

Result -

Результат выполнения операции. В поле value структура PromoAction

skuUsingByCondition(conditionId, bonusDocId) → Result

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

Parameters:

Name	Type	Description
conditionId	ID	Идентификатор условия
bonusDocId	ID	Идентификатор документа бонус акции

Return:

Result -

Результат выполнения операции. В поле value список структур UsedSkuData

unavailableSkuData(skuId, conditionId, baseDocId) → Result

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

Parameters:

Name	Type	Description
skuId	ID	Идентификатор товара
conditionId	ID	Идентификатор условия
baseDocId	ID	Идентификатор документа-основания

Return:

Result -

Результат выполнения операции. В поле value список структур UsedSkuData