Одиниці виміру

Список одиниць виміру для товару

Отримати всі одиниці виміру

GET /api/units{?id_goods,active,order,offset,limit}

Отримання списку всіх одиниць виміру. Якщо вказано параметр id_goods, повертаються одиниці виміру для конкретного товару

Параметри

Параметр	Тип	Обов’язковий	Опис
id_goods	integer	ні	Код товару. Якщо вказано, повертаються одиниці виміру лише для цього товару
active	string	ні	Якщо параметр дорівнює “true”, то повертаються лише активні записи.
order	string	ні	Список полів сортування через кому без пробілів
offset	integer	ні	Повертати дані, починаючи з указаного номера запису
limit	integer	ні	Повертати вказану кількість записів

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

[
  {
    "id_goods": 1,
    "id_unit": 1,
    "name_unit": "шт",
    "is_default": false,
    "rate": 1,
    "type_unit": 3,
    "max_count": 0,
    "active": true
  }
]

Додати одиницю виміру

POST /api/units{?id_goods,active,order,offset,limit}

Додавання одиниці виміру. Атрибут id_unit у JSON запиту стандартно ігнорується і заповнюється автоматично. Для вказання вручну потрібно використати параметр unprotect_keys=true.

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

• Content-Type: application/json

Тіло запиту:

{
  "id_goods": 1,
  "id_unit": 1,
  "name_unit": "шт",
  "is_default": false,
  "rate": 1,
  "type_unit": 3,
  "max_count": 0,
  "active": true
}

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

{
  "id_goods": 1,
  "id_unit": 1,
  "name_unit": "шт",
  "is_default": false,
  "rate": 1,
  "type_unit": 3,
  "max_count": 0,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_goods": {
      "type": "number"
    },
    "id_unit": {
      "type": "number"
    },
    "name_unit": {
      "type": "string"
    },
    "is_default": {
      "type": "boolean"
    },
    "rate": {
      "type": "number"
    },
    "type_unit": {
      "type": "number"
    },
    "max_count": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_goods",
    "id_unit",
    "name_unit",
    "is_default",
    "rate",
    "type_unit",
    "max_count",
    "active"
  ]
}

Кількість одиниць виміру

Отримати кількість одиниць виміру

GET /api/units/count{?id_goods,active,order}

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

Параметри

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

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

{
  "count": 10
}

Схема:

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

Одиниця виміру

Отримати дані про одиницю виміру

GET /api/units/{id_goods}/{id_unit}

Отримання даних про одиницю виміру за кодом товару та кодом одиниці виміру

Параметри

Параметр	Тип	Обов’язковий	Опис
id_goods	integer	так	Код товару
id_unit	integer	так	Код одиниці виміру

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

{
  "id_goods": 1,
  "id_unit": 1,
  "name_unit": "шт",
  "is_default": false,
  "rate": 1,
  "type_unit": 3,
  "max_count": 0,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_goods": {
      "type": "number"
    },
    "id_unit": {
      "type": "number"
    },
    "name_unit": {
      "type": "string"
    },
    "is_default": {
      "type": "boolean"
    },
    "rate": {
      "type": "number"
    },
    "type_unit": {
      "type": "number"
    },
    "max_count": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_goods",
    "id_unit",
    "name_unit",
    "is_default",
    "rate",
    "type_unit",
    "max_count",
    "active"
  ]
}

Змінити дані про одиницю виміру

PUT /api/units/{id_goods}/{id_unit}

Зміна даних про одиницю виміру. Атрибути id_goods, id_unit у JSON запиту стандартно ігноруються.

Параметри

Параметр	Тип	Обов’язковий	Опис
id_goods	integer	так	Код товару
id_unit	integer	так	Код одиниці виміру

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

• Content-Type: application/json

Тіло запиту:

{
  "id_goods": 1,
  "id_unit": 1,
  "name_unit": "шт",
  "is_default": false,
  "rate": 1,
  "type_unit": 3,
  "max_count": 0,
  "active": true
}

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

{
  "id_goods": 1,
  "id_unit": 1,
  "name_unit": "шт",
  "is_default": false,
  "rate": 1,
  "type_unit": 3,
  "max_count": 0,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_goods": {
      "type": "number"
    },
    "id_unit": {
      "type": "number"
    },
    "name_unit": {
      "type": "string"
    },
    "is_default": {
      "type": "boolean"
    },
    "rate": {
      "type": "number"
    },
    "type_unit": {
      "type": "number"
    },
    "max_count": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_goods",
    "id_unit",
    "name_unit",
    "is_default",
    "rate",
    "type_unit",
    "max_count",
    "active"
  ]
}

Деактивувати дані про одиницю виміру

DELETE /api/units/{id_goods}/{id_unit}

Параметри

Параметр	Тип	Обов’язковий	Опис
id_goods	integer	так	Код товару
id_unit	integer	так	Код одиниці виміру

Відповідь 204

Список типів одиниць виміру

Отримати всі типи одиниць виміру

GET /api/typesUnits

Отримання списку типів одиниць виміру товарів.

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

[
  {
    "type_unit": 2,
    "name": "Кратное 25%"
  }
]