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

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

api.outlets

Открытые члены
	address (outletId, distributorId)
	Получить адрес торговой точки Подробнее...

	buyer (buyerId)
	Получить данные владельца Подробнее...

	buyerId (outletId, distributorId)
	Получить идентификатор владельца торговой точки Подробнее...

	contact (contactId)
	Получить контактное лицо по идентификатору Подробнее...

	contactList (outletId)
	Получить список контактных лиц у ТТ Подробнее...

	coordinates (outletId)
	Получить координаты торговой точки Подробнее...

	createContact (outletId, contact)
	Создать и добавить контактное лицо к указанной ТТ Подробнее...

	createOutlet (distributorId, data)
	Создать торговую точку Подробнее...

	distributorIdList (outletId)
	Получить дистрибьюторов, с которыми работает ТТ Подробнее...

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

	isActive (outletId)
	Получить признак активности ТТ Подробнее...

	isActivityUsed ()
	Признак использования активности ТТ Подробнее...

	isAllowEditPhoto (outletId, distributorIdList)
	Получить признак возможности редактирования фотографий ТТ Подробнее...

	isAllowViewPhoto (outletId, distributorIdList)
	Получить признак возможности просмотра фотографий ТТ Подробнее...

	isLocked (outletId, distributorId)
	Получить признак того, что ТТ заблокирована у дистрибьютора Подробнее...

	isTenant (outletId)
	Получить признак того, что ТТ из КБЦО Подробнее...

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

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

	matchedTenantOutletId (outletId)
	Вернуть ТТ КБЦО, сопоставленную с ТТ, если она из КБД Подробнее...

	outlet (outletId)
	Получить данные торговой точки Подробнее...

	outletIdListByBuyer (buyerId)
	Получить торговые точки по владельцу Подробнее...

	outletIdListByClassifierValue (classifierValue, distributorId)
	Получить торговые точки по значению классификатора Подробнее...

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

	outletIdListByType (typeId, distributorId)
	Получить торговые точки по типу Подробнее...

	removeContact (contactId)
	Удалить контактное лицо Подробнее...

	title (outletId, distributorId)
	Получить заголовок торговой точки Подробнее...

	titleWithAddress (outletId, distributorId)
	Получить заголовок торговой точки, включающий адрес Подробнее...

	updateContact (contact)
	Обновить контактное лицо. Подробнее...

	updateOutlet (outletId, data)
	Редактировать данные торговой точки Подробнее...

Методы

address (outletId, distributorId)

address	(	outletId	,
		distributorId
	)

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

Аргументы

outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] optional - Параметр не используется (2020-01-01) в связи с отказом от контекстных ТТ

Возвращает: String - Адрес торговой точки

buyer (buyerId)

buyer ( buyerId )

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

Аргументы

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

Возвращает: Buyer - данные по владельцу

buyerId (outletId, distributorId)

buyerId	(	outletId	,
		distributorId
	)

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

Аргументы

outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] optional - Параметр не используется (2020-01-01) в связи с отказом от контекстных ТТ

Возвращает: ID - Идентификатор владельца

contact (contactId)

* contact ( contactId )

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

Аргументы

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

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

contactList (outletId)

contactList ( outletId )

Получить список контактных лиц у ТТ

Аргументы

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

Возвращает: Result - Результат выполнения операции.
В поле value - список данных контактных лиц (ContactPerson[])

coordinates (outletId)

coordinates ( outletId )

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

Аргументы

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

Возвращает: LatLng - Координаты торговой точки

createContact (outletId, contact)

createContact	(	outletId	,
		contact
	)

Создать и добавить контактное лицо к указанной ТТ

Для того чтобы пометить созданное контактное лицо на отправку, необходимо вызвать api.outlets.markToSend на ТТ, к которой оно привязано

Аргументы

outletId	[ID] - Идентификатор торговой точки
contact	[ContactPerson] - Контактное лицо

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

createOutlet (distributorId, data)

createOutlet	(	distributorId	,
		data
	)

Создать торговую точку

После создания ТТ необходимо вызвать api.outlets.markToSend для того, чтобы пометить ее на отправку

Аргументы

distributorId	[ID] - Идентификатор дистрибьютора
data	[Outlet] - Данные торговой точки

Возвращает: Result - Результат операции
В поле value - Идентификатор созданной торговой точки

distributorIdList (outletId)

distributorIdList ( outletId )

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

Аргументы

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

Возвращает: IDList - Список идентификаторов дистрибьюторов

distributorIdListPos (outletId, positionId)

distributorIdListPos	(	outletId	,
		positionId
	)

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

Аргументы

outletId	[ID] - Идентификатор торговой точки
positionId	[ID] optional - Идентификатор позиции, если не задан, то текущая позиция

Возвращает: IDList - Список идентификаторов дистрибьюторов

isActive (outletId)

isActive ( outletId )

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

Аргументы

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

Возвращает: Boolean

isActivityUsed ()

isActivityUsed ( )

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

Возвращает: Boolean

isAllowEditPhoto (outletId, distributorIdList)

isAllowEditPhoto	(	outletId	,
		distributorIdList
	)

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

Аргументы

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

Возвращает: Boolean

isAllowViewPhoto (outletId, distributorIdList)

isAllowViewPhoto	(	outletId	,
		distributorIdList
	)

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

Аргументы

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

Возвращает: Boolean

isLocked (outletId, distributorId)

isLocked	(	outletId	,
		distributorId
	)

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

Аргументы

outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] optional - Параметр не используется (2020-01-01) в связи с отказом от контекстных ТТ

Возвращает: Boolean

isTenant (outletId)

isTenant ( outletId )

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

Аргументы

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

Возвращает: Boolean

markToSend (outletId)

markToSend ( outletId )

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

Аргументы

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

Возвращает: Boolean - Признак успеха выполнения операции

matchedCBDOutletList (outletId, positionId)

matchedCBDOutletList	(	outletId	,
		positionId
	)

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

Аргументы

outletId	[ID] - Идентификатор торговой точки. Если это ТТ КБЦО, то берутся все сопоставленные ТТ КБД. Если это ТТ КБД, то возвращаем ее же
positionId	[ID] optional - Идентификатор позиции. Если задан, то отбрасываются ТТ, с которыми данная позиция не работает

Возвращает: IDList - Список идентификаторов сопоставленных ТТ

matchedTenantOutletId (outletId)

matchedTenantOutletId ( outletId )

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

Аргументы

outletId [ID] - Идентификатор ТТ из КБД

Возвращает: ID - Идентификатор сопоставленной ТТ либо '0' (undefinedId)

outlet (outletId)

outlet ( outletId )

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

Аргументы

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

Возвращает: Outlet - Данные торговой точки

outletIdListByBuyer (buyerId)

outletIdListByBuyer ( buyerId )

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

Аргументы

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

Возвращает: IDList - Cписок идентификаторов торговых точек

outletIdListByClassifierValue (classifierValue, distributorId)

outletIdListByClassifierValue	(	classifierValue	,
		distributorId
	)

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

Аргументы

classifierValue	[ID] - Значение классификатора
distributorId	[ID] optional - Идентификатор дистрибьютора. Если не задан, то будет использоваться дистрибьютор маршрута

Возвращает: IDList - Cписок идентификаторов торговых точек

outletIdListByClassifierValueList (classifiers, distributorId)

outletIdListByClassifierValueList	(	classifiers	,
		distributorId
	)

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

Аргументы

classifierValueList	[IDList] - Список значений классификаторов
distributorId	[ID] optional - Идентификатор дистрибьютора. Если не задан, то будет использоваться дистрибьютор маршрута

Возвращает: IDList - Cписок идентификаторов торговых точек

outletIdListByType (typeId, distributorId)

outletIdListByType	(	typeId	,
		distributorId
	)

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

Аргументы

typeId	[ID] - Идентификатор типа торговой точки
distributorId	[ID] optional - Идентификатор дистрибьютора. Если не задан, то будет использоваться дистрибьютор маршрута

Возвращает: IDList - Cписок идентификаторов торговых точек

removeContact (contactId)

removeContact ( contactId )

Удалить контактное лицо

Аргументы

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

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

title (outletId, distributorId)

title	(	outletId	,
		distributorId
	)

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

Аргументы

outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] optional - Параметр не используется (2020-01-01) в связи с отказом от контекстных ТТ

Возвращает: String - Заголовок торговой точки

titleWithAddress (outletId, distributorId)

titleWithAddress	(	outletId	,
		distributorId
	)

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

Аргументы

outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] optional - Параметр не используется (2020-01-01) в связи с отказом от контекстных ТТ

Возвращает: String - Заголовок торговой точки, включающий адрес

updateContact (contact)

updateContact ( contact )

Обновить контактное лицо.

Для корректной работы с методом требуется получить данные контактного лица методами api.outlets.contact или api.outlets.contactList,
изменить необходимые параметры и отдать в этот метод отредактированную структуру.

Аргументы

contact [ContactPerson] - Контактное лицо

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

updateOutlet (outletId, data)

* updateOutlet	(	outletId	,
		data
	)

Редактировать данные торговой точки

Метод воспринимает полученные данные в параметре data как полную структуру ТТ, поэтому для корректного редактирования,
необходимо получить текущие данные ТТ методом api.outlets.outlet(outletId), а затем добавить/изменить нужные параметры в полученной структуре

Аргументы

outletId	[ID] - Идентификатор торговой точки
data	[Outlet] - Данные торговой точки

Возвращает: Result - Результат редактирования

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

Открытые члены

Методы

address (outletId, distributorId)

buyer (buyerId)

buyerId (outletId, distributorId)

contact (contactId)

contactList (outletId)

coordinates (outletId)

createContact (outletId, contact)

createOutlet (distributorId, data)

distributorIdList (outletId)

distributorIdListPos (outletId, positionId)

isActive (outletId)

isActivityUsed ()

isAllowEditPhoto (outletId, distributorIdList)

isAllowViewPhoto (outletId, distributorIdList)

isLocked (outletId, distributorId)

isTenant (outletId)

markToSend (outletId)

matchedCBDOutletList (outletId, positionId)

matchedTenantOutletId (outletId)

outlet (outletId)

outletIdListByBuyer (buyerId)

outletIdListByClassifierValue (classifierValue, distributorId)

outletIdListByClassifierValueList (classifiers, distributorId)

outletIdListByType (typeId, distributorId)

removeContact (contactId)

title (outletId, distributorId)

titleWithAddress (outletId, distributorId)

updateContact (contact)

updateOutlet (outletId, data)