QUINCE API. Послуги

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

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

Отримання списку послуг

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

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

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

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

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

Поле	Опис
`Id`	Ідентифікатор послуги.
`Name`	Назва послуги.
`ParentFolder`	Ідентифікатор батьківської папки.
`PrintName`	Назва для друку.
`Memo`	Коментар.
`Barcode`	Штрихкод.
`UnitName`	Назва одиниці виміру.
`Description`	Опис послуги.
`Article`	Артикул.
`Images`	Зображення послуги. Основне зображення йде першим у масиві.
`Prices`	Ціни послуги, якщо в запиті передано `filter.PriceType`.

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

{
  "filter": {
    "ParentFolder": 110,
    "PriceType": [339]
  },
  "page": 1
}

Створення та оновлення послуг

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

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

Методи додають або оновлюють послуги пакетами до 100 елементів. Для /api/v2/service/update поле Id обов’язкове. Якщо переданий Id не належить послузі, такий елемент не оновлюється.

Якщо передати основного постачальника через MainSupplierName або MainSupplierRegCode, API знайде або створить партнера та прив’яже його як постачальника.

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

Поле	Опис
`array`	Масив послуг. Обов’язковий.
`array[].Id`	Ідентифікатор послуги. Обов’язковий для `/api/v2/service/update`.
`array[].Name`	Назва послуги.
`array[].ParentFolder`	Ідентифікатор папки.
`array[].PrintName`	Назва для друку.
`array[].Memo`	Коментар.
`array[].Barcode`	Штрихкод.
`array[].UnitName`	Одиниця виміру. Якщо одиниця відсутня, вона створюється автоматично.
`array[].Description`	Опис.
`array[].Article`	Артикул.
`array[].MainSupplierName`	Назва основного постачальника.
`array[].MainSupplierRegCode`	Реєстраційний код основного постачальника.

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

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

Папки послуг

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

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

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

Метод списку повертає папки послуг сторінками по 100 елементів. Для папок першого рівня передайте filter.ParentFolder: null. У списку також підтримуються filter.Archive і filter.MobileApp.

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

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

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

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

Для створення папки Name обов’язковий, а переданий Id ігнорується. Для оновлення Id має бути цілим числом; якщо передати порожній Name, API поверне помилку.