Золотенков
Выпустить ключ

Продажи за период

GET https://mrp.zolotenkov.ru/api/external/v1/reports/sales-summary

Требуемое право ключа: read:sales

Один запрос вместо постраничной вычитки всех отгрузок: выручка, себестоимость, прибыль и количество, сложенные по товару и по периоду. Продажа попадает в период по дате отгрузки, проведенный возврат — по дате возврата и со знаком минус, поэтому revenue уже очищена от возвратов.

Числа совпадают с разделом «Аналитика - Продажи» того же тенанта за тот же период: срез считается по тому же потоку операций, а не пересчитывается отдельно.

Ручка отнесена к дорогим операциям: она обходит все документы периода, и ее частотный предел строже, чем у списков. У обхода есть предел времени: срез, не уложившийся в него, отвечает 400 с просьбой сузить выборку.

Право read:sales вместе с этой ручкой отдает наружу себестоимость (cogs) и маржу (profit).

Параметры запроса

  • from строка обязателен

    Первый день периода, календарная дата 2026-01-01, зона Europe/Moscow

  • to строка обязателен

    Последний день периода, включительно. Период не длиннее 366 суток, считая обе границы

  • group_by строка необязателен

    Нарезка периода: month (по умолчанию), week, day или total — весь период одной строкой на товар

  • storage_place_id целое число необязателен

    Только отгрузки с этого места хранения. Номер отдает GET /storage-places

  • item_id целое число необязателен

    Только этот товар, со всеми его вариантами

  • category_id целое число необязателен

    Только товары этой категории

  • country_code строка необязателен

    Страны заказа через запятую, ISO-3166-1 alpha-2, не больше 50 кодов

  • limit целое число необязателен

    Сколько строк вернуть: от 1 до 1000, по умолчанию 200

Ответы

  • 200 Срез продаж за период
  • 400 Недопустимое значение параметра выборки
  • 401 Ключ не передан, недействителен или отозван
  • 403 У ключа нет права read:sales
  • 429 Превышена частота обращений. Задержка до повтора — в заголовке Retry-After