Rest API Продажи категорий - datawizio/pythonAPI GitHub Wiki

33. Ресурс /get_categories_sale/ POST

Продажи категорий. С помощью ресурса /get_categories_sale/ можно получить данные по продажам категорий, сгруппировать результат по дням (неделям, месяцам) и отфильтровать по дате, магазинам и категориям.

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

Название поля Тип поля Доступные значения Значение по умолчанию Описание
format строка "json", "api" "json" Формат ответа сервера
categories число, список - Все категории Идентификатор или список идентификаторов категорий, по которым осуществлять выборку
shops число, список - Все магазины Идентификатор или список идентификаторов категорий, по которым осуществлять выборку
weekday число 0, 1, 2, 3, 4, 5, 6 Все дни недели День недели, по которому осуществлять выборку (Понедельник - 0, Воскресенье - 6)
date_from строка - Дата последней подгрузки клиента - 30 дней Начальная дата выборки
date_to строка - Дата последней подгрузки клиента Конечная дата выборки
interval строка "days", "months", "weeks", "years" "days" Интервал для группировки результата
select строка, список "turnover", "qty", "profit", "sold_product_value", "receipts_qty", "stock_qty", "stock_value", "avg_receipt", "turnover_rate", "availability_sale", "availability_stock" "turnover" Показатели, по которым осуществлять выборку
per_shop булевый True, False False Группировка результата по магазина

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

Название поля Тип поля Обязательно присутствует в ответе Описание
date строка да Дата, за которую осуществилась выборка
category число да Идентификатор категории, по которой осуществлялась выборка
name строка да Название категории, по которой осуществлялась выборка
shop число нет Идентификатор магазина, по которому осуществлялась выборка
shop_name строка нет Название магазина, по которому осуществлялась выборка
turnover число нет Оборот категории
qty число нет Кол-во продаж категории
profit число нет Прибыль категории
sold_product_value число нет Себестоимость проданных товаров категории
receipts_qty число нет Кол-во чеков, в которых встречается категория
avg_receipt число нет Средний чек категории
stock_value число нет Себестоимость товаров категории на остатке
turnover_rate число нет Оборачиваемость ден. ед.
availability_sale число нет Доступность продаж категории
availability_stock число нет Доступность остатков категории

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

Команда: POST http://api.datawiz.io/api/v1/get_categories_sale/

Суффиксы (аналог параметра format):
  • .json - получить ответ с сервера в формате JSON
  • .api - получить ответ с сервера в формате HTML (тестовая платформа)
Пример POST-параметров:
{
  "categories": [68498, 65391],
  "shops": 674,
  "date_from": "2018-01-01",
  "date_to": "2018-01-15",
  "select": ["turnover_rate", "availability_sale"],
}
Ответ сервера:

HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
{
  "results": [
    {
      "date": "2018-01-01",
      "category": 68498,
      "availability_sale": 37.79,
      "name": "SNACKS",
      "turnover_rate": 18.02
    },
    {
      "date": "2018-01-01",
      "category": 65391,
      "availability_sale": 21.19,
      "name": "GROCERY",
      "turnover_rate": 19.03
    },
    {
      "date": "2018-01-02",
      "category": 68498,
      "availability_sale": 27.76,
      "name": "SNACKS",
      "turnover_rate": 23.12
    },
    {
      "date": "2018-01-02",
      "category": 65391,
      "availability_sale": 23.73,
      "name": "GROCERY",
      "turnover_rate": 21.43
    },
    {
      "date": "2018-01-14",
      "category": 68498,
      "availability_sale": 23.86,
      "name": "SNACKS",
      "turnover_rate": 16.45
    },
    {
      "date": "2018-01-14",
      "category": 65391,
      "availability_sale": 29.79,
      "name": "GROCERY",
      "turnover_rate": 18.14
    },
    {
      "date": "2018-01-15",
      "category": 68498,
      "availability_sale": 34.13,
      "name": "SNACKS",
      "turnover_rate": 18.34
    },
    {
      "date": "2018-01-15",
      "category": 65391,
      "availability_sale": 31.79,
      "name": "GROCERY",
      "turnover_rate": 19.02
    }
  ]
}
Пример POST-параметров:
{
  "categories": [68498],
  "shops": [674, 541],
  "date_from": "2018-01-01",
  "date_to": "2018-01-01",
  "select": "turnover",
  "per_shop": true
}
Ответ сервера:

HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
{
  "results": [
    {
      "category": 68498,
      "shop": 674,
      "name": "SNACKS",
      "shop_name": "Shop #1",
      "date": "2018-01-01",
      "turnover": 590.84
    },
    {
      "category": 68498,
      "shop": 541,
      "name": "ICE CREAM",
      "shop_name": "Shop #2",
      "date": "2018-01-01",
      "turnover": 152.74
    },
    {
      "category": 68498,
      "shop": 674,
      "name": "SNACKS",
      "shop_name": "Shop #1",
      "date": "2018-01-01",
      "turnover": 608.95
    },
    {
      "category": 68498,
      "shop": 541,
      "name": "ICE CREAM",
      "shop_name": "Shop #2",
      "date": "2018-01-01",
      "turnover": 162.31
    }
  ]
}
Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️