QUINCE API. Бренди

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

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

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

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

Повертає список брендів. Для навігації використовується номер сторінки page. Якщо page не передати, буде використана перша сторінка.

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

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

Поля відповіді

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

Створення брендів

Назва методу: /api/v2/brand/add

Метод приймає масив брендів у полі array. Поле Name є обов’язковим. Якщо array відсутній або не є масивом, API повертає Not valid format or empty array.

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

Поле	Опис
`array`	Масив брендів. Обов’язковий.
`array[].Name`	Назва бренду. Обов’язкова.
`array[].Comment`	Коментар. Необов’язковий.

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

{
  "array": [
    {
      "Name": "Новий бренд",
      "Comment": "Коментар до бренду"
    }
  ]
}

Оновлення брендів

Назва методу: /api/v2/brand/update

Метод приймає масив брендів у полі array. Поле Id є обов’язковим. Якщо Name передати порожнім рядком, API поверне помилку Execution terminated. "Name" can not be empty.

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

Поле	Опис
`array`	Масив брендів. Обов’язковий.
`array[].Id`	Ідентифікатор бренду. Обов’язковий.
`array[].Name`	Нова назва бренду.
`array[].Comment`	Коментар.
`array[].Void`	Ознака архівності.

Приклад відповіді для add/update

{
  "success": true,
  "data": [
    {
      "id": 123
    }
  ]
}