Информация о дочерних регионах
Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
| ⚙️ Лимит: 50 000 запросов в час |
|---|
Request
GET
https://api.partner.market.yandex.ru/regions/{regionId}/children
Path parameters
|
Name |
Type |
Description |
|
regionId* |
integer<int64> |
Идентификатор региона. Идентификатор региона можно получить c помощью запроса GET regions. |
Query parameters
|
Name |
Type |
Description |
|
page |
integer<int32> |
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром
|
|
pageSize |
integer<int32> |
Размер страницы. Используется вместе с параметром
|
Responses
200 OK
Регионы, являющиеся дочерними к указанному в запросе
Body
{
"pager": {
"total": 0,
"from": 0,
"to": 0,
"currentPage": 0,
"pagesCount": 0,
"pageSize": 0
},
"regions": {
"id": 0,
"name": "string",
"type": "OTHER",
"parent": {
"id": 0,
"name": "string",
"type": "OTHER",
"children": [
null
]
},
"children": [
null
]
}
}
|
Name |
Type |
Description |
|
pager |
Модель для пагинации. |
|
|
regions |
Регион доставки. |
FlippingPagerDTO
Модель для пагинации.
|
Name |
Type |
Description |
|
total |
integer<int32> |
Сколько всего найдено элементов. |
|
from |
integer<int32> |
Начальный номер найденного элемента на странице. |
|
to |
integer<int32> |
Конечный номер найденного элемента на странице. |
|
currentPage |
integer<int32> |
Текущая страница. |
|
pagesCount |
integer<int32> |
Общее количество страниц. |
|
pageSize |
integer<int32> |
Размер страницы. |
RegionDTO
Регион доставки.
|
Name |
Type |
Description |
|
id |
integer<int64> |
Идентификатор региона. |
|
name* |
string |
Название региона. |
|
type* |
Тип региона.
|
|
|
parent |
Информация о родительском регионе. Указываются родительские регионы до уровня страны. |
|
|
children |
Дочерние регионы. |
RegionType
Тип региона.
Возможные значения:
-
CITY_DISTRICT— район города. -
CITY— крупный город. -
CONTINENT— континент. -
COUNTRY_DISTRICT— область. -
COUNTRY— страна. -
REGION— регион. -
REPUBLIC_AREA— район субъекта федерации. -
REPUBLIC— субъект федерации. -
SUBWAY_STATION— станция метро. -
VILLAGE— город. -
OTHER— неизвестный регион.
|
Type |
Description |
|
Enum: |
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Type |
Description |
|
code* |
string |
Код ошибки. |
|
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |