Каталог промокодов для выдачи

Список кодов, которые площадка может выдать клиенту (status available по catalog rules).

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

Список кодов, которые площадка может выдать клиенту (status available по catalog rules). Для больших объёмов предпочитайте changes.

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

Ручной выбор кода, небольшие каталоги, админ-UI площадки.

Эндпоинт

POST /v1/platform/promo-codes/list

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

Scope: platform:catalog:read

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

{
  "meta": { "requestId": "optional-uuid" },
  "data": { "page": 1, "pageSize": 100, "status": "available", "supplierId": "optional", "maskCode": true }
}

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

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "code-uuid",
        "codeDisplay": "8462003***017",
        "status": "available",
        "supplierName": "Эркафарм",
        "validUntil": "2026-08-31T23:59:59Z"
      }
    ],
    "totalCount": 85000
  }
}

Ошибки

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

cURL

curl -X POST "https://api-external.promanta.ru/v1/platform/promo-codes/list" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{"data": { "page": 1, "pageSize": 100, "status": "available", "supplierId": "optional", "maskCode": true }}'