Search for regions by their name

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 the region that meets the search conditions specified in the query.

If several regions are found that meet the search conditions, information is returned for each region found (but no more than ten regions) to determine the desired region by parent regions.

For methods GET regions, GET regions/{regionId} and GET regions/{regionId}/children there is a group resource restriction. 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

Query parameters

Name	Description
name*	Type: string The name of the region. It is important to take into account the case: the first letter should be uppercase, the rest should be lowercase. For example, `Moscow`.
limit	Type: integer<int32> The number of values per page. Example: `20`
page_token	Type: string ID of the results page. If the parameter is omitted, the first page is returned. We recommend transmitting the value of the output parameter `nextPageToken`, received during the last request. If set `page_token` and the request has parameters `page` and `pageSize` they are ignored. Example: `eyBuZXh0SWQ6IDIzNDIgfQ==`

Responses

200 OK

A list of found regions.

Body

application/json

{
    "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[]

The delivery region.
The delivery region.

paging

Type: ForwardScrollingPagerDTO

The ID of the next page.

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.

ForwardScrollingPagerDTO

The ID of the next page.

Name

Description

nextPageToken

Type: string

ID of the next results page.

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`

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

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`

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

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 of the 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?

List of country codes

Information about the region