`get.reports.mid_chek` — Покупці та середній чек

get.reports.mid_chek — Покупці та середній чек

Призначення

Повертає «покупці та середній чек» за період на базі шаблонів із Itog_reports (група mid_chek).

Авторизація

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

Параметри params

ПолеТипОбов’язковоОпис
date_from string так Дата початку (YYYY-MM-DD).
date_to string так Дата кінця (YYYY-MM-DD).

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

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

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

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

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

{
  "ok": true,
  "result": {
    "period": {
      "from": "2026-01-01",
      "to": "2026-01-31"
    },
    "year_hint": "2026",
    "items": [
      {
        "ind": 1,
        "title": "Кількість чеків",
        "value": 321
      },
      {
        "ind": 2,
        "title": "Середній чек",
        "value": 210.5
      }
    ],
    "count": 2
  },
  "meta": {
    "api_version": "0.1.0",
    "ts": "2026-01-26T12:00:00+00:00"
  },
  "id": "report-mid-chek-001"
}

Примітки

  • Поле year_hint у відповіді — це рік з date_from. Якщо діапазон перетинає роки, краще робити два запити окремо.

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

  • MISSING_DATE_RANGE
  • INVALID_DATE
  • NO_DATA

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