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