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

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

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

GET /api/goodsLists{?active,order,filters,ids_list,offset,limit,unprotect_keys}

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

Параметри

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

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

[
  {
    "id_dcard_type": 1,
    "name": "Card type one",
    "active": true
  }
]

Додати список товарів

POST /api/goodsLists{?active,order,filters,ids_list,offset,limit,unprotect_keys}

Додавання списку товарів.

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

Параметри

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

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

• Content-Type: application/json

Тіло запиту:

{
  "id_goods_list": 1,
  "name": "Goods list name",
  "active": true
}

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

{
  "id_goods_list": 1,
  "name": "Goods list name",
  "active": true
}

Схема:

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

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

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

GET /api/goodsLists/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"
  ]
}

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

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

GET /api/goodsLists/{id_goods_list}/{?unprotect_keys}

Отримання даних про тип дисконтної картки

Параметри

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

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

{
  "id_goods_list": 1,
  "name": "Goods list name",
  "active": true
}

Схема:

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

Змінити дані про список товарів

PUT /api/goodsLists/{id_goods_list}/{?unprotect_keys}

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

Параметри

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

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

• Content-Type: application/json

Тіло запиту:

{
  "id_goods_list": 1,
  "name": "Goods list name",
  "active": true
}

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

{
  "id_goods_list": 1,
  "name": "Goods list name",
  "active": true
}

Схема:

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

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

DELETE /api/goodsLists/{id_goods_list}/{?unprotect_keys}

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

Параметри

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

Відповідь 204