List of valid country codes

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

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/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",
                "parent": {
                    "id": 0,
                    "name": "string",
                    "type": "OTHER",
                    "children": [
                        null
                    ]
                },
                "children": [
                    null
                ]
            },
            "countryCode": "RU"
        }
    ]
}

Name

Description

countries*

Type: CountryDTO[]

A list of countries with their codes in the ISO 3166-1 alpha-2 format.
The country and its code are 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: RU

Min length: 2

Max length: 2

Pattern: ^[A-Z]{2}$

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:

  • 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 federal subject.

  • 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

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

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

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