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

Главная

api.outlets

Торговые точки

Methods

api.outlets.address(outletId, distributorId) → String
api.outlets.buyer(buyerId) → Buyer
api.outlets.buyerId(outletId, distributorId) → ID
api.outlets.coordinates(outletId) → LatLng
api.outlets.distributorIdList(outletId, lockMode) → IDList
api.outlets.distributorIdListPos(outletId, positionId, lockMode) → IDList
api.outlets.isActivityUsed() → Boolean
api.outlets.isLocked(outletId, distributorId) → Boolean
api.outlets.isTenant(outletId) → Boolean
api.outlets.matchedCBDOutletList(outletId, positionId) → IDList
api.outlets.matchedOutletFullIdList(outletId, positionId) → IDList
api.outlets.matchedTenantOutletId(outletDistrCOId) → ID
api.outlets.outlet(outletId, distributorId) → Outlet
api.outlets.outletIdList() → IDList
api.outlets.outletIdListByBuyer(buyerId) → IDList
api.outlets.outletIdListByClassifierValue(classifierValue, distributorId) → IDList
api.outlets.outletIdListByClassifierValueList(classifierValueList, distributorId) → IDList
api.outlets.outletIdListByRoute(routeId) → IDList
api.outlets.outletIdListByType(typeId, distributorId) → IDList
api.outlets.title(outletId, distributorId) → String
api.outlets.titleWithAddress(outletId, distributorId) → String

Members

LockMode :String

Режим отбора торговых точек

Properties:
Name Type Default Description
Undefined String

Не задано
NotLocked String

ТТ не заблокированы
Locked String

ТТ заблокированы

Methods description

address(outletId, distributorId) → String

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

Parameters:
Name Type Argument Description
outletId ID

Торговая точка
distributorId ID optional 

Дистрибьютор, если не задано, то равен дистрибьютору маршрута
Return:
String

buyer(buyerId) → Buyer

Получить данные владельца

Parameters:
Name Type Description
buyerId ID

Владелец
Return:
Buyer

buyerId(outletId, distributorId) → ID

Получить идентификатор владельца торговой точки

Parameters:
Name Type Argument Description
outletId ID

Торговая точка
distributorId ID optional 

Дистрибьютор, если не задано, то равен дистрибьютору маршрута
Return:
ID

coordinates(outletId) → LatLng

Получить координаты торговой точки

Parameters:
Name Type Description
outletId ID

Торговая точка
Return:
LatLng

distributorIdList(outletId, lockMode) → IDList

Получить дистрибьюторов, с которыми работает ТТ

Parameters:
Name Type Argument Default Description
outletId ID

Торговая точка
lockMode LockMode optional  Undefined
Return:
IDList

distributorIdListPos(outletId, positionId, lockMode) → IDList

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

Parameters:
Name Type Argument Default Description
outletId ID

Торговая точка
positionId ID

Позиция, если задана, то отбрасываются дистрибьюторы, с которыми данная позиция не работает
lockMode LockMode optional  Undefined
Return:
IDList

isActivityUsed() → Boolean

Используется ли активность для этой ТТ

Return:
Boolean

isLocked(outletId, distributorId) → Boolean

Получить признак того, что ТТ заблокирована у дистрибьютора

Parameters:
Name Type Argument Description
outletId ID

Торговая точка
distributorId ID optional 

Дистрибьютор, если не задано, то равен дистрибьютору маршрута
Return:
Boolean

isTenant(outletId) → Boolean

Получить признак того, что ТТ из КБЦО

Parameters:
Name Type Description
outletId ID

Торговая точка
Return:
Boolean

matchedCBDOutletList(outletId, positionId) → IDList

Получить список сопоставленных ТТ КБД. В список войдут ТТ, с которыми работает указанная позиция.

Parameters:
Name Type Argument Description
outletId ID

Торговая точка из КБЦО или из КБД. Если это ТТ КБЦО, то берутся все сопоставленные ТТ КБД. Если это ТТ КБД, то возвращаем её же
positionId ID optional 

Позиция, если задана, то отбрасываются ТТ, с которыми данная позиция не работает.
Return:
IDList

matchedOutletFullIdList(outletId, positionId) → IDList

Получить полный список контекстных ТТ в т.ч. по всем сопоставленным ТТ

Parameters:
Name Type Argument Description
outletId ID

Торговая точка из КБЦО или из КБД. Если из КБЦО, то будут включены контексты всех сопоставленных ТТ КБД
positionId ID optional 

Позиция, если задана, то отбрасываются ТТ, с которыми данная позиция не работает.
Return:
IDList

matchedTenantOutletId(outletDistrCOId) → ID

вернуть ТТ КБЦО, сопоставленную с ТТ, если она из КБД

Parameters:
Name Type Description
outletDistrCOId ID

Торговая точка из КБД
Return:
ID

outlet(outletId, distributorId) → Outlet

Получить данные торговой точки

Parameters:
Name Type Argument Description
outletId ID

Торговая точка
distributorId ID optional 

Дистрибьютор, если не задано, то равен дистрибьютору маршрута
Return:
Outlet

outletIdList() → IDList

Получить торговые точки, входящие в территорию текущего маршрута

Return:
IDList

outletIdListByBuyer(buyerId) → IDList

Получить торговые точки по владельцу

Parameters:
Name Type Description
buyerId ID

Владелец ТТ
Return:
IDList

outletIdListByClassifierValue(classifierValue, distributorId) → IDList

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

Parameters:
Name Type Argument Description
classifierValue ID

Значение классификатора
distributorId ID optional 

Дистрибьютор, если не задано, то равен дистрибьютору маршрута
Return:
IDList

outletIdListByClassifierValueList(classifierValueList, distributorId) → IDList

Получить торговые точки по списку значений классификатора. При отборе к значениям одного классификатора применяется логическое И, а к разным логическое ИЛИ

Parameters:
Name Type Argument Description
classifierValueList IDList

Список значений классификаторов
distributorId ID optional 

Дистрибьютор, если не задано, то равен дистрибьютору маршрута
Return:
IDList

outletIdListByRoute(routeId) → IDList

Получить торговые точки, входящие в территорию маршрута

Parameters:
Name Type Description
routeId ID

Маршрут
Return:
IDList

outletIdListByType(typeId, distributorId) → IDList

Получить торговые точки по типу

Parameters:
Name Type Argument Description
typeId ID

Тип ТТ
distributorId ID optional 

Дистрибьютор, если не задано, то равен дистрибьютору маршрута
Return:
IDList

title(outletId, distributorId) → String

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

Parameters:
Name Type Argument Description
outletId ID

Торговая точка
distributorId ID optional 

Дистрибьютор, если не задано, то равен дистрибьютору маршрута
Return:
String

titleWithAddress(outletId, distributorId) → String

Получить название торговой точки, включая адресс

Parameters:
Name Type Argument Description
outletId ID

Торговая точка
distributorId ID optional 

Дистрибьютор, если не задано, то равен дистрибьютору маршрута
Return:
String