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