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