List of Regions


 

This method is used to load detailed information on regions. The list of regions may be limited to user-defined characteristics.

Request for List of Regions 

In order to use this process, a GET request should be sent to URL:

Environment

URL

testing

https://api.edu.cdek.ru/v2/location/regions

production

https://api.cdek.ru/v2/location/regions

Request Parameters

The following parameters are supported:

No.

Field name

Description

Field type

Mandatory (yes/no)

1country_codesArray of country codes in the format ISO_3166-1_alpha-2string(2) [ ]no
2region_code

Region code in the CDEK IS

Deprecated field

integerno
3kladr_region_code

Code according to the Russian Classifier of Countries of the World

Deprecated field

string(255)no
4fias_region_guid

Region code according to the Federal Information Address System

Deprecated field

UUIDno
5sizeLimitation on the number of results displayed. Default value: 1,000integeryes, if page is specified
6pageNumber of the results page. Default value: 0integerno
7langLocalization. Default: “rus”string(3)no

Response to List of Regions request

The response is returned in JSON format:

No.

Field name

Description

Field type

Mandatory (yes/no)

1country_codeCountry code in the format ISO_3166-1_alpha-2string(2)yes
2countryRegion country namestring(255)yes
3regionRegion namestring(255)yes
4prefix

Region prefix

Deprecated field

string(255)no
5region_codeRegion code in the CDEK ISintegerno
6kladr_region_code

Code according to the Russian Classifier of Countries of the World

Deprecated field

string(255)no
7fias_region_guid

Region code according to the Federal Information Address System

Deprecated field

UUIDno
8errorsList of errors (if any)error[]no
8.1codeError code (if any)string()yes
8.2messageError description (if any)string()yes


https://api.cdek.ru/v2/location/regions?size=3&page=0
https://api.cdek.ru/v2/location/regions?country_codes=RU,TR


[
    {
        "country_code": "TR",
        "region": "Ыгдыр",
        "country": "Турция"
    },
    {
        "country_code": "CN",
        "region": "аймак Алашань",
        "country": "Китай (КНР)"
    },
    {
        "country_code": "RU",
        "region": "Тверская",
        "region_code": 50,
        "country": "Россия"
    }
]


 

© 2000—2022, Курьерская компания СДЭК