Rest API Продажи товаров - datawizio/pythonAPI GitHub Wiki

34. Ресурс /get_products_sale/ POST

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

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

Название поля Тип поля Доступные значения Значение по умолчанию Описание
format строка "json", "api" "json" Формат ответа сервера
products число, список - Все товары Идентификатор или список идентификаторов товаров
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", "self_price_per_product", "price" "turnover" Показатели, по которым осуществлять выборку

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

Название поля Тип поля Обязательно присутствует в ответе Описание
date строка да Дата, за которую осуществилась выборка
product число да Идентификатор товара, по которому осуществлялась выборка
name строка да Название товара, по которому осуществлялась выборка
turnover число нет Оборот товара
qty число нет Кол-во продаж товара
profit число нет Прибыль товара
sold_product_value число нет Себестоимость проданного товара
self_price_per_product число нет Себестоимость товара
price число нет Продажная цена товара

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

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

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

HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
{
  "results": [
    {
      "date": "2018-01-01",
      "product": 2837768,
      "name": "Sunflower seeds Chumak Sunflower Seeds Roasted 150g",
      "profit": 28.78
    },
    {
      "date": "2018-01-01",
      "product": 2867868,
      "name": "Flint crackers wheat-rye with sour Cream and Herbs 130g",
      "profit": 56.34
    },
    {
      "date": "2018-01-15",
      "product": 2364568,
      "name": "Sunflower San Sanych Sunflower Seeds Roasted 15g",
      "profit": 13.53
    },
    {
      "date": "2018-01-15",
      "product": 2834578,
      "name": "Peanuts are moderately salty with the bacon 60g",
      "profit": 334.56
    }
  ]
}
Пример POST-параметров:
{
  "products": [2345737],
  "shops": [674, 541],
  "date_from": "2018-01-01",
  "date_to": "2018-01-01",
  "select": "turnover",
}
Ответ сервера:

HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
{
  "results": [
    {
      "product": 2345737,
      "name": "Sunflower seeds Chumak Sunflower Seeds Roasted 150g",
      "date": "2018-01-01",
      "turnover": 590.84,
      "qty": 8
    }
  ]
}
Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️