Додавання бренду, метод: /api/brand/add/
Приклад:
| № | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
| 1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
| 2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
| 3 | name | string | Назва бренду | Обов'язкове поле. | |
| 4 | code | string | id бренду з вашої системи | Не обов'язкове поле. | Це унікальний ідентифікатор бренду з вашої системи (з вашого магазину). Якщо бренд з таким id існує, то API видасть помилку |
| 7 | image | array | масив зображень бренду | Не обов'язкове поле. | Зображення слід передавати масивом із зазначенням повного шляху до них. Система працює з такими форматами зображень: jpg, png |
| 8 | hidden | boolean | прихований бренд | Не обов'язкове поле. | За замовчуванням, бренд не є прихованим (hidden = 0) |
| 5 | description | string | опис бренду | Не обов'язкове поле. |
Видалення бренду, метод: /api/brand/delete/
Приклад:
| № | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
| 1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
| 2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
| 3 | id | integer | Ідентифікатор бренду | або id або code бренду обов'язково | Код бренду в системі BOX |
| 4 | code | string | Ідентифікатор бренду | Ідентифікатор бренду з вашої системи (з вашого магазину) |
Редагування бренду, метод: /api/brand/update/
Приклад:
| № | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
| 1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
| 2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
| 3 | id | integer | Ідентифікатор бренду | або id або code бренду обов'язково | Код бренду в системі BOX |
| 4 | code | string | Ідентифікатор бренду | Ідентифікатор бренду з вашої системи (з вашого магазину) | |
| 5 | name | string | Назва бренду | Обов'язкове поле. | |
| 6 | description | string | опис бренду | Не обов'язкове поле. | |
| 8 | image | array | масив зображень бренду | Не обов'язкове поле. | Зображення слід передавати масивом із зазначенням повного шляху до них. Система працює з такими форматами зображень: jpg, png |
| 9 | hidden | boolean | прихований бренд | Не обов'язкове поле. | За замовчуванням, бренд не є прихованим (hidden = 0) |
Отримання одного бренду і отримання всіх брендів, метод: /api/brand/get/
Приклад:
| № | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
| 1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
| 2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
| 3 | name | string | Назва бренду | name або id або code бренду обов'язково | Якщо вам потрібен конкретний бренд, то ви в це поле передаєте ім'я бренду, або id бренду яке повернуло вам наше API при його створенні. Або ж вказуєте зовнішній ідентифікатор бренду (поле code при створенні бренду) і движок сам знайде і вёрнёт його. Значення повертаються полів id - id бренду, name - Назва бренду, code - зовнішній id бренду, image - масив зображень бренду, description - опис бренду, hidden - прихований бренд |
| 4 | id | integer | Ідентифікатор бренду | ||
| 4 | code | string | Ідентифікатор бренду |
Приклад:
| № | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
| 1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
| 2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
| Значення повертаються полів id - id бренду, name - Назва бренду, code - зовнішній id бренду, image - масив зображень бренду, description - опис бренду, hidden - прихований бренд |
Можливі варіанти відповіді на запит
| № | Статус | Повідомлення | Опис повідомлення |
| 1 | ok | brandid | Повертає id доданого бренду |
| 2 | fail | Login is empty! | Відсутня логін |
| 3 | fail | Password is empty! | Відсутня пароль |
| 4 | fail | Brand name is empty! | Відсутня назва бренду |
| 5 | fail | Bad user level! | Недостатній рівень користувача (потрібен level 2 і вище) |
| 6 | fail | Login or password not correct! | Логін або пароль введені невірно |
| 7 | fail | Brand with this ID already exists! | Бренд з таким id вже існує |
| 8 | fail | Incorrect picture! | Некоректний формат зображення |
| 9 | fail | Brand has not been added | Бренд не додано |
| 10 | fail | Brand is not available for delete! | Бренд для видалення не найден |
| 11 | fail | Brand with this ID does not exists! | Бренда з таким ID не існує |
| 12 | fail | Brand with this Code does not exists! | Бренда з таким кодом не існує |
| 13 | fail | Brand with this name does not exists! | Бренда з таким ім'ям не існує |
| 14 | fail | Brand is not available for update! | Бренд для оновлення не знайдено |