Список населенных пунктов
Метод предназначен для получения детальной информации о населенных пунктах.
Список населенных пунктов может быть ограничен характеристиками, задаваемыми пользователем.
Внимание! Поддержка устаревшего поля postal_codes в ответе на запрос отключена с 01.03.2023 |
Запрос на получение списка населенных пунктов
Для использования необходимо отправить GET-запрос на URL:
Среда | URL |
|---|---|
| тестовая | https://api.edu.cdek.ru/v2/location/cities |
| боевая | https://api.cdek.ru/v2/location/cities |
Параметры запроса
Поддерживаются следующие параметры:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
|---|---|---|---|---|
| 1 | country_codes | Массив кодов стран в формате ISO_3166-1_alpha-2 | string(2) [ ] | нет |
| 2 | region_code | Код региона СДЭК | integer | нет |
| 3 | kladr_region_code | Код КЛАДР региона Устаревшее поле | string(255) | нет |
| 4 | fias_region_guid | Уникальный идентификатор ФИАС региона Устаревшее поле | UUID | нет |
| 5 | kladr_code | Код КЛАДР населенного пункта Устаревшее поле | string(255) | нет |
| 6 | fias_guid | Уникальный идентификатор ФИАС населенного пункта | UUID | нет |
| 7 | postal_code | Почтовый индекс | string(255) | нет |
| 8 | code | Код населенного пункта СДЭК | integer | нет |
| 9 | city | Название населенного пункта. Должно соответствовать полностью | string(255) | нет |
| 10 | size | Ограничение выборки результата. По умолчанию 1000 | integer | нет |
| 11 | page | Номер страницы выборки результата. По умолчанию 0 | integer | нет |
| 12 | lang | Язык локализации ответа | string(3) | нет |
| 13 | payment_limit | Ограничение на сумму наложенного платежа:
| float | нет |
Ответ на запрос получения списка населенных пунктов
Тело ответа возвращается в формате JSON:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
|---|---|---|---|---|
| 1 | code | Код населенного пункта СДЭК | integer | да |
| 2 | city | Название населенного пункта. | string(255) | да |
| 3 | fias_guid | Уникальный идентификатор ФИАС населенного пункта | UUID | нет |
| 4 | city_uuid | Идентификатор города в ИС СДЭК | UUID | да |
| 5 | kladr_code | Код КЛАДР населенного пункта Устаревшее поле | string(255) | нет |
| 6 | country_code | Код страны населенного пункта в формате ISO_3166-1_alpha-2 | string(2) | да |
| 7 | country | Название страны населенного пункта | string(255) | да |
| 8 | region | Название региона населенного пункта | string(255) | да |
| 9 | region_code | Код региона СДЭК | integer | нет |
| 10 | fias_region_guid | Уникальный идентификатор ФИАС региона населенного пункта Устаревшее поле | UUID | нет |
| 11 | kladr_region_code | Код КЛАДР региона населенного пункта Устаревшее поле | string(255) | нет |
| 12 | sub_region | Название района региона населенного пункта | string(255) | нет |
| ||||
| 14 | longitude | Долгота центра населенного пункта | float | нет |
| 15 | latitude | Широта центра населенного пункта | float | нет |
| 16 | time_zone | Часовой пояс населенного пункта | string(255) | нет |
| 17 | payment_limit | Ограничение на сумму наложенного платежа в населенном пункте | float | да |
| 18 | errors | Список ошибок | error[] | нет |
| 18.1 | code | Код ошибки | string() | да |
| 18.2 | message | Описание ошибки | string() | да |
https://api.cdek.ru/v2/location/cities/?size=3&page=0 https://api.cdek.ru/v2/location/cities/?country_codes=RU,TR |
[
{
"code": "36749",
"city_uuid": "1dc8892d-986d-4bb2-8551-6d1f8066e36b"
"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",
"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—2024, Курьерская компания СДЭК