Rest API Продажі програми лояльності - datawizio/pythonAPI GitHub Wiki

36. Ресурс /loyalty-sales/ POST

Продажі програми лояльності. З допомогою ресурсу /loyalty-sales/ можна отримати дані по продажах програми лояльності.

36.1. POST-параметри:

Назва поля Тип поля Доступні значення Значення за замовчуванням Опис
format рядок "json", "api" "json" Формат відповіді сервера
shops число, список - Всі магазини Ідентифікатор чи список ідентифікаторів категорій, по яких здійснювати вибірку
date_from рядок - Дата останньої підгрузки клієнта - 30 днів Початкова дата вибірки
date_to рядок - Дата останньої підгрузки клієнта Кінцева дата вибірки

36.1.2. Параметри відповіді:

Назва поля Тип поля Обов'язкова наявність у відповіді Опис
dt рядок так Дата, за яку здійснювалась вибірка
new_clients число так К-сть нових клієнтів
male_percent рядок так Відсоток чоловіків
conversion число ні Відсоток продажів програми лояльності від загальної к-сті продажів
turnover рядок ні Оборот програми лояльності
profit число ні Прибуток програми лояльності
receipts_qty число ні К-сть чеків програми лояльності

36.2. Приклад роботи з ресурсом

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

Суфікси (аналог параметра format):
  • .json - отримати відповідь з сервера в форматі JSON
  • .api - отримати відповідь з сервера в форматі HTML (тестова платформа)
Приклад POST-параметрів:
{
  "date_from": "2018-01-01",
  "date_to": "2018-01-15",
}
Відповідь сервера:

HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
{
  "result": [
    {
      "conversion": 3.03,
      "profit": 456.45,
      "male_percent": 4.33,
      "new_clients": 1,
      "receipts_qty": 716,
      "dt": "2018-01-01",
      "turnover": 16801.57
    },
    {
      "conversion": 4.13,
      "profit": 543.34,
      "male_percent": 4.53,
      "new_clients": 5,
      "receipts_qty": 123,
      "dt": "2018-01-02",
      "turnover": 13581.57
    },
    ...
    {
      "conversion": 3.03,
      "profit": 34,
      "male_percent": 7.33,
      "new_clients": 1,
      "receipts_qty": 76,
      "dt": "2018-01-14",
      "turnover": 5467.57
    },
    {
      "conversion": 3.56,
      "profit": 667.45,
      "male_percent": 7.43,
      "new_clients": 2,
      "receipts_qty": 716,
      "dt": "2018-01-15",
      "turnover": 26851.57
    }
  ]
}
⚠️ **GitHub.com Fallback** ⚠️