Promo catalog for fulfillment

List of available catalog codes; prefer changes for scale.

Why this method exists

List of available catalog codes; prefer changes for scale.

When to use

Manual pick, small catalogs.

Endpoint

POST /v1/platform/promo-codes/list

Authentication: X-Api-Key header (prefix bk_plt_). Do not send projectId or actor id in body — they come from the key.

Scope: platform:catalog:read

Request example

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

Response example

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

Errors

UNAUTHORIZED / ACCESS_DENIED — access denied
VALIDATION_ERROR — invalid body
NOT_FOUND — resource not found
RATE_LIMIT_EXCEEDED (429) — rate limit

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 }}'