Rest API Динамика акций - datawizio/pythonAPI GitHub Wiki

40. Ресурс /sale-dynamics/ POST

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

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

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

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

Название поля Тип поля Обязательно присутствует в ответе Описание
date строка да Дата выборки
name строка да Название акции
turnover число нет Оборот акционных товаров
receipts_qty число нет Кол-во чеков с акционными товарами

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

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

Суффиксы (аналог параметра format):
  • .json - получить ответ с сервера в формате JSON
  • .api - получить ответ с сервера в формате HTML (тестовая платформа)
Пример POST-параметров:
{
  "sale_id": [1267, 245],
  "shops": 12
}
Ответ сервера:

HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
{
  "results": [
    {
      "date": "2018-02-16",
      "name": "Акция №1",
      "receipts_qty": 2,
      "turnover": 23.38
    },
    {
      "date": "2018-02-17",
      "name": "Акция №1",
      "receipts_qty": 11,
      "turnover": 128.59
    },
    {
      "date": "2018-02-18",
      "name": "Акция №1",
      "receipts_qty": 7,
      "turnover": 81.83
    },
    {
      "date": "2018-02-19",
      "name": "Акция №1",
      "receipts_qty": 4,
      "turnover": 46.76
    },
    {
      "date": "2018-02-20",
      "name": "Акция №1",
      "receipts_qty": 1,
      "turnover": 11.69
    },
    {
      "date": "2018-02-22",
      "name": "Акция №2",
      "receipts_qty": 1,
      "turnover": 11.69
    },
    {
      "date": "2018-02-23",
      "name": "Акция №2",
      "receipts_qty": 1,
      "turnover": 11.69
    },
    {
      "date": "2018-02-24",
      "name": "Акция №2",
      "receipts_qty": 5,
      "turnover": 70.14
    },
    {
      "date": "2018-02-25",
      "name": "Акция №2",
      "receipts_qty": 2,
      "turnover": 23.38
    },
    {
      "date": "2018-02-26",
      "name": "Акция №2",
      "receipts_qty": 1,
      "turnover": 40.28
    },
    {
      "date": "2018-02-27",
      "name": "Акция №2",
      "receipts_qty": 1,
      "turnover": 45.75
    }
  ]
}
⚠️ **GitHub.com Fallback** ⚠️