api.outlets

Methods

api.outlets.activityChangeDate(outletId, outletDistributorId) → String

api.outlets.address(outletId, distributorId) → String

api.outlets.buyer(buyerId) → Buyer

api.outlets.buyerId(outletId, distributorId) → ID

api.outlets.contact(contactId) → Result

api.outlets.contactList(outletId) → Result

api.outlets.coordinates(outletId) → LatLng

api.outlets.distributorIdList(outletId, lockMode) → IDList

api.outlets.distributorIdListPos(outletId, positionId, lockMode) → IDList

api.outlets.isActive(outletId) → Boolean

api.outlets.isActivityUsed() → Boolean

api.outlets.isAllowEditPhoto(outletId, distrIdList) → Boolean

api.outlets.isAllowViewPhoto(outletId, distrIdList) → Boolean

api.outlets.isAttributeShared(attrType, code) → Boolean

api.outlets.isLocked(outletId, distributorId) → Boolean

api.outlets.isTenant(outletId) → Boolean

api.outlets.markToSend(idMain) → 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.outletIdListByBuyer(buyerId) → IDList

api.outlets.outletIdListByClassifierValue(classifierValue, distributorId) → IDList

api.outlets.outletIdListByClassifierValueList(classifierValueList, distributorId) → IDList

api.outlets.outletIdListByType(typeId, distributorId) → IDList

api.outlets.outletMainId(outletId) → ID

api.outlets.title(outletId, distributorId) → String

api.outlets.titleWithAddress(outletId, distributorId) → String

Methods description

activityChangeDate(outletId, outletDistributorId) → String

Получить дату следующей смены статуса активности торговой точки. Вернёт 1900-01-01, если в будущем нет такой даты.

Parameters:

Name	Type	Description
outletId	ID	Торговая точка
outletDistributorId	ID	Дистрибьютор ТТ

Return:

String

address(outletId, distributorId) → String

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

Parameters:

Name	Type	Argument	Description
outletId	ID		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

contact(contactId) → Result

Получить контактное лицо по идентификатору (Начиная с версии 4.4.2)

Parameters:

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

Return:

Result -

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

contactList(outletId) → Result

Получить список контактных лиц у ТТ (Начиная с версии 4.4.2)

Parameters:

Name	Type	Description
outletId	ID	Идентификатор торговой точки. Тут рекомендуется передать идентификатор IdMain точки, т.к. именно для нее хранятся контактные лица

Return:

Result -

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

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

isActive(outletId) → Boolean

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

Parameters:

Name	Type	Description
outletId	ID	ID торговой точки

Return:

Boolean

isActivityUsed() → Boolean

Признак использования активности ТТ

Return:

Boolean

isAllowEditPhoto(outletId, distrIdList) → Boolean

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

Parameters:

Name	Type	Argument	Description
outletId	ID		Идентификатор торговой точки
distrIdList	IDList	optional	Список идентификаторов дистрибьюторов, для которых выполняется проверка. По умолчанию список дистрибьюторов текущей позиции.

Return:

Boolean

isAllowViewPhoto(outletId, distrIdList) → Boolean

Получить признак возможности просмотра фотографий ТТ

Parameters:

Name	Type	Argument	Description
outletId	ID		Идентификатор торговой точки
distrIdList	IDList	optional	Список идентификаторов дистрибьюторов, для которых выполняется проверка. По умолчанию список дистрибьюторов текущей позиции.

Return:

Boolean

isAttributeShared(attrType, code) → Boolean

Признак разделяемости атрибута

Parameters:

Name	Type	Argument	Description
attrType	AttributeType		Тип атрибута
code	ID	optional	Код для идентификации допатрибута или классификатора

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

markToSend(idMain) → Boolean

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

Parameters:

Name	Type	Description
idMain	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

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

outletIdListByType(typeId, distributorId) → IDList

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

Parameters:

Name	Type	Argument	Description
typeId	ID		Тип ТТ
distributorId	ID	optional	Дистрибьютор, если не задано, то равен дистрибьютору маршрута

Return:

IDList

outletMainId(outletId) → ID

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

Parameters:

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

Return:

ID -

Идентификатор служебной записи торговой точки

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