Ціни

Список цін

Отримати всі ціни

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

Параметри

Параметр

Тип

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

Опис

id_goods

integer

ні

Код товару. Якщо вказати, буде повернено список цін для конкретного товару

active

string

ні

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

order

string

ні

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

offset

integer

ні

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

limit

integer

ні

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

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

[
  {
    "id_goods": 1,
    "id_unit": 1,
    "id_series": "-",
    "id_price_level": 1,
    "price": 100,
    "min_price": 0,
    "max_price": 0,
    "active": true
  }
]

Додати ціну

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

Ключові атрибути id_goods, id_unit, id_price_level, id_series в JSON-і запиту стандартно ігноруються. Щоб додати ціну, використовуйте параметр unprotect_keys=true і вказуйте значення ключових полів у тілі запиту.

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

  • Content-Type: application/json

Тіло запиту:

{
  "id_goods": 1,
  "id_unit": 1,
  "id_series": "-",
  "id_price_level": 1,
  "price": 100,
  "min_price": 0,
  "max_price": 0,
  "active": true
}

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

{
  "id_goods": 1,
  "id_unit": 1,
  "id_series": "-",
  "id_price_level": 1,
  "price": 100,
  "min_price": 0,
  "max_price": 0,
  "active": true
}

Схема:

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

Кількість цін

Отримати кількість цін

GET /api/prices/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/price/{id_goods}/{id_unit}/{id_price_level}/{?id_series}

Параметр id_series опускається, якщо використовується значення серії за замовчуванням “-”.

Параметри

Параметр

Тип

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

Опис

id_goods

integer

так

Код товару

id_unit

integer

так

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

id_price_level

integer

так

Код рівня цін

id_series

string

ні

Код серії. Якщо не вказано, передбачається “-”

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

{
  "id_goods": 1,
  "id_unit": 1,
  "id_series": "-",
  "id_price_level": 1,
  "price": 100,
  "min_price": 0,
  "max_price": 0,
  "active": true
}

Схема:

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

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

PUT /api/price/{id_goods}/{id_unit}/{id_price_level}/{?id_series}

Ключові атрибути id_goods, id_unit, id_price_level, id_series у JSON-і запиту стандартно ігноруються.

Параметри

Параметр

Тип

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

Опис

id_goods

integer

так

Код товару

id_unit

integer

так

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

id_price_level

integer

так

Код рівня цін

id_series

string

ні

Код серії. Якщо не вказано, передбачається “-”

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

  • Content-Type: application/json

Тіло запиту:

{
  "id_goods": 1,
  "id_unit": 1,
  "id_series": "-",
  "id_price_level": 1,
  "price": 100,
  "min_price": 0,
  "max_price": 0,
  "active": true
}

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

{
  "id_goods": 1,
  "id_unit": 1,
  "id_series": "-",
  "id_price_level": 1,
  "price": 100,
  "min_price": 0,
  "max_price": 0,
  "active": true
}

Схема:

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

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

DELETE /api/price/{id_goods}/{id_unit}/{id_price_level}/{?id_series}

Відповідь 204