Rest API Информация о акции - datawizio/pythonAPI GitHub Wiki

39. Ресурс `/sale-info/ POST`

Информация о акции. С помощью ресурса /sale-info/ можно получить данные по продажам акционных товаров и отфильтровать по магазинам.

39.1. POST-параметры:

Название поля	Тип поля	Доступные значения	Значение по умолчанию	Описание
`format`	строка	"json", "api"	"json"	Формат ответа сервера
`shops`	число, список	-	Все магазины	Идентификатор или список идентификаторов магазинов
`sale_id`	число	-	Обязательное поле	Идентификатор акции

39.1.2. Параметры ответа:

Название поля	Тип поля	Обязательно присутствует в ответе	Описание
`product_name`	строка	да	Название акционного товара
`shop_name`	строка	да	Название магазина
`article`	строка	нет	Артикул товара
`profit`	число	да	Прибыль акционного товара за период акции
`profit_prev`	число	да	Прибыль акционного товара за предыдущий период
`profit_percent_diff`	число	да	Изменение прибыли акционного товара между предыдущим периодом и периодом акции, %
`turnover`	число	да	Оборот акционного товара за период акции
`turnover_prev`	число	да	Оборот акционного товара за предыдущий период
`turnover_percent_diff`	число	да	Изменение оборота акционного товара между предыдущим периодом и периодом акции, %
`products_qty`	число	да	Кол-во продаж акционного товара за период акции
`products_qty_prev`	число	да	Кол-во продаж акционного товара за предыдущий период
`products_qty_percent_diff`	число	да	Изменение кол-ва продаж акционного товара между предыдущим периодом и периодом акции, %
`receipts_qty`	число	да	Кол-во чеков с акционным товаром за период акции
`receipts_qty_prev`	число	да	Кол-во чеков с акционным товаром за предыдущий период*
`receipts_qty_percent_diff`	число	да	Изменение кол-ва чеков с акционным товаром между предыдущим периодом* и периодом акции, %
`original_price`	число	да	Себестоимость акционного товара
`original_price_prev`	число	да	Себестоимость акционного товара за предыдущий период*
`original_price_percent_diff`	число	да	Изменение себестоимость акционного товара между предыдущим периодом* и периодом акции, %
`price`	число	да	Продажная цена акционного товара
`price_prev`	число	да	Продажная цена акционного товара за предыдущий период*
`price_percent_diff`	число	да	Изменение продажной цены акционного товара между предыдущим периодом* и периодом акции, %
`stock_qty`	число	да	Кол-во акционного товара на остатке

*Предыдущий период:

Предыдущая дата конца выборки = Дата начала выборки - 1 день
Предыдущая дата начала выборки = Предыдущая дата конца выборки - (Дата конца выборки - Дата начала выборки)

39.2. Пример работы с ресурсом

Команда: POST http://api.datawiz.io/api/v1/sale-info/

Суффиксы (аналог параметра `format`):

.json - получить ответ с сервера в формате JSON
.api - получить ответ с сервера в формате HTML (тестовая платформа)

Пример POST-параметров:

{
  "sale_id": 12675
}

Ответ сервера:


HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
{
  "results": [
    {
      "original_price": 11.27,
      "stock_qty": 2,
      "receipts_qty_percent_diff": 0,
      "profit_percent_diff": -31.98,
      "products_qty_prev": 16,
      "price_prev": 15.7,
      "article": "35157",
      "price_percent_diff": -4.43,
      "profit": 23.65,
      "receipts_qty": 13,
      "shop_name": "Сумгаитская",
      "original_price_prev": 11.27,
      "turnover_percent_diff": -4.43,
      "receipts_qty_prev": 13,
      "price": 15,
      "products_percent_diff": 0,
      "products_qty": 16,
      "original_price_percent_diff": 0,
      "turnover_prev": 251.2,
      "product_name": "Акционный товар №2",
      "turnover": 240.08,
      "profit_prev": 34.77
    },
    {
      "original_price": 11.27,
      "stock_qty": 8,
      "receipts_qty_percent_diff": 500,
      "profit_percent_diff": 121.64,
      "products_qty_prev": 4,
      "price_prev": 17.6,
      "article": "38972",
      "price_percent_diff": -12.34,
      "profit": 36.11,
      "receipts_qty": 18,
      "shop_name": "Сумгаитская",
      "original_price_prev": 11.27,
      "turnover_percent_diff": 316.41,
      "receipts_qty_prev": 3,
      "price": 15.43,
      "products_percent_diff": 375,
      "products_qty": 19,
      "original_price_percent_diff": 0.02,
      "turnover_prev": "Акционный товар №2",
      "turnover": 293.15,
      "profit_prev": 16.29
    }
  ]
}

Rest API Информация о акции - datawizio/pythonAPI GitHub Wiki

39. Ресурс /sale-info/ POST