QUINCE API. Склади

Список методів

Метод	Опис
`/api/v2/store/list`	Отримання списку складів
`/api/v2/store/add`	Створення складів
`/api/v2/store/update`	Оновлення складів
`/api/v2/store/folder/list`	Отримання списку папок складів
`/api/v2/store/folder/add`	Створення папок складів
`/api/v2/store/folder/update`	Оновлення папок складів

Отримання списку складів

Назва методу: /api/v2/store/list

Повертає список складів. Для навігації використовується номер сторінки page. Розмір сторінки фіксований і дорівнює 100 елементам.

Параметри запиту

Поле	Тип	Опис
`filter`	object	Необов’язковий фільтр. Поля фільтра працюють з логікою `AND`.
`filter.ParentFolder`	integer або `null`	Ідентифікатор папки. Для складів без папки передайте `null`.
`filter.Id`	integer	Ідентифікатор складу.
`filter.Archive`	boolean	Ознака повернення архівних складів.
`filter.MobileApp`	boolean	Якщо `true`, API використовує режим вибірки для мобільного застосунку.
`page`	integer	Номер сторінки. Якщо не передати, використовується перша сторінка.

Основні поля відповіді

Поле	Опис
`Id`	Ідентифікатор складу.
`Name`	Назва складу.
`ParentFolder`	Ідентифікатор батьківської папки.
`Memo`	Коментар.

Приклад запиту

{
  "filter": {
    "ParentFolder": 110
  },
  "page": 1
}

Створення та оновлення складів

Назва методу створення: /api/v2/store/add

Назва методу оновлення: /api/v2/store/update

Методи додають або оновлюють склади пакетами до 100 елементів. Для /api/v2/store/add поле Name обов’язкове, а переданий Id ігнорується. Для /api/v2/store/update поле Id обов’язкове і має бути цілим числом. Якщо переданий Id не знайдено, API повертає success: false, помилку Execution terminated. Bad Ids. і список проблемних Id.

Під час оновлення ParentFolder змінюється тільки якщо поле явно присутнє в об’єкті складу.

Параметри запиту

Поле	Опис
`array`	Масив складів. Обов’язковий.
`array[].Id`	Ідентифікатор складу. Обов’язковий для `/api/v2/store/update`.
`array[].Name`	Назва складу.
`array[].ParentFolder`	Ідентифікатор папки.
`array[].Memo`	Коментар.

Формат відповіді

Поле	Опис
`success`	`true` або `false`.
`data`	Масив ідентифікаторів створених або оновлених складів.
`error`	Код і текст помилки, якщо `success = false`.

Папки складів

Назва методу списку: /api/v2/store/folder/list

Назва методу створення: /api/v2/store/folder/add

Назва методу оновлення: /api/v2/store/folder/update

Метод списку повертає папки складів сторінками по 100 елементів. Фільтр filter.ParentFolder працює за загальним правилом з розділу Папки довідників: якщо поле не передати, повертаються всі папки; null повертає папки першого рівня; Id повертає прямі підпапки. У списку також підтримуються filter.Id, filter.Archive і filter.MobileApp.

Параметри списку папок

Поле	Опис
`filter.ParentFolder`	Ідентифікатор батьківської папки або `null` для першого рівня.
`filter.Id`	Ідентифікатор папки.
`filter.Archive`	Ознака повернення архівних папок.
`filter.MobileApp`	Якщо `true`, API використовує режим вибірки для мобільного застосунку.
`page`	Номер сторінки.

Поля відповіді списку папок

Поле	Опис
`Id`	Ідентифікатор папки.
`Name`	Назва папки.
`ParentFolder`	Ідентифікатор батьківської папки або `null` для першого рівня.
`Void`	Ознака архівності.

Приклад запиту списку папок

{
  "filter": {
    "ParentFolder": null
  },
  "page": 1
}

Параметри створення та оновлення папок

Поле	Опис
`array`	Масив папок. Обов’язковий.
`array[].Id`	Ідентифікатор папки. Обов’язковий для `/api/v2/store/folder/update`.
`array[].Name`	Назва папки.
`array[].ParentFolder`	Ідентифікатор батьківської папки. Для папки першого рівня не передавайте поле або передайте `null`.
`array[].UpdateParentFolder`	Тільки для `/api/v2/store/folder/update`. Передайте `true`, щоб перемістити папку в `ParentFolder`. Без цього прапорця батьківська папка не змінюється.

Для створення папки Name обов’язковий, а переданий Id ігнорується. Для оновлення Id має бути цілим числом; якщо передати порожній Name, API поверне помилку. Якщо переданий Id не знайдено, API повертає success: false, помилку Execution terminated. Bad Ids. і список проблемних Id.