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 | |
production |
Request Parameters
The following parameters are supported:
No. | Field name | Description | Field type | Mandatory (yes/no) |
---|---|---|---|---|
1 | country_codes | Array of country codes in the format ISO_3166-1_alpha-2 | string(2) [ ] | no |
2 | region_code | Region code in the CDEK IS Deprecated field | integer | no |
3 | kladr_region_code | Code according to the Russian Classifier of Countries of the World Deprecated field | string(255) | no |
4 | fias_region_guid | Region code according to the Federal Information Address System Deprecated field | UUID | no |
5 | size | Limitation on the number of results displayed. Default value: 1,000 | integer | yes, if page is specified |
6 | page | Number of the results page. Default value: 0 | integer | no |
7 | lang | Localization. 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) |
---|---|---|---|---|
1 | country_code | Country code in the format ISO_3166-1_alpha-2 | string(2) | yes |
2 | country | Region country name | string(255) | yes |
3 | region | Region name | string(255) | yes |
4 | prefix | Region prefix Deprecated field | string(255) | no |
5 | region_code | Region code in the CDEK IS | integer | no |
6 | kladr_region_code | Code according to the Russian Classifier of Countries of the World Deprecated field | string(255) | no |
7 | fias_region_guid | Region code according to the Federal Information Address System Deprecated field | UUID | no |
8 | errors | List of errors (if any) | error[] | no |
8.1 | code | Error code (if any) | string() | yes |
8.2 | message | Error 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—2024, Курьерская компания СДЭК