# Опубликованные продукты

`GET /catalog/products`

**operationId:** `listProducts`

Список provider_offerings со status=published и product_id, по sort_order. uuid относится к предложению; в quotes используйте resource_uuid. Цены не возвращаются: рассчитывайте через POST /quotes. Каталог не проверяет наличие test-интеграции; test заказы хостинга запрещены. Пагинация cursor/per_page (по умолчанию 25, фактически ограничивается 1..100). Не поддерживаются page, offset, sort, include и произвольные фильтры. При следующем запросе передавайте исходные фильтры вместе с cursor; ссылки не гарантируют сохранение фильтров.

**Scopes:** `catalog.read`

## Параметры

### cursor

Расположение: `query`. Необязательный. Непрозрачное значение meta.next_cursor. На первой странице не передаётся; не конструируйте вручную.


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | string | Да |  |  |


### per_page

Расположение: `query`. Необязательный. Рекомендуется 1..100, по умолчанию 25. Реализация приводит к integer и ограничивает 1..100, не возвращает 422 за выход из диапазона.


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | integer | Да | minimum: 1; maximum: 100; default: 25 |  |


**Пример**


```json
25
```


## Тело запроса

Тело запроса отсутствует.

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

::: code-group

```bash [cURL]
API_BASE_URL='https://api.b.websoft.kz/api/reseller/v1'
: "${RESELLER_API_TOKEN:?Set RESELLER_API_TOKEN in your environment}"

curl --request GET "$API_BASE_URL/catalog/products?per_page=25" \
  --connect-timeout 5 --max-time 20 --fail-with-body \
  --header "Authorization: Bearer $RESELLER_API_TOKEN" \
  --header 'Accept: application/json'
```

```php [PHP 8+]
<?php
declare(strict_types=1);

// PHP 8.0+; extensions: curl, json. Persist the key/body before any write.
function requiredEnv(string $name): string
{
    $value = getenv($name);
    if ($value === false || $value === '' || str_contains($value, "\r") || str_contains($value, "\n")) {
        throw new RuntimeException('Set a valid environment variable: ' . $name);
    }
    return $value;
}

$baseUrl = rtrim(getenv('API_BASE_URL') ?: 'https://api.b.websoft.kz/api/reseller/v1', '/');
$path = '/catalog/products';

$url = $baseUrl . $path . '?per_page=25';
$headers = [
    'Authorization: Bearer ' . requiredEnv('RESELLER_API_TOKEN'),
    'Accept: application/json',

];

$responseHeaders = [];
$handle = curl_init($url);
if ($handle === false) {
    throw new RuntimeException('Cannot initialize cURL.');
}
try {
    if (!curl_setopt_array($handle, [
        CURLOPT_CUSTOMREQUEST => 'GET',
        CURLOPT_HTTPHEADER => $headers,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_FOLLOWLOCATION => false,
        CURLOPT_CONNECTTIMEOUT => 5,
        CURLOPT_TIMEOUT => 20,
        CURLOPT_SSL_VERIFYPEER => true,
        CURLOPT_SSL_VERIFYHOST => 2,
        CURLOPT_HEADERFUNCTION => static function (CurlHandle $curl, string $line) use (&$responseHeaders): int {
            if (str_starts_with($line, 'HTTP/')) {
                $responseHeaders = [];
            } elseif (str_contains($line, ':')) {
                [$name, $value] = explode(':', $line, 2);
                $responseHeaders[strtolower(trim($name))] = trim($value);
            }
            return strlen($line);
        },
    ])) {
        throw new RuntimeException('Cannot configure cURL.');
    }
    $raw = curl_exec($handle);
    if ($raw === false) {
        throw new RuntimeException('Transport failure; result may be unknown. cURL code: ' . curl_errno($handle));
    }
    $status = (int) curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
} finally {
    unset($handle);
}
$requestId = $responseHeaders['x-request-id'] ?? null;
$retryAfter = $responseHeaders['retry-after'] ?? null;
$data = null;
if ($raw !== '' && !in_array($status, [204, 205], true)) {
    try {
        $data = json_decode($raw, true, 512, JSON_THROW_ON_ERROR);
    } catch (JsonException $error) {
        if ($status >= 200 && $status < 300) {
            throw new RuntimeException('Unexpected non-JSON success response.', 0, $error);
        }
    }
}
if ($status < 200 || $status >= 300) {
    // Inspect $data['error']; queue 429 using $retryAfter, never create a new write key blindly.
    throw new RuntimeException('HTTP ' . $status . '; request_id=' . ($requestId ?? '-') . '; retry_after=' . ($retryAfter ?? '-'));
}
// $data contains the decoded response; 202 means accepted, not completed.
echo 'HTTP ' . $status . PHP_EOL;
```

```js [JavaScript / Node.js]
// Node.js 22+; save as request.mjs. No third-party dependencies.
function requiredEnv(name) {
  const value = process.env[name];
  if (!value || /[\r\n]/u.test(value)) throw new Error('Set a valid environment variable: ' + name);
  return value;
}
const baseUrl = (process.env.API_BASE_URL || "https://api.b.websoft.kz/api/reseller/v1").replace(/\/$/u, '');
let path = "/catalog/products";

const url = baseUrl + path + "?per_page=25";

const response = await fetch(url, {
  method: "GET",
  redirect: 'manual',
  signal: AbortSignal.timeout(20_000),
  headers: {
    Authorization: 'Bearer ' + requiredEnv('RESELLER_API_TOKEN'),
    Accept: 'application/json',

  },
});
const requestId = response.headers.get('x-request-id');
const retryAfter = response.headers.get('retry-after');
const raw = await response.text();
let data = null;
if (raw && ![204, 205].includes(response.status)) {
  try { data = JSON.parse(raw); }
  catch (cause) { if (response.ok) throw new Error('Unexpected non-JSON success response.', { cause }); }
}
if (!response.ok) {
  // Inspect data?.error; schedule 429 using retryAfter. Do not generate another write key.
  throw new Error('HTTP ' + response.status + '; request_id=' + requestId + '; retry_after=' + retryAfter);
}
// A timeout may have an unknown result. No automatic mutation retry in this example.
// data contains the response; 202 means accepted, not completed.
console.log('HTTP', response.status);
```

```python [Python]
# Python 3.10+; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import quote
from urllib.request import HTTPRedirectHandler, Request, build_opener

def required_env(name):
    value = os.environ.get(name, "")
    if not value or "\r" in value or "\n" in value:
        raise RuntimeError("Set a valid environment variable: " + name)
    return value

class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None

base_url = os.environ.get("API_BASE_URL", "https://api.b.websoft.kz/api/reseller/v1").rstrip("/")
path = "/catalog/products"

url = base_url + path + "?per_page=25"
headers = {
    "Authorization": "Bearer " + required_env("RESELLER_API_TOKEN"),
    "Accept": "application/json",

}
body = None
request = Request(url, data=body, headers=headers, method="GET")
opener = build_opener(NoRedirect())
try:
    response = opener.open(request, timeout=20)
except HTTPError as error:
    response = error  # HTTP failure still has a response body and headers.
# Network/timeout exceptions propagate: a write may already have been accepted.
with response:
    status = response.status
    request_id = response.headers.get("X-Request-ID")
    retry_after = response.headers.get("Retry-After")
    raw = response.read()
data = None
if raw and status not in (204, 205):
    try:
        data = json.loads(raw)
    except (ValueError, UnicodeDecodeError):
        if 200 <= status < 300:
            raise RuntimeError("Unexpected non-JSON success response.")
if not 200 <= status < 300:
    # Inspect data['error']; schedule 429 with retry_after, keeping the same persisted key.
    raise RuntimeError(f"HTTP {status}; request_id={request_id}; retry_after={retry_after}")
# data contains the response. Do not log secrets/PII; 202 is not completion.
print("HTTP", status)
```

```go [Go]
// Go 1.22+; standard library only. Save as main.go and run: go run main.go
package main

import (
    "encoding/json"
    "fmt"
    "io"
    "net/http"
    "os"
    "strings"
    "time"
)

func requiredEnv(name string) string {
    value := os.Getenv(name)
    if value == "" || strings.ContainsAny(value, "\r\n") { panic("Set a valid environment variable: " + name) }
    return value
}

func main() {
    baseURL := os.Getenv("API_BASE_URL")
    if baseURL == "" { baseURL = "https://api.b.websoft.kz/api/reseller/v1" }
    path := "/catalog/products"

    endpoint := strings.TrimRight(baseURL, "/") + path + "?per_page=25"
    request, err := http.NewRequest("GET", endpoint, nil)
    if err != nil { panic(err) }
    request.Header.Set("Authorization", "Bearer " + requiredEnv("RESELLER_API_TOKEN"))
    request.Header.Set("Accept", "application/json")

    client := &http.Client{
        Timeout: 20 * time.Second,
        CheckRedirect: func(req *http.Request, via []*http.Request) error { return http.ErrUseLastResponse },
    }
    response, err := client.Do(request)
    if err != nil { panic("Transport failure; operation result may be unknown") }
    defer response.Body.Close()
    raw, err := io.ReadAll(response.Body)
    if err != nil { panic("Response read failed; operation result may be unknown") }
    requestID := response.Header.Get("X-Request-ID")
    retryAfter := response.Header.Get("Retry-After")
    var data any
    if len(raw) > 0 && response.StatusCode != 204 && response.StatusCode != 205 {
        decoder := json.NewDecoder(strings.NewReader(string(raw)))
        decoder.UseNumber() // Preserve integer money/identifiers without float rounding.
        if err := decoder.Decode(&data); err != nil && response.StatusCode >= 200 && response.StatusCode < 300 { panic("Unexpected non-JSON success response") }
    }
    if response.StatusCode < 200 || response.StatusCode >= 300 {
        // Inspect data; schedule 429 using retryAfter. Never create a new key blindly.
        panic(fmt.Sprintf("HTTP %d; request_id=%s; retry_after=%s", response.StatusCode, requestID, retryAfter))
    }
    // data holds the JSON value; 202 means accepted, not completed. Do not log secrets.
    fmt.Println("HTTP", response.StatusCode)
}
```

```java [Java]
// Java 17+; standard library only. Save as RequestExample.java.
// Run: java RequestExample.java
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.time.Duration;

public class RequestExample {
    private static String requiredEnv(String name) {
        String value = System.getenv(name);
        if (value == null || value.isEmpty() || value.contains("\r") || value.contains("\n")) {
            throw new IllegalStateException("Set a valid environment variable: " + name);
        }
        return value;
    }
    private static String envOr(String name, String fallback) {
        String value = System.getenv(name);
        return value == null || value.isEmpty() ? fallback : value;
    }
    public static void main(String[] args) throws Exception {
        String baseUrl = envOr("API_BASE_URL", "https://api.b.websoft.kz/api/reseller/v1").replaceAll("/+$", "");
        String path = "/catalog/products";

        URI uri = URI.create(baseUrl + path + "?per_page=25");
        HttpRequest request = HttpRequest.newBuilder(uri)
            .timeout(Duration.ofSeconds(20))
            .header("Authorization", "Bearer " + requiredEnv("RESELLER_API_TOKEN"))
            .header("Accept", "application/json")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(5))
            .followRedirects(HttpClient.Redirect.NEVER)
            .build();
        // Reuse HttpClient in production. A timeout may mean an unknown write result.
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8));
        int status = response.statusCode();
        String requestId = response.headers().firstValue("X-Request-ID").orElse("");
        String retryAfter = response.headers().firstValue("Retry-After").orElse("");
        String responseBody = (status == 204 || status == 205) ? "" : response.body();
        if (status < 200 || status >= 300) {
            // Decode responseBody with your JSON library; schedule 429 using retryAfter.
            throw new IllegalStateException("HTTP " + status + "; request_id=" + requestId + "; retry_after=" + retryAfter);
        }
        // Java SE has no JSON object mapper: pass responseBody to your project's JSON parser.
        // Do not parse an empty 204 body; 202 means accepted, not completed.
        System.out.println("HTTP " + status);
    }
}
```

```csharp [C# / .NET]
// C# / .NET 8+ console app; standard library only. Save as Program.cs.
using System;
using System.Net.Http;
using System.Text;
using System.Text.Json;

static string RequiredEnv(string name)
{
    string? value = Environment.GetEnvironmentVariable(name);
    if (string.IsNullOrEmpty(value) || value.Contains('\r') || value.Contains('\n'))
        throw new InvalidOperationException("Set a valid environment variable: " + name);
    return value;
}

string baseUrl = (Environment.GetEnvironmentVariable("API_BASE_URL") ?? "https://api.b.websoft.kz/api/reseller/v1").TrimEnd('/');
string path = "/catalog/products";

using var handler = new HttpClientHandler { AllowAutoRedirect = false };
using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(20) };
// Reuse HttpClient (or IHttpClientFactory) in production, not one client per request.
using var request = new HttpRequestMessage(new HttpMethod("GET"), baseUrl + path + "?per_page=25");
request.Headers.Add("Authorization", "Bearer " + RequiredEnv("RESELLER_API_TOKEN"));
request.Headers.Add("Accept", "application/json");

// Transport exceptions may have an unknown result; do not issue a new mutation automatically.
using var response = await client.SendAsync(request);
int status = (int)response.StatusCode;
string requestId = response.Headers.TryGetValues("X-Request-ID", out var ids) ? string.Join(",", ids) : "";
string retryAfter = response.Headers.TryGetValues("Retry-After", out var delays) ? string.Join(",", delays) : "";
string raw = await response.Content.ReadAsStringAsync();
JsonElement? data = null;
if (raw.Length > 0 && status != 204 && status != 205)
{
    try { using var document = JsonDocument.Parse(raw); data = document.RootElement.Clone(); }
    catch (JsonException) { if (response.IsSuccessStatusCode) throw; }
}
if (!response.IsSuccessStatusCode)
{
    // Inspect data; schedule 429 using retryAfter and preserve the same key/body.
    throw new HttpRequestException($"HTTP {status}; request_id={requestId}; retry_after={retryAfter}");
}
// data contains JSON, or null for 204. HTTP 202 is not completion.
Console.WriteLine($"HTTP {status}");
```

:::


## Ответы

### Условия ошибок и восстановление

| HTTP | Код | Когда возникает | Что делать |
| --- | --- | --- | --- |
| 401 | `unauthenticated` | Bearer-ключ отсутствует, недействителен, отозван или истёк. | Проверьте ключ и его срок, не повторяйте с теми же неверными credentials. |
| 403 | `forbidden` | Scope, IP allowlist, режим или состояние реселлера не разрешает запрос. | Проверьте scopes, среду, allowlist и настройки реселлера через администратора. |
| 404 | `resource_not_found` | Маршрут отключён конфигурацией либо объект недоступен в текущем контексте. | Проверьте UUID, среду и принадлежность; при отключённой функции обратитесь к оператору. |
| 422 | `validation_failed` | Параметры не прошли валидацию или не выполнены бизнес-условия. | Исправьте поля из error.details/условия. Не повторяйте неизменённый невалидный запрос. |
| 429 | `rate_limit_exceeded` | Лимит текущего API-ключа исчерпан. | Учитывайте Retry-After при наличии, используйте backoff с jitter. Запись повторяйте с прежним Idempotency-Key и неизменённым телом. |
| 500 | `internal_error` | Необработанная ошибка выполнения; это не подтверждение отсутствия побочного эффекта. | Сохраните request_id; сначала проверьте состояние объекта, затем повторяйте запись с тем же ключом. Для неоднозначного результата обращайтесь в поддержку. |

### HTTP 200

Успешный ответ.

**Заголовок `X-Request-ID`**: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | string | Да | format: "uuid" |  |


**Заголовок `X-RateLimit-Limit`**: Лимит API-ключа на 60 секунд. После прохождения ограничителя, включая replay. Отсутствует в собственной ветке 429 и при раннем отказе.


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | integer | Да | minimum: 1 |  |



```text
X-RateLimit-Limit: 120
```


**Заголовок `X-RateLimit-Remaining`**: Остаток после запроса. Снимок, не гарантия при конкуренции. Отсутствует в собственной ветке 429 и при раннем отказе.


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | integer | Да | minimum: 0 |  |



```text
X-RateLimit-Remaining: 119
```


**Content-Type:** `application/json`


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | object | Да | required: ["data","meta"] | Список и упрощённая пагинация. Схема: CoreProductPage |
| `$.data` | array | Да |  | Записи. |
| `$.data[]` | object | Да | required: ["uuid","resource_uuid","name","allowed_periods","allowed_operations","retail_pricing_mode","code","type","description"] | Опубликованное предложение продукта. Цены в этом ответе отсутствуют. Схема: CoreProduct |
| `$.data[].uuid` | string | Да | format: "uuid" | UUID предложения. Не передавайте вместо resource_uuid в quotes. |
| `$.data[].resource_uuid` | string / null | Да | format: "uuid" | UUID продукта или зоны для quotes. |
| `$.data[].name` | string / null | Да |  | Отображаемое название. |
| `$.data[].allowed_periods` | array | Да |  | Если пусто, предложение не ограничивает периоды; наличие цены всё равно обязательно. |
| `$.data[].allowed_periods[]` | object | Да | required: ["unit","count"] | Разрешённый период предложения. Схема: CorePeriod |
| `$.data[].allowed_periods[].unit` | string | Да | enum: "day", "month", "year" | Единица. |
| `$.data[].allowed_periods[].count` | integer | Да | format: "int64"; minimum: 1 | Количество. |
| `$.data[].allowed_operations` | array | Да |  | Если пусто, предложение не ограничивает операции; это не означает наличие API для каждой операции. |
| `$.data[].allowed_operations[]` | string | Да |  | Операция. |
| `$.data[].retail_pricing_mode` | string | Да |  | Режим расчёта розничной цены; итог определяется quotes. |
| `$.data[].code` | string / null | Да |  | Код продукта. |
| `$.data[].type` | string / null | Да |  | Тип продукта, например hosting. |
| `$.data[].description` | string / null | Да |  | Описание продукта. |
| `$.meta` | object | Да | required: ["next_cursor","per_page"] | Упрощённая курсорная пагинация. total, page и prev_cursor отсутствуют. Схема: CoreCursorMeta |
| `$.meta.next_cursor` | string / null | Да |  | Передать как cursor следующего запроса. null означает конец. |
| `$.meta.per_page` | integer | Да | format: "int64"; minimum: 1; maximum: 100 | Фактический размер страницы. |


#### Последняя страница продуктов (200)


```json
{
  "data": [
    {
      "uuid": "019a0000-0000-7000-8000-000000000003",
      "resource_uuid": "019a0000-0000-7000-8000-000000000004",
      "code": "hosting-standard",
      "type": "hosting",
      "name": "Hosting Standard",
      "description": "Хостинг для одного сайта",
      "allowed_periods": [
        {
          "unit": "month",
          "count": 1
        }
      ],
      "allowed_operations": [
        "order"
      ],
      "retail_pricing_mode": "provider_fixed"
    }
  ],
  "meta": {
    "next_cursor": null,
    "per_page": 25
  }
}
```


#### Нет записей в текущем контексте (200)


```json
{
  "data": [],
  "meta": {
    "next_cursor": null,
    "per_page": 25
  }
}
```


### HTTP 401

Bearer-ключ отсутствует, недействителен, отозван или истёк.

**Заголовок `X-Request-ID`**: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | string | Да | format: "uuid" |  |


**Content-Type:** `application/json`


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope |
| `$.error` | object | Да | required: ["code","message","details","request_id"] |  |
| `$.error.code` | string | Да |  | Машинный код; не извлекайте причину из message. |
| `$.error.message` | string | Да |  | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. |
| `$.error.details` | oneOf | Да |  | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. |
| `$.error.details (oneOf 1)` | array | Да | maxItems: 0 |  |
| `$.error.details (oneOf 2)` | object | Да |  |  |
| `$.error.details (oneOf 2).*` | array | Нет |  |  |
| `$.error.details (oneOf 2).*[]` | string | Да |  |  |
| `$.error.details (oneOf 3)` | object | Да | required: ["retry_after"]; Дополнительные поля запрещены |  |
| `$.error.details (oneOf 3).retry_after` | integer | Да | minimum: 0 |  |
| `$.error.request_id` | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. |


#### default (401)


```json
{
  "error": {
    "code": "unauthenticated",
    "message": "API credential is missing or invalid.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}
```


### HTTP 403

Scope, IP allowlist, режим или состояние реселлера не разрешает запрос.

**Заголовок `X-Request-ID`**: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | string | Да | format: "uuid" |  |


**Content-Type:** `application/json`


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope |
| `$.error` | object | Да | required: ["code","message","details","request_id"] |  |
| `$.error.code` | string | Да |  | Машинный код; не извлекайте причину из message. |
| `$.error.message` | string | Да |  | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. |
| `$.error.details` | oneOf | Да |  | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. |
| `$.error.details (oneOf 1)` | array | Да | maxItems: 0 |  |
| `$.error.details (oneOf 2)` | object | Да |  |  |
| `$.error.details (oneOf 2).*` | array | Нет |  |  |
| `$.error.details (oneOf 2).*[]` | string | Да |  |  |
| `$.error.details (oneOf 3)` | object | Да | required: ["retry_after"]; Дополнительные поля запрещены |  |
| `$.error.details (oneOf 3).retry_after` | integer | Да | minimum: 0 |  |
| `$.error.request_id` | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. |


#### default (403)


```json
{
  "error": {
    "code": "forbidden",
    "message": "Source IP address is not allowed.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}
```


#### supportTest (403)


```json
{
  "error": {
    "code": "forbidden",
    "message": "Support is available only to live credentials.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}
```


### HTTP 404

Маршрут отключён конфигурацией либо объект недоступен в текущем контексте.

**Заголовок `X-Request-ID`**: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | string | Да | format: "uuid" |  |


**Content-Type:** `application/json`


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope |
| `$.error` | object | Да | required: ["code","message","details","request_id"] |  |
| `$.error.code` | string | Да |  | Машинный код; не извлекайте причину из message. |
| `$.error.message` | string | Да |  | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. |
| `$.error.details` | oneOf | Да |  | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. |
| `$.error.details (oneOf 1)` | array | Да | maxItems: 0 |  |
| `$.error.details (oneOf 2)` | object | Да |  |  |
| `$.error.details (oneOf 2).*` | array | Нет |  |  |
| `$.error.details (oneOf 2).*[]` | string | Да |  |  |
| `$.error.details (oneOf 3)` | object | Да | required: ["retry_after"]; Дополнительные поля запрещены |  |
| `$.error.details (oneOf 3).retry_after` | integer | Да | minimum: 0 |  |
| `$.error.request_id` | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. |


#### default (404)


```json
{
  "error": {
    "code": "resource_not_found",
    "message": "Not Found",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}
```


### HTTP 422

Параметры не прошли валидацию или не выполнены бизнес-условия.

**Заголовок `X-Request-ID`**: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | string | Да | format: "uuid" |  |


**Content-Type:** `application/json`


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope |
| `$.error` | object | Да | required: ["code","message","details","request_id"] |  |
| `$.error.code` | string | Да |  | Машинный код; не извлекайте причину из message. |
| `$.error.message` | string | Да |  | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. |
| `$.error.details` | oneOf | Да |  | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. |
| `$.error.details (oneOf 1)` | array | Да | maxItems: 0 |  |
| `$.error.details (oneOf 2)` | object | Да |  |  |
| `$.error.details (oneOf 2).*` | array | Нет |  |  |
| `$.error.details (oneOf 2).*[]` | string | Да |  |  |
| `$.error.details (oneOf 3)` | object | Да | required: ["retry_after"]; Дополнительные поля запрещены |  |
| `$.error.details (oneOf 3).retry_after` | integer | Да | minimum: 0 |  |
| `$.error.request_id` | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. |


#### default (422)


```json
{
  "error": {
    "code": "validation_failed",
    "message": "A valid Idempotency-Key header is required.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}
```


#### fields (422)


```json
{
  "error": {
    "code": "validation_failed",
    "message": "The name field is required.",
    "details": {
      "name": [
        "The name field is required."
      ]
    },
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}
```


### HTTP 429

Превышен общий лимит текущего API-ключа по всем методам (в том числе replay). Квота отдельных EPP-команд и фоновых задач не равна этому HTTP-лимиту.

**Заголовок `X-Request-ID`**: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | string | Да | format: "uuid" |  |


**Заголовок `Retry-After`**: На 429 API: целые секунды до сброса окна, не дата/Unix timestamp. При 0 добавьте jitter. Proxy может вернуть HTTP-date.


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | string | Да | pattern: "^[0-9]+$" |  |



```text
Retry-After: 42
```


**Content-Type:** `application/json`


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope |
| `$.error` | object | Да | required: ["code","message","details","request_id"] |  |
| `$.error.code` | string | Да |  | Машинный код; не извлекайте причину из message. |
| `$.error.message` | string | Да |  | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. |
| `$.error.details` | oneOf | Да |  | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. |
| `$.error.details (oneOf 1)` | array | Да | maxItems: 0 |  |
| `$.error.details (oneOf 2)` | object | Да |  |  |
| `$.error.details (oneOf 2).*` | array | Нет |  |  |
| `$.error.details (oneOf 2).*[]` | string | Да |  |  |
| `$.error.details (oneOf 3)` | object | Да | required: ["retry_after"]; Дополнительные поля запрещены |  |
| `$.error.details (oneOf 3).retry_after` | integer | Да | minimum: 0 |  |
| `$.error.request_id` | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. |


#### default (429)


```json
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "API rate limit exceeded.",
    "details": {
      "retry_after": 42
    },
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}
```


### HTTP 500

Необработанная ошибка выполнения; это не подтверждение отсутствия побочного эффекта.

**Заголовок `X-Request-ID`**: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | string | Да | format: "uuid" |  |


**Content-Type:** `application/json`


| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
| --- | --- | --- | --- | --- |
| `$` | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope |
| `$.error` | object | Да | required: ["code","message","details","request_id"] |  |
| `$.error.code` | string | Да |  | Машинный код; не извлекайте причину из message. |
| `$.error.message` | string | Да |  | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. |
| `$.error.details` | oneOf | Да |  | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. |
| `$.error.details (oneOf 1)` | array | Да | maxItems: 0 |  |
| `$.error.details (oneOf 2)` | object | Да |  |  |
| `$.error.details (oneOf 2).*` | array | Нет |  |  |
| `$.error.details (oneOf 2).*[]` | string | Да |  |  |
| `$.error.details (oneOf 3)` | object | Да | required: ["retry_after"]; Дополнительные поля запрещены |  |
| `$.error.details (oneOf 3).retry_after` | integer | Да | minimum: 0 |  |
| `$.error.request_id` | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. |


#### default (500)


```json
{
  "error": {
    "code": "internal_error",
    "message": "The request could not be completed.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}
```


## Машиночитаемый контракт

[OpenAPI JSON](/openapi.json) · [OpenAPI YAML](/reseller-api-openapi.yaml) · <a href="/sources/reference/listProducts.md" download>Markdown этой операции</a>