Сводка каталога промокодов площадки

Сколько кодов доступно к выдаче (available), уже выдано (realized), погашено (redeemed) — только в рамках вашего каталога.

Зачем нужен метод

Сколько кодов доступно к выдаче (available), уже выдано (realized), погашено (redeemed) — только в рамках вашего каталога.

Когда использовать

Дашборд закупок/маркeting перед акцией.

Эндпоинт

POST /v1/platform/catalog/summary

Аутентификация: API-ключ в заголовке X-Api-Key (префикс bk_plt_). projectId и actor id в body не передаются — берутся из ключа.

Scope: platform:catalog:read

Пример запроса

{
  "meta": { "requestId": "optional-uuid" },
  "data": { "supplierId": "optional-filter-uuid" }
}

Пример ответа

{
  "success": true,
  "data": {
    "platformId": "platform-uuid",
    "byStatus": { "available": 85000, "realized": 12000, "redeemed": 9800 },
    "totalInCatalog": 107700,
    "asOf": "2026-07-13T12:00:00Z"
  }
}

Ошибки

UNAUTHORIZED / ACCESS_DENIED — нет доступа
VALIDATION_ERROR — некорректное тело
NOT_FOUND — сущность не найдена
RATE_LIMIT_EXCEEDED (429) — превышен лимит

cURL

curl -X POST "https://api-external.promanta.ru/v1/platform/catalog/summary" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{"data": { "supplierId": "optional-filter-uuid" }}'