List of valid country codes
The method is available for models: FBY, FBS, Express and DBS.
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 a list of countries with their codes in the ISO 3166-1 alpha-2 format.
Country of manufacture countryCode it will be needed when selling goods from abroad for business. Instruction manual
| , Limit: 100 requests per hour |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/regions/countries
Responses
200 OK
A list of countries with their codes in the ISO 3166-1 alpha-2 format.
Body
application/json
{
"countries": [
{
"region": {
"id": 0,
"name": "string",
"type": "OTHER"
},
"countryCode": "RU"
}
]
}
|
Name |
Description |
|
countries* |
Type: CountryDTO[] A list of countries with their codes in the ISO 3166-1 alpha-2 format. |
CountryDTO
The country and its code are in the ISO 3166-1 alpha-2 format.
|
Name |
Description |
|
countryCode* |
Type: string The country of manufacture is in the ISO 3166-1 alpha-2 format. How to get Example: Min length: Max length: Pattern: |
|
region* |
Type: RegionDTO The delivery region. |
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. |
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 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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.