api.merchꓸdoc

Methods

api.merchꓸdoc.create(outletId, distributorId) → Result

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

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

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

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

api.merchꓸdoc.lastDocId(outletId) → Result

api.merchꓸdoc.putRow(docId, documentRow) → Result

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

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

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

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

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

Methods description

create(outletId, distributorId) → Result

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

Parameters:

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

Return:

Result -

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

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 вернется ошибка

lastDocId(outletId) → Result

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

Parameters:

Name	Type	Description
outletId	ID	Идентификатор ТТ

Return:

Result -

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

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 транзакция откатится