Информация о дочерних регионах

Метод доступен для моделей: FBY, FBS, Экспресс и DBS.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе.

Для методов GET v2/regions, GET v2/regions/{regionId} и GET v2/regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

⚙️ Лимит: 50 000 запросов в час

Request

GET

https://api.partner.market.yandex.ru/v2/regions/{regionId}/children

Path parameters

Name

Description

regionId

Type: integer

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET v2/regions.

Query parameters

Name

Description

page

Type: integer

Если в методе есть page_token

Используйте его вместо параметра page.

Подробнее о типах пагинации и их использовании

Номер страницы результатов.

Используется вместе с параметром pageSize.

page игнорируется, если задан page_token или limit.

Default: 1

Max value: 10000

pageSize

Type: integer

Размер страницы.

Используется вместе с параметром page.

pageSize игнорируется, если задан page_token или limit.

Responses

200 OK

Регионы, являющиеся дочерними к указанному в запросе.

Body

application/json
{
  "pager": {
    "total": 0,
    "from": 0,
    "to": 0,
    "currentPage": 0,
    "pagesCount": 0,
    "pageSize": 0
  },
  "regions": {
    "id": 0,
    "name": "example",
    "type": "OTHER",
    "parent": null,
    "children": [
      null
    ]
  }
}

Name

Description

pager

Type: FlippingPagerDTO

Модель для пагинации.

Example
{
  "total": 0,
  "from": 0,
  "to": 0,
  "currentPage": 0,
  "pagesCount": 0,
  "pageSize": 0
}

regions

Type: RegionWithChildrenDTO

Информация о родительском и дочерних регионах.

Example
{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": null,
  "children": [
    null
  ]
}

FlippingPagerDTO

Модель для пагинации.

Name

Description

currentPage

Type: integer

Текущая страница.

from

Type: integer

Начальный номер найденного элемента на странице.

pagesCount

Type: integer

Общее количество страниц.

pageSize

Type: integer

Размер страницы.

to

Type: integer

Конечный номер найденного элемента на странице.

total

Type: integer

Сколько всего найдено элементов.
Example
{
  "total": 0,
  "from": 0,
  "to": 0,
  "currentPage": 0,
  "pagesCount": 0,
  "pageSize": 0
}

RegionType

Тип региона.

Возможные значения:

  • CITY_DISTRICT — район города.

  • CITY — крупный город.

  • CONTINENT — континент.

  • COUNTRY_DISTRICT — область.

  • COUNTRY — страна.

  • REGION — регион.

  • REPUBLIC_AREA — район субъекта федерации.

  • REPUBLIC — субъект федерации.

  • SUBWAY_STATION — станция метро.

  • VILLAGE — город.

  • OTHER — неизвестный регион.

Type: string

Enum: OTHER, CONTINENT, REGION, COUNTRY, COUNTRY_DISTRICT, REPUBLIC, CITY, VILLAGE, CITY_DISTRICT, SUBWAY_STATION, REPUBLIC_AREA

RegionDTO

Регион доставки.

Name

Description

id

Type: integer

Идентификатор региона.

name

Type: string

Название региона.

Example: example

type

Type: RegionType

Тип региона.

Тип региона.

Возможные значения:

  • CITY_DISTRICT — район города.

  • CITY — крупный город.

  • CONTINENT — континент.

  • COUNTRY_DISTRICT — область.

  • COUNTRY — страна.

  • REGION — регион.

  • REPUBLIC_AREA — район субъекта федерации.

  • REPUBLIC — субъект федерации.

  • SUBWAY_STATION — станция метро.

  • VILLAGE — город.

  • OTHER — неизвестный регион.

Enum: OTHER, CONTINENT, REGION, COUNTRY, COUNTRY_DISTRICT, REPUBLIC, CITY, VILLAGE, CITY_DISTRICT, SUBWAY_STATION, REPUBLIC_AREA

parent

Type: RegionDTO

Информация о родительском регионе.

Указываются родительские регионы до уровня страны.

Регион доставки.

Example
{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": null
}
Example
{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": {
    "id": 0,
    "name": "example",
    "type": null,
    "parent": null
  }
}

RegionWithChildrenDTO

Информация о родительском и дочерних регионах.

Type: object

All of 2 types

  • Type: RegionDTO

    Регион доставки.

    Example
    {
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": null
}
  • Type: object

    children

    Type: RegionDTO[] | null

    Дочерние регионы.

    Min items: 1

    Example
    [
  {
    "id": 0,
    "name": "example",
    "type": "OTHER",
    "parent": null
  }
]
    Example
    {
  "children": [
    {
      "id": 0,
      "name": "example",
      "type": "OTHER",
      "parent": null
    }
  ]
}
Example
{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": null,
  "children": [
    null
  ]
}

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR
Example
{
  "status": "OK"
}

ApiErrorDTO

Общий формат ошибки.

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

Описание ошибки.

Example: example
Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

    Example
    [
  {
    "code": "example",
    "message": "example"
  }
]
    Example
    {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}
Example
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

404 Not Found

Запрашиваемый ресурс не найден. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

No longer supported, please use an alternative and newer version.

Предыдущая
Информация о регионе
Следующая
Один заказ в магазине