Information about child regions

Info

Console

The method is available for all models.

If you are using an API Key token, one of the accesses in the list is required to call the method

inventory-and-order-processing — Order processing and inventory
inventory-and-order-processing:read-only — View order information
pricing — Manage prices
pricing:read-only — View prices
offers-and-cards-management — Manage products and cards
offers-and-cards-management:read-only — View products and cards
promotion — Product promotion
promotion:read-only — View promotion information
finance-and-accounting — View financial data and reports
communication — Customer communication
settings-management — Store settings
supplies-management:read-only — View FBY requests
all-methods — Full account management
all-methods:read-only — View all data

Returns information about regions that are children of the region whose ID is specified in the request.

For methods GET regions, GET regions/{regionId} and GET regions/{regionId}/children The group resource limit is in effect. The limit is imposed on the total number of regions, information about which is requested using these methods (no more than 100,000 regions).

The volume of requests to the resource that can be completed during the day depends on the total number of regions.

, Limit: 50,000 requests per hour

Request

GET

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

Path parameters

Name

Description

regionId*

Type: integer<int64>

ID of the region.

You can get the region ID using a request GET regions.

Query parameters

Name

Description

page

Type: integer<int32>

If the method has page_token

Use it instead of the parameter page.

Learn more about the types of pagination and their use

The number of the results page.

Used together with the parameter pageSize.

page ignored if specified page_token or limit.

Default: 1

Max value: 10000

pageSize

Type: integer<int32>

Page size.

Used together with the parameter page.

pageSize ignored if specified page_token or limit.

Responses

200 OK

Regions that are children of the one specified in the request.

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

A model for pagination.

regions

Type: RegionDTO

The delivery region.

FlippingPagerDTO

A model for pagination.

Name	Description
currentPage	Type: integer<int32> The current page.
from	Type: integer<int32> The initial number of the found element on the page.
pageSize	Type: integer<int32> Page size.
pagesCount	Type: integer<int32> The total number of pages.
to	Type: integer<int32> The final number of the found element on the page.
total	Type: integer<int32> How many items were found in total.

RegionDTO

The delivery region.

Name	Description
id*	Type: integer<int64> ID of the region.
name*	Type: string The name of the region.
type*	Type: RegionType The type of region. Possible values: `CITY_DISTRICT` — the area of the city. `CITY` — a large city. `CONTINENT` — the continent. `COUNTRY_DISTRICT` — area. `COUNTRY` — country. `REGION` — region. `REPUBLIC_AREA` — district of the subject of the federation. `REPUBLIC` — the subject of the Federation. `SUBWAY_STATION` — the metro station. `VILLAGE` — the city. `OTHER` — unknown region. Enum: `OTHER`, `CONTINENT`, `REGION`, `COUNTRY`, `COUNTRY_DISTRICT`, `REPUBLIC`, `CITY`, `VILLAGE`, `CITY_DISTRICT`, `SUBWAY_STATION`, `REPUBLIC_AREA`
children	Type: RegionDTO[] Child regions. The delivery region. Min items: `1`
parent	Type: RegionDTO Information about the parent region. Parent regions are specified up to the country level.

RegionType

The type of region.

Possible values:

CITY_DISTRICT — the area of the city.
CITY — a large city.
CONTINENT — the continent.
COUNTRY_DISTRICT — area.
COUNTRY — country.
REGION — region.
REPUBLIC_AREA — district of the subject of the federation.
REPUBLIC — the subject of the Federation.
SUBWAY_STATION — the metro station.
VILLAGE — the city.
OTHER — unknown region.

Type	Description
RegionType	Enum: `OTHER`, `CONTINENT`, `REGION`, `COUNTRY`, `COUNTRY_DISTRICT`, `REPUBLIC`, `CITY`, `VILLAGE`, `CITY_DISTRICT`, `SUBWAY_STATION`, `REPUBLIC_AREA`

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ApiErrorDTO

The general error format.

Name

Description

code*

Type: string

The error code.

message

Type: string

Description of the error.

ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

404 Not Found

The requested resource was not found. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error in Yandex. Market. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

Information about the region

Adding and editing products