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

Главная

api.visits

Визиты

Methods

api.visits.addToRoute(outletId, date) → Result
api.visits.canFinish(outletId) → Result
api.visits.canStart(outletId) → Result
api.visits.currentVisit(routeId) → Visit
api.visits.dateOfLastVisit(idOutlet, days) → Date
api.visits.dateOfLastVisitOrOrder(idOutlet, days) → String
api.visits.factVisitDaysByOutlet(outletId, routeId, dayLimit) → DateList
api.visits.finish(outletId, reasonId) → Result
api.visits.isFinished(outletId, date, routeId) → Boolean
api.visits.isStarted(outletId, routeId) → Boolean
api.visits.nextExpectedOutletVisitId(outletId, routeId) → ID
api.visits.nextExpectedRouteVisitId(routeId) → ID
api.visits.reasonModel() → Array.<Object>
api.visits.start(outletId) → Result
api.visits.visitInfo(visitId) → Visit
api.visits.visitList(dateOrPeriod, routeOrRouteList) → VisitList
api.visits.visitListByOutlet(outletId, date, route) → VisitList

Methods description

addToRoute(outletId, date) → Result

Создать дополнительный визит на определенную дату

Parameters:
Name Type Description
outletId ID

Идентификатор торговой точки
date Date

Дата, на которую добавляется визит
Return:
Result -

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

canFinish(outletId) → Result

Проверить возможность завершения визита в ТТ

Parameters:
Name Type Description
outletId ID

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

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

canStart(outletId) → Result

Проверить возможность начала визита в ТТ

Parameters:
Name Type Description
outletId ID

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

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

currentVisit(routeId) → Visit

Получить текущий визит

Parameters:
Name Type Argument Description
routeId ID optional 

Идентификатор маршрута, если не задан, то текущий
Return:
Visit

dateOfLastVisit(idOutlet, days) → Date

Функция, возвращающая дату последнего посещения в торговую точку

Parameters:
Name Type Description
idOutlet ID
days Number
Return:
Date

dateOfLastVisitOrOrder(idOutlet, days) → String

Функция получения даты последнего визита или оформления последнего заказа (то, что ближе к сегодняшней дате)

Parameters:
Name Type Description
idOutlet ID
days Number
Return:
String -

формат: yyyy-MM-dd

factVisitDaysByOutlet(outletId, routeId, dayLimit) → DateList

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

Parameters:
Name Type Argument Description
outletId ID optional 

Идентификатор торговой точки, по-умолчанию все ТТ
routeId ID optional 

Идентификатор маршрута, по-умолчанию текущий маршрут
dayLimit Number

Ограничение на количество возвращаемых дней, 0 - без ограничений
Return:
DateList

finish(outletId, reasonId) → Result

Завершить визит в ТТ

Parameters:
Name Type Argument Description
outletId ID

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

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

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

isFinished(outletId, date, routeId) → Boolean

Получить признак, что совершен визит в ТТ

Parameters:
Name Type Argument Description
outletId ID

Идентификатор торговой точки
date Date optional 

Дата, если не задана, то текущая
routeId ID optional 

Идентификатор маршрута, если не задан, то текущий
Return:
Boolean

isStarted(outletId, routeId) → Boolean

Получить признак, что начат визит в ТТ

Parameters:
Name Type Argument Description
outletId ID

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

Идентификатор маршрута, если не задан, то текущий
Return:
Boolean

nextExpectedOutletVisitId(outletId, routeId) → ID

Вернуть следующий плановый или дополнительный визит в торговую точку за период равный настройке многонедельности данного маршрута

Parameters:
Name Type Argument Description
outletId ID

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

Идентификатор маршрута, по-умолчанию текущий
Return:
ID -

Идентификатор планового или дополнительного визита

nextExpectedRouteVisitId(routeId) → ID

Вернуть следующий по порядку визит на маршруте

Parameters:
Name Type Argument Description
routeId ID optional 

Идентификатор маршрута, по-умолчанию текущий
Return:
ID -

Идентификатор планового или дополнительного визита

reasonModel() → Array.<Object>

Функция, возвращающая список результатов визита

Return:
Array.<Object>

start(outletId) → Result

Начать визит в ТТ

Parameters:
Name Type Description
outletId ID

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

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

visitInfo(visitId) → Visit

Вернуть объект, описывающий фактический или плановый визит

Parameters:
Name Type Description
visitId ID

Идентификатор посещения
Return:
Visit -

Информация о визите

visitList(dateOrPeriod, routeOrRouteList) → VisitList

Получить список визитов

Parameters:
Name Type Argument Description
dateOrPeriod Date | Period optional 

Дата или период, если не задано, то текущая дата
routeOrRouteList ID | IDList optional 

Маршрут или список маршрутов, если не задан, то текущий
Return:
VisitList

visitListByOutlet(outletId, date, route) → VisitList

Получить список визитов в торговую точку

Parameters:
Name Type Argument Description
outletId ID

Идентификатор торговой точки
date Date | Period optional 

Дата или период, если не задано, то текущая дата
route ID | IDList optional 

Маршрут или список маршрутов, если не задан, то текущий
Return:
VisitList