Список версий МТ

Главная

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 возвращается структура Document созданого документа Мерчандайзинг (заголовочная + строчная части)

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 возвращается идентификатор 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 возвращается структура Document заголовочной части документа Мерчандайзинг
Throws:

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

lastDocId(outletId) → Result

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

Parameters:
Name Type Description
outletId ID

Идентификатор ТТ
Return:
Result -

Результат поиска документа. При успешном результате в поле value возвращается идентификатор 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 возвращается
структура DocumentRow полученной строки документа Мерчандайзинг
Throws:

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

skuIdList(docId) → Result

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

Parameters:
Name Type Description
docId ID

Идентификатор существующего документа Мерчандайзинг
Return:
Result -

Результат получения списка товаров. В поле value возвращается структура IDList списка всех идентификаторов товаров, для которых есть строки в документе Мерчандайзинг
Throws:

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

validate(docId) → Result

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

Parameters:
Name Type Description
docId ID

Идентификатор существующего документа Мерчандайзинг
Return:
Result -

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

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