api.merch.doc

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

Общие функции работы с документом Мерчандайзинг

api.merch.doc

Открытые члены
	create (outletId, distributorId)
	Создать новый документ Мерчандайзинг Подробнее...
	del (docId)
	Удалить документ Мерчандайзинг Подробнее...
	edit (docId)
	Отредактировать документ Мерчандайзинг Подробнее...
	editHeader (obj)
	Изменить заголовочную часть документа Мерчандайзинг Подробнее...
	header (docId)
	Получить заголовочную часть документа Мерчандайзинг Подробнее...
	lastDocId (outletId)
	Получить ID последнего доступного документа Мерчандайзинг (черновик либо валидный) в указанной ТТ Подробнее...
	putRow (docId, row)
	Добавить/отредактировать строку документа Мерчандайзинг Подробнее...
	removeRow (docId, skuId)
	Удалить строку документа Мерчандайзинг Подробнее...
	removeRows (docId, skuIdList)
	Удалить список строк документа Мерчандайзинг Подробнее...
	row (docId, skuId)
	Получить строку документа Мерчандайзинг Подробнее...
	rows (docId)
	Получить строчную часть документа Мерчандайзинг Подробнее...
	skuIdList (docId)
	Получить список всех идентификаторов товаров, для которых есть строки в документе Мерчандайзинг Подробнее...
	validate (docId)
	Валидировать документ Мерчандайзинг Подробнее...

Методы

create (outletId, distributorId)

create	(	outletId	,
		distributorId
	)

Создать новый документ Мерчандайзинг

Аргументы

outletId	[ID] - Идентификатор ТТ
distributorId	[ID] - Идентификатор дистрибьютора

Возвращает

Result - Результат выполнения операции.
В поле value - Идентификатор созданного документа Мерчандайзинг (ID)

del (docId)

del

(

docId

)

Удалить документ Мерчандайзинг

Аргументы

docId

[ID] - Идентификатор существующего документа Мерчандайзинг

Предупреждения

В случае невалидного идентификатора docId транзакция откатится

Возвращает

Result - Признак успешного удаления документа Мерчандайзинг

edit (docId)

edit

(

docId

)

Отредактировать документ Мерчандайзинг

Аргументы

docId

[ID] - Идентификатор существующего документа Мерчандайзинг

Предупреждения

В случае невалидного идентификатора docId вернется ошибка

Возвращает

Result - Результат выполнения операции.
В поле value - Идентификатор текущего документа, если документ является черновиком, или идентификатор новой версии текущего документа (ID)

editHeader (obj)

editHeader

(

obj

)

Изменить заголовочную часть документа Мерчандайзинг

Аргументы

obj	[DocumentInfo] - Новые параметры для существующей заголовочной части документа Мерчандайзинг

Предупреждения

В случае отсутствия параметра id в объекте obj вернется ошибка

В случае неправильно сформированного объекта obj вернется ошибка сохранения данных

Возвращает

Result - Признак успешного сохранения заголовочной части документа Мерчандайзинг (если не успешно, то результат содержит текст ошибки)

header (docId)

header

(

docId

)

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

Аргументы

docId

[ID] - Идентификатор существующего документа Мерчандайзинг

Предупреждения

В случае невалидного идентификатора docId вернется ошибка

Возвращает

Result - Результат выполнения операции.
В поле value - Заголовочная часть документа Мерчандайзинг (DocumentInfo)

lastDocId (outletId)

lastDocId

(

outletId

)

Получить ID последнего доступного документа Мерчандайзинг (черновик либо валидный) в указанной ТТ

Аргументы

outletId

[ID] - Идентификатор ТТ

Возвращает

Result - Результат выполнения операции.
В поле value - Последний документ доступный для редактирования: либо черновик, либо валидный документ (ID)

putRow (docId, row)

* putRow	(	docId	,
		row
	)

Добавить/отредактировать строку документа Мерчандайзинг

Аргументы

docId	[ID] - Идентификатор существующего документа Мерчандайзинг
rowObj	[MerchDocRowForSaving] - Новая строка документа Мерчандайзинг или новые параметры существующей строки документа Мерчандайзинг

Предупреждения

В случае невалидного идентификатора docId вернется ошибка

В случае отсутствия параметра skuId в объекте rowObj вернется ошибка

В случае неправильно сформированного rowObj вернется ошибка сохранения данных

Возвращает

Result - Признак успешного сохранения строки документа Мерчандайзинг (если не успешно, то результат содержит текст ошибки)

removeRow (docId, skuId)

removeRow	(	docId	,
		skuId
	)

Удалить строку документа Мерчандайзинг

Аргументы

docId	[ID] - Идентификатор существующего документа Мерчандайзинг
skuId	[ID] - Идентификатор существующего товара

Предупреждения

В случае хотя бы одного невалидного идентификатора docId или skuId вернется ошибка

Возвращает

Result - Признак успешного удаления строки в документе Мерчандайзинг (если не успешно, то результат содержит текст ошибки)

removeRows (docId, skuIdList)

removeRows	(	docId	,
		skuIdList
	)

Удалить список строк документа Мерчандайзинг

Аргументы

docId	[ID] - Идентификатор существующего документа Мерчандайзинг
skuIdList	[IDList] - Список идентификаторов существующих товаров

Предупреждения

В случае хотя бы одного невалидного идентификатора в skuIdList или невалидного docId вернется ошибка

Возвращает

Result - Признак успешного удаления строки в документе Мерчандайзинг (если не успешно, то результат содержит текст ошибки)

row (docId, skuId)

* row	(	docId	,
		skuId
	)

Получить строку документа Мерчандайзинг

Аргументы

docId	[ID] - Идентификатор существующего документа Мерчандайзинг
skuId	[ID] - Идентификатор существующего товара

Предупреждения

В случае хотя бы одного невалидного идентификатора docId или skuId вернется ошибка

В случае отсутствия товара с указанным идентификатором в документе вернется ошибка

Возвращает

Result - Результат выполнения операции.
В поле value - Строка документа Мерчандайзинг (MerchDocRow)

rows (docId)

rows

(

docId

)

Получить строчную часть документа Мерчандайзинг

Аргументы

docId

[ID] - Идентификатор существующего документа Мерчандайзинг

Предупреждения

В случае невалидного идентификатора docId вернется ошибка

Возвращает

Result - Результат выполнения операции.
В поле value - Строчная часть документа Мерчандайзинг (MerchDocRow[])

skuIdList (docId)

skuIdList

(

docId

)

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

Аргументы

docId

[ID] - Идентификатор существующего документа Мерчандайзинг

Предупреждения

В случае невалидного идентификатора docId вернется ошибка

Возвращает

Result - Результат выполнения операции.
В поле value - Список всех идентификаторов товаров, для которых есть строки в документе Мерчандайзинг (IDList)

validate (docId)

validate

(

docId

)

Валидировать документ Мерчандайзинг

Аргументы

docId

[ID] - Идентификатор существующего документа Мерчандайзинг

Предупреждения

В случае невалидного идентификатора docId транзакция откатится

Возвращает

Result - Признак успешного завершения валидации документа Мерчандайзинг