Поиск регионов по их имени
Метод доступен для всех моделей.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- inventory-and-order-processing — Обработка заказов и учёт товаров
- inventory-and-order-processing:read-only — Просмотр информации о заказах
- pricing — Управление ценами
- pricing:read-only — Просмотр цен
- offers-and-cards-management — Управление товарами и карточками
- offers-and-cards-management:read-only — Просмотр товаров и карточек
- promotion — Продвижение товаров
- promotion:read-only — Просмотр информации о продвижении товаров
- finance-and-accounting — Просмотр финансовой информации и отчётности
- communication — Общение с покупателями
- settings-management — Настройка магазинов
- supplies-management:read-only — Получение информации по FBY-заявкам
- all-methods — Полное управление кабинетом
- all-methods:read-only — Просмотр всех данных
Возвращает информацию о регионе, удовлетворяющем заданным в запросе условиям поиска.
Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам.
Для методов GET regions
, GET regions/{regionId}
и GET regions/{regionId}/children
действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
⚙️ Лимит: 50 000 запросов в час |
---|
Request
GET
https://api.partner.market.yandex.ru/regions
Query parameters
Name |
Description |
name* |
Type: string Название региона. Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, |
limit |
Type: integer<int32> Количество значений на одной странице.
|
page_token |
Type: string Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра Если задан |
Responses
200 OK
Список найденных регионов.
Body
application/json
{
"regions": [
{
"id": 0,
"name": "string",
"type": "OTHER",
"parent": {
"id": 0,
"name": "string",
"type": "OTHER",
"children": [
null
]
},
"children": [
null
]
}
],
"paging": {
"nextPageToken": "string"
}
}
Name |
Description |
regions* |
Type: RegionDTO[] Регион доставки. |
paging |
Type: ForwardScrollingPagerDTO Ссылка на следующую страницу. |
RegionDTO
Регион доставки.
Name |
Description |
id* |
Type: integer<int64> Идентификатор региона. |
name* |
Type: string Название региона. |
type* |
Type: RegionType Тип региона. Возможные значения:
Enum: |
children |
Type: RegionDTO[] Дочерние регионы. Min items: |
parent |
Type: RegionDTO Информация о родительском регионе. Указываются родительские регионы до уровня страны. |
ForwardScrollingPagerDTO
Ссылка на следующую страницу.
Name |
Description |
nextPageToken |
Type: string Идентификатор следующей страницы результатов. |
RegionType
Тип региона.
Возможные значения:
-
CITY_DISTRICT
— район города. -
CITY
— крупный город. -
CONTINENT
— континент. -
COUNTRY_DISTRICT
— область. -
COUNTRY
— страна. -
REGION
— регион. -
REPUBLIC_AREA
— район субъекта федерации. -
REPUBLIC
— субъект федерации. -
SUBWAY_STATION
— станция метро. -
VILLAGE
— город. -
OTHER
— неизвестный регион.
Type |
Description |
Enum: |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
ApiErrorDTO
Общий формат ошибки.
Name |
Description |
code* |
Type: string Код ошибки. |
message |
Type: string Описание ошибки. |
ApiResponseStatusType
Тип ответа. Возможные значения:
OK
— ошибок нет.ERROR
— при обработке запроса произошла ошибка.
Type |
Description |
Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
No longer supported, please use an alternative and newer version.