Групи товарів

Дерево груп товарів

Отримати всі групи товарів у вигляді дерева

GET /api/groupsGoods/tree{?active,order}

Параметри

Параметр	Тип	Обов’язковий	Опис
active	string	ні	Якщо параметр присутній і дорівнює «true», повертається дерево з використанням лише активних груп товарів.
order	string	ні	Список полів сортування через кому без пробілів. Для зворотного сортування поставити - перед іменем поля.

Відповідь 200 (application/json)

[
  {
    "id_group": 4,
    "name_group": "Пополнение счета",
    "id_owner_group": 0,
    "active": true,
    "id_image": 123,
    "children": [
      {}
    ]
  }
]

Список груп товарів

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

GET /api/groupsGoods/list{?active,ids_list,filters,order,offset,limit}

Параметри

Параметр	Тип	Обов’язковий	Опис
active	string	ні	Якщо параметр присутній і дорівнює «true», повертається дерево з використанням лише активних груп товарів.
ids_list	string	ні	Список значень ключового поля записів, які потрібно повернути. Зазначається через кому без пробілу
filters	string	ні	Текстові фільтри у форматі: field_name:: |field_name1::
order	string	ні	Список полів сортування через кому без пробілів. Для зворотного сортування поставити - перед іменем поля.
offset	number	ні	Повертати дані, починаючи з указаного номера запису
limit	number	ні	Повертати вказану кількість записів

Відповідь 200 (application/json)

[
  {
    "id_group 4": 0,
    "name_group Пополнение счета": "",
    "id_owner_group 0": 0,
    "id_image 123": 0,
    "active true": false
  }
]

Кількість груп товарів

Отримати кількість груп товарів

GET /api/groupsGoods/count{?filters,ids_list,active}

Повертає кількість записів

Параметри

Параметр	Тип	Обов’язковий	Опис
ids_list	string	ні	Список значень ключового поля записів, які потрібно повернути. Зазначається через кому без пробілу
filters	string	ні	Текстові фільтри у форматі: field_name:: |field_name1::
active	string	ні	Якщо параметр дорівнює “true”, то враховуються лише активні записи.

Відповідь 200 (application/json)

{
  "count": 10
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number"
    }
  },
  "required": [
    "count"
  ]
}

Додавання групи товарів

Додати групу товарів

POST /api/groupsGoods/tree{?unprotect_keys}

• Атрибут id_group у JSON запиту ігнорується, якщо не вказано параметр unprotect_keys=true.

Параметри

Параметр	Тип	Обов’язковий	Опис
unprotect_keys	string	ні	Якщо параметр існує і дорівнює “true”, в операціях створення/редагування значення ключового поля не ігноруються

Заголовки запиту:

• Content-Type: application/json

Тіло запиту:

{
  "id_group": 4,
  "id_owner_group": 0,
  "name_group": "Алкогольные напитки",
  "active": true
}

Відповідь 201 (application/json)

{
  "id_group": 4,
  "id_owner_group": 0,
  "name_group": "Алкогольные напитки",
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_group": {
      "type": "number"
    },
    "id_owner_group": {
      "type": "number"
    },
    "name_group": {
      "type": "string"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_group",
    "id_owner_group",
    "name_group",
    "active"
  ]
}

Група товарів

Отримати групу товарів

GET /api/groupsGoods/{id_group}{?unprotect_keys}

Отримання групи товарів.

Параметри

Параметр	Тип	Обов’язковий	Опис
id_group	number	так	Код групи товарів - ціле число

Відповідь 200 (application/json)

{
  "id_group": 4,
  "id_owner_group": 0,
  "name_group": "Алкогольные напитки",
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_group": {
      "type": "number"
    },
    "id_owner_group": {
      "type": "number"
    },
    "name_group": {
      "type": "string"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_group",
    "id_owner_group",
    "name_group",
    "active"
  ]
}

Змінити групу товарів

PUT /api/groupsGoods/{id_group}{?unprotect_keys}

Зміна групи товарів.

• Атрибут id_group у JSON запиту ігнорується, якщо не вказано параметр unprotect_keys=true.

Параметри

Параметр	Тип	Обов’язковий	Опис
id_group	number	так	Код групи товарів - ціле число
unprotect_keys	string	ні	Якщо параметр існує і дорівнює “true”, в операціях створення/редагування значення ключового поля не ігноруються

Заголовки запиту:

• Content-Type: application/json

Тіло запиту:

{
  "id_group": 4,
  "id_owner_group": 0,
  "name_group": "Алкогольные напитки",
  "active": true
}

Відповідь 200 (application/json)

{
  "id_group": 4,
  "id_owner_group": 0,
  "name_group": "Алкогольные напитки",
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_group": {
      "type": "number"
    },
    "id_owner_group": {
      "type": "number"
    },
    "name_group": {
      "type": "string"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_group",
    "id_owner_group",
    "name_group",
    "active"
  ]
}

Деактивувати групу товарів

DELETE /api/groupsGoods/{id_group}{?unprotect_keys}

Деактивація групи товарів

Параметри

Параметр	Тип	Обов’язковий	Опис
id_group	number	так	Код групи товарів - ціле число

Відповідь 204