api.movementꓸdoc

Methods

api.movementꓸdoc.create(distributorId) → Result

api.movementꓸdoc.del(docId) → Result

api.movementꓸdoc.edit(docId) → Result

api.movementꓸdoc.editHeader(document) → Result

api.movementꓸdoc.header(docId) → Result

api.movementꓸdoc.putRow(docId, documentrow) → Result

api.movementꓸdoc.removeRow(docId, skuId) → Result

api.movementꓸdoc.removeRows(docId, skuIdList) → Result

api.movementꓸdoc.row(docId, skuId) → Result

api.movementꓸdoc.skuIdList(docId) → Result

api.movementꓸdoc.validate(docId) → Result

Methods description

create(distributorId) → Result

Создать новый документ Перемещение

Parameters:

Name	Type	Description
distributorId	ID	Идентификатор дистрибьютора

Return:

Result -

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

Throws:

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

del(docId) → Result

Удалить документ Перемещение

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа Перемещение

Return:

Result -

Результат выполнения операции

Throws:

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

edit(docId) → Result

Отредактировать документ Перемещение

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа Перемещение

Return:

Result -

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

Throws:

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

editHeader(document) → Result

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

Parameters:

Name	Type	Description
document	Document	Новые параметры для существующей заголовочной части документа Перемещение

Return:

Result -

Результат выполнения операции.

Throws:

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

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

header(docId) → Result

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

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа Перемещение

Return:

Result -

Результат выполнения операции.
В поле value - заголовочная часть документа Перемещение (type Document)

Throws:

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

putRow(docId, documentrow) → Result

Добавить/отредактировать строку документа Перемещение

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа Перемещение
documentrow	DocumentRow	Новая строка документа Перемещение или новые параметры существующей строки документа Перемещение

Return:

Result -

Результат выполнения операции

Throws:

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

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

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

removeRow(docId, skuId) → Result

Удалить строку табличной части документа Перемещение

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа Перемещение
skuId	ID	Идентификатор существующего товара

Return:

Result -

Результат выполнения операции

Throws:

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

removeRows(docId, skuIdList) → Result

Удалить список строк табличной части документа Перемещение

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа Перемещение
skuIdList	IDList	Список идентификаторов существующих товаров

Return:

Result -

Результат выполнения операции

Throws:

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

row(docId, skuId) → Result

Получить строку документа Перемещение

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа Перемещение
skuId	ID	Идентификатор существующего товара

Return:

Result -

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

Throws:

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

skuIdList(docId) → Result

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

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа Перемещение

Return:

Result -

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

Throws:

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

validate(docId) → Result

Провести сохранение документа Перемещение для отправки его в учетную систему с проверкой корректности параметров документа

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа Перемещение

Return:

Result -

Результат выполнения операции

Throws:

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