api.order.doc

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

Общие функции работы с документом "Заказ".

api.order.doc

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

Методы

create (outletId)

create

(

outletId

)

Создать новый документ "Заказ".

Аргументы

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

Возвращает

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

dataTextView (docId, key)

dataTextView	(	docId	,
		key
	)

Получить текстовое представление документа "Заказ".

Аргументы

docId	[ID] - Идентификатор документа
key	[String] - Ключ шаблона (stmobile://printform/<doc>/<ключ>)

Возвращает

Result - Результат выполнения операции.
В поле value - Текстовое представление документа "Заказ" (String)

del (docId)

del

(

docId

)

Удалить документ "Заказ".

Аргументы

docId

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

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

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

Возвращает

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

edit (docId)

edit

(

docId

)

Отредактировать документ "Заказ".

Аргументы

docId

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

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

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

Возвращает

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

editHeader (obj)

editHeader

(

obj

)

Изменить заголовочную часть документа "Заказ".

Аргументы

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

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

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

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

Возвращает

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

header (docId)

header

(

docId

)

Получить заголовочную часть документа "Заказ".

Аргументы

docId

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

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

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

Возвращает

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

lastDocId (outletId)

lastDocId

(

outletId

)

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

Аргументы

outletId

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

Возвращает

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

putRow (docId, row)

putRow	(	docId	,
		row
	)

Добавить/отредактировать строку документа "Заказ".

Аргументы

docId	[ID] - Идентификатор существующего документа "Заказ"
row	[OrderDocRowForSaving] - Новая строка документа "Заказ" или строка с новыми параметрами существующих строк документа "Заказ"

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

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

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

Возвращает

Result - Признак успешного сохранения строки документа "Заказ"

removeRows (docId, skuList)

removeRows	(	docId	,
		skuList
	)

Удалить список строк документа "Заказ".

Аргументы

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

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

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

Возвращает

Result - Признак успешного удаления строки в документе "Заказ"

row (docId, skuId)

row	(	docId	,
		skuId
	)

Получить строку документа "Заказ".

Аргументы

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

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

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

Возвращает

Result - Результат выполнения операции.
В поле value - Строка документа "Заказ" (OrderDocRow)

rows (docId)

rows

(

docId

)

Получить строчную часть документа "Заказ".

Аргументы

docId

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

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

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

Возвращает

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

skuIdList (docId)

skuIdList

(

docId

)

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

Аргументы

docId

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

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

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

Возвращает

Result - Результат выполнения операции.
В поле value - Список всех идентификаторов товаров, для которых есть строки в документе "Заказ" (ID[])

validate (docId)

validate

(

docId

)

Валидировать документ "Заказ".

Аргументы

docId

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

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

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

Возвращает

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