`get.reports.sales_by_category_detailed` — Продажі по категоріях (детально)

get.reports.sales_by_category_detailed — Продажі по категоріях (детально)

Призначення

Повертає агреговані продажі по категоріях за період.

Авторизація

  • Логін/пароль: так.
  • meta.user_card: обов’язково.

Параметри params

Поле Тип Обовʼязково Опис

| date_from | string | так | Дата початку, формат YYYY-MM-DD. |

| date_to | string | так | Дата кінця, формат YYYY-MM-DD. |

| limit | int | ні | Кількість рядків. За замовчуванням 100, максимум 5000. |

| offset | int | ні | Зсув для пагінації. |

| filters | object | ні | Точні фільтри. Дозволені поля наведені нижче. |

Дозволені поля у filters

Cat, Kas, User

Приклад запиту

Мокап: mockups/reports/get.reports.sales_by_category_detailed/request.json

{
  "auth": {
    "login": "<LOGIN>",
    "password": "<PASSWORD>"
  },
  "method": "get.reports.sales_by_category_detailed",
  "params": {
    "date_from": "2026-01-01",
    "date_to": "2026-01-31",
    "limit": 100,
    "offset": 0
  },
  "meta": {
    "user_card": "<USER_CARD>",
    "client_name": "MyIntegration",
    "client_version": "1.0.0"
  },
  "id": "report-sales_by_category_detailed-001"
}

Приклад відповіді (успіх)

Мокап: mockups/reports/get.reports.sales_by_category_detailed/response.ok.json

{
  "ok": true,
  "result": {
    "items": [
      {
        "...": "..."
      }
    ]
  },
  "meta": {
    "api_version": "0.1.0",
    "ts": "2026-01-26T12:00:00+00:00"
  },
  "id": "report-sales_by_category_detailed-001"
}

Примітки

  • Деталізація відповіді відповідає логіці в ReportRepository::salesByCategoryDetailed().

Типові помилки

  • MISSING_DATE_RANGE — не передали date_from/date_to.

  • INVALID_DATE — неправильний формат дати (має бути YYYY-MM-DD).

  • NO_DATA — немає даних/таблиць для цього діапазону.

  • INVALID_FILTERS — неправильний filters.

На цій сторінці