Rest API Акції - datawizio/pythonAPI GitHub Wiki
Акції. З допомогою ресурсу /sales/ можна отримати агреговані дані по акціях, відфільтрувати по даті, магазинах і т.д.
| Назва поля | Тип поля | Доступне значення | Значення за замовчуванням | Опис |
|---|---|---|---|---|
format |
рядок | "json", "api" | "json" | Формат відповіді сервера |
shops |
число, список | - | Всі магазини | Ідентифікатор чи список ідентифікаторів магазинів |
date_from |
рядок | - | Дата останньої підгрузки клієнта - 30 днів | Початкова дата вибірки |
date_to |
рядок | - | Дата останньої підгрузки клієнта | Кінцева дата вибірки |
sale_id |
число, список | - | Всі акції | Ідентифікатор чи список ідентифікаторів акцій |
active |
булевий | True, False | Всі акції | Показувати акції тільки ті, які дійсні станом на сьогоднішній день |
| Назва поля | Тип поля | Обов'язкова наявність у відповіді | Опис |
|---|---|---|---|
name |
рядок | так | Назва акції |
sale_id |
число | так | Ідентифікатор акції |
date_from |
рядок | так | Дата початку акції |
date_to |
рядок | так | Дата закінчення акції |
profit |
число | так | Прибуток акційних товарів |
profit_prev |
число | так | Прибуток акційних товарів за попередній період |
profit_prev_year |
число | так | Прибуток акційних товарів за попередній рік |
turnover |
число | так | Оборот акційних товарів |
turnover_prev |
число | так | Оборот акційних товарів за попередній період |
turnover_prev_year |
число | так | Оборот акційних товарів за попередній рік |
qty |
число | так | К-сть продажів акційних товарів |
qty_prev |
число | так | К-сть продажів акційних товарів за попередній період |
qty_prev_year |
число | так | К-сть продажів акційних товарів за попередній рік |
receipts_qty |
число | так | К-сть чеків з акційними товарами |
receipts_qty_prev |
число | так | К-сть чеків з акційними товарами за попередній період |
receipts_qty_prev_year |
число | так | К-сть чеків з акційними товарами за попередній рік |
Команда: POST http://api.datawiz.io/api/v1/sales/
-
.json- отримати відповідь з сервера в форматі JSON -
.api- отримати відповідь з сервера в форматі HTML (тестова платформа)
{
"date_from": "2018-01-01",
"date_to": "2018-01-15",
"shops": 674,
}
HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
{
"result": [
{
"receipts_qty_prev": 74,
"name": "Акція №1",
"profit": 160.7261,
"receipts_qty_prev_year": 0,
"date_from": "2018-01-03",
"sale_id": 12553,
"receipts_qty": 33,
"qty": 18.05,
"turnover_prev_year": 0,
"profit_prev": 261.6029,
"date_to": "2018-01-14",
"turnover_prev": 1754.92,
"turnover": 900.79,
"qty_prev": 37.22,
"profit_prev_year": 0,
"qty_prev_year": 0
},
{
"receipts_qty_prev": 15,
"name": "Акція №2",
"profit": 24.42,
"receipts_qty_prev_year": 0,
"date_from": "2018-01-10",
"sale_id": 12582,
"receipts_qty": 23,
"qty": 37,
"turnover_prev_year": 0,
"profit_prev": 23.04,
"date_to": "2018-01-15",
"turnover_prev": 172.8,
"turnover": 255.3,
"qty_prev": 24,
"profit_prev_year": 0,
"qty_prev_year": 0
},
{
"receipts_qty_prev": 16,
"name": "Акція №3",
"profit": 59.758,
"receipts_qty_prev_year": 0,
"date_from": "2018-01-07",
"sale_id": 12626,
"receipts_qty": 31,
"qty": 35,
"turnover_prev_year": 0,
"profit_prev": 51.0601,
"date_to": "2018-01-14",
"turnover_prev": 321.6,
"turnover": 533.23,
"qty_prev": 20,
"profit_prev_year": 0,
"qty_prev_year": 0
}
]
}