Информация о регионе
Возвращает информацию о регионе.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
| ⚙️ Лимит: 50 000 запросов в час |
|---|
Request
GET
https://api.partner.market.yandex.ru/regions/{regionId}
Path parameters
|
Name |
Description |
|
regionId* |
Type: integer<int64> Идентификатор региона. Идентификатор региона можно получить c помощью запроса GET regions. |
Responses
200 OK
Найденный регион.
Body
{
"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 Тип региона.
|
|
parent |
Type: RegionDTO Информация о родительском регионе. Указываются родительские регионы до уровня страны. |
|
children |
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
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа.
|
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Description |
|
code* |
Type: string Код ошибки. |
|
message |
Type: string Описание ошибки. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа.
|
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа.
|
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа.
|
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа.
|
|
errors |
Type: ApiErrorDTO[] Список ошибок. |