List of Cities
This method is used to load detailed information on cities. The list of cities may be limited to user-defined characteristics.
Request for List of Cities
In order to use this process, a GET request should be sent to URL:
Environment | URL |
testing | |
production |
Parameters Body
The following parameters are supported:
No. | Tag/ attribute | Description | Type of field | 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 | integer | no |
3 | kladr_region_code | Region 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 | kladr_code | City code according to the Russian Classifier of Countries of the World Deprecated field | string(255) | no |
6 | fias_guid | City code according to the Federal Information Address System | UUID | no |
7 | postal_code | Postal code | string(255) | no |
8 | code | City code from the CDEK IS | integer | no |
9 | city | City name | string(255) | no |
10 | size | Limitation on the number of results displayed. Default value: 500 | integer | yes, if page is specified |
11 | page | Number of the results page. Default value: 0 | integer | no |
12 | lang | Localization. Default: “rus” | string(3) | no |
13 | payment_limit | Cash-on-delivery amount limit, possible values: | float | no |
Response to List of Cities request
The response body is returned in JSON format:
No. | Tag/ attribute | Description | Type of field | Mandatory (yes/no) |
---|---|---|---|---|
1 | code | CDEK location code | integer | yes |
2 | city | City name | string(255) | yes |
3 | fias_guid | City code according to the Federal Information Address System | UUID | no |
4 | kladr_code | Region code according to the Russian Classifier of Countries of the World Deprecated field | string(255) | no |
5 | country_code | Country code in the format ISO_3166-1_alpha-2 | string(2) | yes |
6 | country | City country name | string(255) | yes |
7 | region | Region name | string(255) | yes |
8 | region_code | Region code in the CDEK IS | integer | no |
9 | fias_region_guid | Region code according to the Federal Information Address System Deprecated field | UUID | no |
10 | kladr_region_code | Code according to the Russian Classifier of Countries of the World Deprecated field | string(255) | no |
11 | sub_region | Name of region's district | string(255) | no |
| ||||
13 | longitude | Latitude | float | no |
14 | latitude | Longitude | float | no |
15 | time_zone | City timezone | string(255) | no |
16 | payment_limit | Cash-on-delivery amount limit, possible values: | float | yes |
17 | errors | List of errors (if any) | error[] | no |
17.1 | code | Error code (if any) | string() | yes |
17.2 | message | Error description (if any) | string() | yes |
https://api.cdek.ru/v2/location/cities/?size=3&page=0 https://api.cdek.ru/v2/location/cities/?country_codes=RU,TR |
[ { "code": "36749", "postal_codes": [ "169237" ], "country_code": "RU", "fias_guid": "62e29404-83cc-4dd8-a46a-7d28464b9df8" "country": "Россия", "region": "Коми", "region_code": "1", "sub_region": "Княжпогостский", "city": "Чиньяворык", "longitude": 52.6702, "latitude": 63.2087, "time_zone": "Europe/Moscow" }, { "code": "60049", "country_code": "RU", "fias_guid": "98eb8fd9-1ea0-457b-b539-ba6396eb6e01" "country": "Россия", "region": "Московская", "region_code": "9", "sub_region": "Можайский", "city": "Поченичено", "longitude": 35.9312, "latitude": 55.3636, "time_zone": "Europe/Moscow" }, { "code": "16584", "postal_codes": [ "353650", "353651" ], "country_code": "RU", "fias_guid": "c51d14cc-045c-4790-83c2-56febe8f8fa9", "country": "Россия", "region": "Краснодарский", "region_code": "7", "sub_region": "Ейский", "city": "Камышеватская", "longitude": 37.9554, "latitude": 46.4119, "time_zone": "Europe/Moscow" } ] |
© 2000—2022, Курьерская компания СДЭК