Серії

Список серій

Отримати всі серії

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

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

Параметри

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

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

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

Додати серію для товару

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

Додавання нової серії для товару.

• Атрибути id_goods, id_series у JSON-і запиту ігноруються, якщо не вказано параметр unprotect_keys=true. Значення id_series буде встановлено автоматично. Значення id_goods передається відповідним параметром.

• Додавання запису серії за замовчуванням (“-”) відбувається автоматично при створенні нового товару.

Параметри

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

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

• Content-Type: application/json

Тіло запиту:

{
  "id_goods": 5,
  "id_series": "1",
  "name_series": "Синие",
  "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/series/count{?id_goods,active}

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

Параметри

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

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

{
  "count": 10
}

Схема:

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

Серія

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

GET /api/series/{id_goods}/{id_series}{?unprotect_keys}

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

Параметри

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

Відповідь 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"
  ]
}

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

PUT /api/series/{id_goods}/{id_series}{?unprotect_keys}

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

Параметри

Параметр	Тип	Обов’язковий	Опис
id_goods	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/series/{id_goods}/{id_series}{?unprotect_keys}

Деактивація даних про серію

Параметри

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

Відповідь 204