Заявка на добавление провайдера

POST /v1/provider/apply

POST/v1/provider/apply

Метод подачи заявки для расширения справочника provider_id. Сразу после заявки статус PENDING. Пока статус не ACTIVE, этот код нельзя передавать в локацию и в полигон: location/create и polygon/create отвечают STOREFRONT_RULE_VIOLATION.

scope = OWN — провайдер для своего кабинета, другие кабинеты запись не видят. scope = SHARED — заявка в общий справочник, после ACTIVE код видят все кабинеты, owner остаётся MERCHANT.

Повтор того же кода этим кабинетом возвращает существующую заявку.

Тело запроса

provider_id
string
required

Код провайдера. Латиница в верхнем регистре, цифры и _. Начинается с буквы. Длина от 2 до 32. Мерчант передаёт одну и ту же строку на каждую витрину.

name
string
required

Имя на карте, до 64 символов.

scope
string
required

Область видимости.

SHARED: общий справочник, запись видят все кабинеты.

OWN: мерчант завёл провайдера для своего кабинета, другие кабинеты эту запись не видят.

Допустимые значения
SHAREDOWN
logo_url
string
required

Ссылка на логотип.

rights_basis
string

На каком основании мерчант использует это имя. Можно не передавать.

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

200A successful response.
application/json
object
application_id
integer

Номер заявки (только при успехе). По нему заявку можно отфильтровать в POST /v1/provider/application/list. Повтор того же кода этим кабинетом возвращает тот же номер.

provider_id
string
required

Тот же код, который мерчант передал в запросе. Всегда присутствует (успех и ошибка); пустая строка, если provider_id не был передан.

name
string

Имя из заявки (только при успехе).

logo_url
string

Та же ссылка, которую мерчант передал в запросе (только при успехе).

rights_basis
string

На каком основании мерчант использует это имя (при успехе, если было передано в заявке).

scope
string

Область видимости (только при успехе).

  • SHARED: общий справочник
  • OWN: только кабинет, который создал запись
Допустимые значения
SHAREDOWN
owner
string

Для заявки мерчанта MERCHANT (только при успехе).

  • CATALOG: запись общего справочника
Допустимые значения
CATALOGMERCHANT
status
string

Статус заявки (только при успехе).

  • PENDING: ждёт модерации
  • ACTIVE: одобрен
  • REJECTED: отклонён
Допустимые значения
PENDINGACTIVEREJECTED
created_at
string

Дата и время создания заявки (date-time, RFC3339, только при успехе). Формат RFC3339 с обязательным timezone (пример: 2026-07-02T10:25:00+02:00).

updated_at
string

Дата и время последнего обновления заявки (date-time, RFC3339, только при успехе). Формат RFC3339 с обязательным timezone (пример: 2026-07-02T10:25:00+02:00).

errors
array

Структурированные ошибки по полям (только при неуспехе). Коды только из ProviderApplyValidationErrorCode.

При ошибке возвращаются только provider_id + errors; поля заявки не передаются.

Ошибка валидации или бизнес-правила поля заявки. Для правила витрины: code=STOREFRONT_RULE_VIOLATION.

Ошибка валидации или бизнес-правила поля заявки. Для правила витрины: code=STOREFRONT_RULE_VIOLATION.

Показать свойства
field
string
required

Путь к полю: provider_id, name, scope, logo_url, rights_basis.

code
string
required

Код ошибки.

REQUIRED: не переданы provider_id, name, scope или logo_url.

INVALID_TYPE: неверный JSON-тип.

INVALID_FORMAT: provider_id пустой, с пробелом, кириллицей или дефисом, либо короче 2 или длиннее 32 символов.

INVALID_ENUM: provider_id совпал с постоянным кодом справочника либо scope не из SHARED и OWN.

STOREFRONT_RULE_VIOLATION: scope=SHARED, и этот код уже есть в общем справочнике у другого кабинета.

Допустимые значения
REQUIREDINVALID_TYPEINVALID_FORMATINVALID_ENUMSTOREFRONT_RULE_VIOLATION
message
string
required

Текст для клиента. Для STOREFRONT_RULE_VIOLATION — описание правила.

Ошибки

400Некорректный запрос
application/json
object
error_type
string

Класс транспортной ошибки запроса (HTTP 4xx/5xx).

Поэлементные и бизнес-ошибки сущности приходят в HTTP 200 в errors/failed, не в этом поле.

  • ERROR_TYPE_UNSPECIFIED: не используется
  • ERROR_TYPE_UNAUTHORIZED: HTTP 401
  • ERROR_TYPE_RATE_LIMIT: HTTP 429
  • ERROR_TYPE_INTERNAL: HTTP 500
  • ERROR_TYPE_BAD_REQUEST: HTTP 400 (уровень запроса)
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string

Машинный код ошибки. Уточняет error_type.

message
string

Человекочитаемое сообщение об ошибке.

details
object
401Ошибка авторизации
application/json
object
error_type
string

Класс транспортной ошибки запроса (HTTP 4xx/5xx).

Поэлементные и бизнес-ошибки сущности приходят в HTTP 200 в errors/failed, не в этом поле.

  • ERROR_TYPE_UNSPECIFIED: не используется
  • ERROR_TYPE_UNAUTHORIZED: HTTP 401
  • ERROR_TYPE_RATE_LIMIT: HTTP 429
  • ERROR_TYPE_INTERNAL: HTTP 500
  • ERROR_TYPE_BAD_REQUEST: HTTP 400 (уровень запроса)
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string

Машинный код ошибки. Уточняет error_type.

message
string

Человекочитаемое сообщение об ошибке.

details
object
429Превышен лимит запросов
application/json
object
error_type
string

Класс транспортной ошибки запроса (HTTP 4xx/5xx).

Поэлементные и бизнес-ошибки сущности приходят в HTTP 200 в errors/failed, не в этом поле.

  • ERROR_TYPE_UNSPECIFIED: не используется
  • ERROR_TYPE_UNAUTHORIZED: HTTP 401
  • ERROR_TYPE_RATE_LIMIT: HTTP 429
  • ERROR_TYPE_INTERNAL: HTTP 500
  • ERROR_TYPE_BAD_REQUEST: HTTP 400 (уровень запроса)
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string

Машинный код ошибки. Уточняет error_type.

message
string

Человекочитаемое сообщение об ошибке.

details
object
500Внутренняя ошибка сервера
application/json
object
error_type
string

Класс транспортной ошибки запроса (HTTP 4xx/5xx).

Поэлементные и бизнес-ошибки сущности приходят в HTTP 200 в errors/failed, не в этом поле.

  • ERROR_TYPE_UNSPECIFIED: не используется
  • ERROR_TYPE_UNAUTHORIZED: HTTP 401
  • ERROR_TYPE_RATE_LIMIT: HTTP 429
  • ERROR_TYPE_INTERNAL: HTTP 500
  • ERROR_TYPE_BAD_REQUEST: HTTP 400 (уровень запроса)
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string

Машинный код ошибки. Уточняет error_type.

message
string

Человекочитаемое сообщение об ошибке.

details
object
POST/v1/provider/apply
1curl https://api.example.com/v1/provider/apply \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "provider_id": "string",6  "name": "string",7  "scope": "string",8  "logo_url": "string",9  "rights_basis": "string"10}'
{
  "application_id": 0,
  "provider_id": "string",
  "name": "string",
  "logo_url": "string",
  "rights_basis": "string",
  "scope": "string",
  "owner": "string",
  "status": "string",
  "created_at": "2026-07-02T10:25:00+02:00",
  "updated_at": "2026-07-02T10:25:00+02:00",
  "errors": [
    {
      "field": "string",
      "code": "string",
      "message": "string"
    }
  ]
}

A successful response.