Складені товари

Склад складених товарів

Отримати список товарів складених товарів

GET /api/contain/{?id_contain_goods,with,active,filters,order,offset,limit}

Отримання вмісту складених товарів.

Параметри

Параметр

Тип

Обов’язковий

Опис

id_contain_goods

integer

ні

Код складеного товару

with

string

ні

Повʼязані дані. Можливі звʼязки: containGoods, goods, unit, series, price_income. Назви звʼязків вказуються через кому без пробілів.

active

string

ні

Якщо параметр дорівнює “true”, то повертаються лише активні записи.

filters

string

ні

Рядок формату field_name::filter|field_nameN::filterN. Фільтрація записів. Виконується текстове порівняння.

order

string

ні

Список полів сортування через кому без пробілів

offset

integer

ні

Повертати дані, починаючи з указаного номера запису

limit

integer

ні

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

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

[
  {
    "id_contain_goods": 1,
    "id_unit": 1,
    "id_series": "-",
    "quantity": 10,
    "active": true
  }
]

Додати товар до складеного товару

POST /api/contain/{?id_contain_goods,with,active,filters,order,offset,limit}

Додавання нового товару до вмісту складеного товару

Параметри

Параметр

Тип

Обов’язковий

Опис

id_contain_goods

integer

так

Код складеного товару

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

  • Content-Type: application/json

Тіло запиту:

{
  "id_contain_goods": 1,
  "id_unit": 1,
  "id_series": "-",
  "quantity": 10,
  "active": true
}

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

{
  "id_goods": 5,
  "id_series": "1",
  "name_series": "Синие",
  "active": true
}

Схема:

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

Кількість записів товарів у складеному товарі

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

GET /api/contain/count/{?id_contain_goods,active,filters}

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

Параметри

Параметр

Тип

Обов’язковий

Опис

id_contain_goods

integer

так

Код складеного товару

active

string

ні

Якщо параметр дорівнює “true”, то повертаються лише активні записи.

filters

string

ні

Рядок формату field_name::filter|field_nameN::filterN. Фільтрація записів. Виконується текстове порівняння.

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

{
  "count": 10
}

Схема:

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

Товар у складеному товарі

Отримати дані про товар у складеному товарі

GET /api/contain/{id_contain_goods}/{id_goods}/{id_unit}/{id_series}{?unprotect_keys,with}

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

Параметри

Параметр

Тип

Обов’язковий

Опис

id_contain_goods

integer

так

Код складеного товару

with

string

ні

Повʼязані дані. Можливі звʼязки: containGoods, goods, unit, series, price_income. Назви звʼязків вказуються через кому без пробілів.

id_goods

integer

так

Код товару в складі

id_unit

integer

так

Код одиниці виміру

id_series

string

так

Код серії

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

{
  "id_contain_goods": 1,
  "id_unit": 1,
  "id_series": "-",
  "quantity": 10,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_contain_goods": {
      "type": "number"
    },
    "id_unit": {
      "type": "number"
    },
    "id_series": {
      "type": "string"
    },
    "quantity": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_contain_goods",
    "id_unit",
    "id_series",
    "quantity",
    "active"
  ]
}

Змінити дані про товар у складі складеного товару

PUT /api/contain/{id_contain_goods}/{id_goods}/{id_unit}/{id_series}{?unprotect_keys,with}

Зміна даних про товар у складеному товарі

Параметри

Параметр

Тип

Обов’язковий

Опис

id_contain_goods

integer

так

Код складеного товару (частина ключа)

id_goods

integer

так

Код товару в складі (частина ключа)

id_unit

integer

так

Код одиниці виміру (частина ключа)

id_series

string

так

Код серії (частина ключа)

unprotect_keys

string

ні

Якщо параметр існує і дорівнює “true”, значення ключових полів не ігноруються

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

  • Content-Type: application/json

Тіло запиту:

{
  "id_goods": 5,
  "id_series": "1",
  "name_series": "Синие",
  "active": true
}

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

{
  "id_goods": 5,
  "id_series": "1",
  "name_series": "Синие",
  "active": true
}

Схема:

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

Деактивувати товар у складі складеного товару

DELETE /api/contain/{id_contain_goods}/{id_goods}/{id_unit}/{id_series}{?unprotect_keys,with}

Деактивація запису про товар у складі складеного товару

Параметри

Параметр

Тип

Обов’язковий

Опис

id_contain_goods

integer

так

Код складеного товару

id_goods

integer

так

Код товару в складі

id_unit

integer

так

Код одиниці виміру

id_series

string

так

Код серії

Відповідь 204