Rest API Остатки по категориям - datawizio/pythonAPI GitHub Wiki

35. Ресурс /categories-stock/ POST

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

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

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

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

Название поля Тип поля Обязательно присутствует в ответе Описание
date строка да Дата, за которую осуществилась выборка
category число да Идентификатор категории, по которой осуществлялась выборка
name строка да Название категории, по которой осуществлялась выборка
stock_qty число нет Кол-во товаров категории на остатке
stock_value число нет Себестоимость товаров категории на остатке

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

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

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

HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
{
  "result": [
    {
      "date": "2018-01-01",
      "category": 68498,
      "name": "SNACKS",
      "stock_qty": 38
    },
    {
      "date": "2018-01-01",
      "category": 65391,
      "name": "GROCERY",
      "stock_qty": 219.04
    },
    {
      "date": "2018-01-02",
      "category": 68498,
      "name": "SNACKS",
      "stock_qty": 34.34
    },
    {
      "date": "2018-01-02",
      "category": 65391,
      "name": "GROCERY",
      "stock_qty": 13.3
    },
    {
      "date": "2018-01-14",
      "category": 68498,
      "name": "SNACKS",
      "stock_qty": 16
    },
    {
      "date": "2018-01-14",
      "category": 65391,
      "availability_sale": 29.79,
      "name": "GROCERY",
      "stock_qty": 18.45
    },
    {
      "date": "2018-01-15",
      "category": 68498,
      "name": "SNACKS",
      "stock_qty": 18.34
    },
    {
      "date": "2018-01-15",
      "category": 65391,
      "name": "GROCERY",
      "stock_qty": 19.02
    }
  ]
}
Пример POST-параметров:
{
  "categories": [68498],
  "shops": [674, 541],
  "date_from": "2018-01-01",
  "date_to": "2018-01-01",
  "select": "stock_value",
}
Ответ сервера:

HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
{
  "result": [
    {
      "category": 68498,
      "name": "SNACKS",
      "date": "2018-01-01",
      "stock_qty": 590.84
    }
  ]
}
Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️