Справочник провайдеров

POST /v1/provider/list

POST/v1/provider/list

Метод получения справочника провайдеров/брендов, которые можно использовать для создания локации или выбора ТК на полигоне.

Возвращает общий справочник провайдеров (scope = SHARED) и свои провайдеры (scope = OWN) в статусе ACTIVE. Чужие записи OWN в ответ не попадают. Заявки PENDING и REJECTED этим методом не возвращаются, их статус читается POST /v1/provider/application/list.

Тело запроса

filter
object
required

Фильтр. Если поле фильтра не передано, равно null или передан пустой массив [], фильтрация по этому полю не применяется. При одновременном указании нескольких фильтров условия объединяются по AND.

Показать свойства
provider_id
string[]

Фильтр по коду. Точное совпадение. Пустой список — без фильтра.

name
string

Фильтр по имени. В ответе остаются записи, в имени которых есть эта строка.

scope
string[]

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

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

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

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

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

Курсор начала отсчёта.

limit
integer
required

Размер страницы. min = 1; max = 300.

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

200A successful response.
application/json
object
providers
array
required

Справочник этого кабинета. Может быть пустым.

ProviderListItem

Показать свойства

ProviderListItem

provider_id
string
required

Код для поля provider_id в локации, заказе и полигоне.

name
string
required

Подпись на карте.

logo_url
string
required

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

owner
string
required

Владелец записи.

CATALOG: запись общего справочника, её завела не заявка мерчанта.

MERCHANT: запись создал мерчант.

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

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

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

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

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

В этом методе ACTIVE.

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

Курсор следующей страницы. На последней странице может не возвращаться или быть пустым.

total
integer

Сколько записей подходит под фильтр.

Ошибки

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/list
1curl https://api.example.com/v1/provider/list \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "filter": {6    "provider_id": [7      "string"8    ],9    "name": "string",10    "scope": [11      "string"12    ]13  },14  "cursor": "string",15  "limit": 016}'
{
  "providers": [
    {
      "provider_id": "string",
      "name": "string",
      "logo_url": "string",
      "owner": "string",
      "scope": "string",
      "status": "string"
    }
  ],
  "next_cursor": "string",
  "total": 0
}

A successful response.