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** ⚠️