Справочник провайдеров
POST /v1/provider/list
/v1/provider/listМетод получения справочника провайдеров/брендов, которые можно использовать для создания локации или выбора ТК на полигоне.
Возвращает общий справочник провайдеров (scope = SHARED) и свои провайдеры (scope = OWN) в статусе ACTIVE. Чужие записи OWN в ответ не попадают. Заявки PENDING и REJECTED этим методом не возвращаются, их статус читается POST /v1/provider/application/list.
Тело запроса
Фильтр. Если поле фильтра не передано, равно null или передан пустой массив [], фильтрация по этому полю не применяется. При одновременном указании нескольких фильтров условия объединяются по AND.
Показать свойстваСкрыть свойства
Фильтр по коду. Точное совпадение. Пустой список — без фильтра.
Фильтр по имени. В ответе остаются записи, в имени которых есть эта строка.
Фильтр по области видимости. SHARED — общий справочник, запись видят все кабинеты. OWN — мерчант завёл провайдера для своего кабинета, другие кабинеты эту запись не видят. Пустой список — без фильтра.
Область видимости.
SHARED: общий справочник, запись видят все кабинеты.
OWN: мерчант завёл провайдера для своего кабинета, другие кабинеты эту запись не видят.
Курсор начала отсчёта.
Размер страницы. min = 1; max = 300.
Успешный ответ
200A successful response. application/json
Справочник этого кабинета. Может быть пустым.
ProviderListItem
Показать свойстваСкрыть свойства
ProviderListItem
Код для поля provider_id в локации, заказе и полигоне.
Подпись на карте.
Ссылка на логотип.
Владелец записи.
CATALOG: запись общего справочника, её завела не заявка мерчанта.
MERCHANT: запись создал мерчант.
Область видимости.
SHARED: общий справочник, запись видят все кабинеты.
OWN: мерчант завёл провайдера для своего кабинета, другие кабинеты эту запись не видят.
В этом методе ACTIVE.
PENDING: ждёт модерацииREJECTED: отклонён
Курсор следующей страницы. На последней странице может не возвращаться или быть пустым.
Сколько записей подходит под фильтр.
Ошибки
400Некорректный запрос application/json
Класс транспортной ошибки запроса (HTTP 4xx/5xx).
Поэлементные и бизнес-ошибки сущности приходят в HTTP 200 в errors/failed, не в этом поле.
ERROR_TYPE_UNSPECIFIED: не используетсяERROR_TYPE_UNAUTHORIZED: HTTP 401ERROR_TYPE_RATE_LIMIT: HTTP 429ERROR_TYPE_INTERNAL: HTTP 500ERROR_TYPE_BAD_REQUEST: HTTP 400 (уровень запроса)
Машинный код ошибки. Уточняет error_type.
Человекочитаемое сообщение об ошибке.
401Ошибка авторизации application/json
Класс транспортной ошибки запроса (HTTP 4xx/5xx).
Поэлементные и бизнес-ошибки сущности приходят в HTTP 200 в errors/failed, не в этом поле.
ERROR_TYPE_UNSPECIFIED: не используетсяERROR_TYPE_UNAUTHORIZED: HTTP 401ERROR_TYPE_RATE_LIMIT: HTTP 429ERROR_TYPE_INTERNAL: HTTP 500ERROR_TYPE_BAD_REQUEST: HTTP 400 (уровень запроса)
Машинный код ошибки. Уточняет error_type.
Человекочитаемое сообщение об ошибке.
429Превышен лимит запросов application/json
Класс транспортной ошибки запроса (HTTP 4xx/5xx).
Поэлементные и бизнес-ошибки сущности приходят в HTTP 200 в errors/failed, не в этом поле.
ERROR_TYPE_UNSPECIFIED: не используетсяERROR_TYPE_UNAUTHORIZED: HTTP 401ERROR_TYPE_RATE_LIMIT: HTTP 429ERROR_TYPE_INTERNAL: HTTP 500ERROR_TYPE_BAD_REQUEST: HTTP 400 (уровень запроса)
Машинный код ошибки. Уточняет error_type.
Человекочитаемое сообщение об ошибке.
500Внутренняя ошибка сервера application/json
Класс транспортной ошибки запроса (HTTP 4xx/5xx).
Поэлементные и бизнес-ошибки сущности приходят в HTTP 200 в errors/failed, не в этом поле.
ERROR_TYPE_UNSPECIFIED: не используетсяERROR_TYPE_UNAUTHORIZED: HTTP 401ERROR_TYPE_RATE_LIMIT: HTTP 429ERROR_TYPE_INTERNAL: HTTP 500ERROR_TYPE_BAD_REQUEST: HTTP 400 (уровень запроса)
Машинный код ошибки. Уточняет error_type.
Человекочитаемое сообщение об ошибке.