Information about the region
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.
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}
Path parameters
|
Name |
Description |
|
regionId* |
Type: integer<int64> ID of the region. You can get the region ID using a request GET regions. |
Responses
200 OK
The found region.
Body
application/json
{
"regions": [
{
"id": 0,
"name": "string",
"type": "OTHER"
}
],
"paging": {
"nextPageToken": "string"
}
}
|
Name |
Description |
|
regions* |
Type: RegionDTO[] 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:
Enum: |
|
parent |
Type: RegionDTO The delivery region. |
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 |
|
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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 |
|
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.