Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Для использования необходимо отправить GET-запрос на URL:

Параметры запроса

Поддерживаются следующие параметры:

Название поля

Описание

Тип поля

Обяз. для заполн.

1country_codesМассив кодов стран в формате  ISO_3166-1_alpha-2string(2) [ ]нет
2region_codeКод региона СДЭК
string(255)
integerнет
3kladr_region_codeКод КЛАДР регионаstring(255)нет
4fias_region_guidУникальный идентификатор ФИАС региона
UUIDнет
5kladr_codeКод КЛАДР населенного пунктаstring(255)нет
6fias_guidУникальный идентификатор ФИАС населенного пунктаUUIDнет
7postal_codeПочтовый индексstring(255)нет
8codeКод населенного пункта СДЭК
string(255)
integerнет
9cityНазвание населенного пункта. Должно соответствовать полностьюstring(255)нет
10sizeОграничение выборки результата. По умолчанию 1000integerда, если указан page
11pageНомер страницы выборки результата. По умолчанию 0integerнет
12langЛокализация. По умолчанию "rus"string(3)нет
13payment_limitОграничение на сумму наложенного платежа:
  • -1 - ограничения нет;
  • 0 - наложенный платеж не принимается;
  • положительное значение - сумма наложенного платежа не более данного значения.
floatнет

Ответ на запрос получения списка населенных пунктов

Ответ возвращается в формате JSON:

Название поля

Описание

Тип поля

Обяз. для заполн.

1codeКод населенного пункта СДЭК
string(255)
integerда
2cityНазвание населенного пункта.string(255)да
3fias_guidУникальный идентификатор ФИАС населенного пунктаUUIDнет
4kladr_codeКод КЛАДР населенного пунктаstring(255)нет
5country_codeКод страны населенного пункта в формате  ISO_3166-1_alpha-2string(2)да
6countryНазвание страны населенного пунктаstring(255)да
7regionНазвание региона населенного пунктаstring(255)да
8region_codeКод региона СДЭК
string(255)
integerнет
9fias_region_guidУникальный идентификатор ФИАС региона населенного пункта
UUIDнет
10kladr_region_codeКод КЛАДР региона населенного пунктаstring(255)нет
11sub_regionНазвание района региона населенного пунктаstring(255)нет
12postal_codesМассив почтовых индексов

[ ]

нет
13longitudeДолгота центра населенного пунктаfloatнет
14latitudeШирота центра населенного пунктаfloatнет
15time_zoneЧасовой пояс населенного пунктаstring(255)нет
16payment_limitОграничение на сумму наложенного платежа в населенном пунктеfloatда
17errorsСписок ошибокerror[]нет
17.1codeКод ошибкиstring()да
17.2messageОписание ошибкиstring()да


Code Block
languagejava
titleПримеры запросов
https://api.cdek.ru/v2/location/cities/?size=3&page=0
https://api.cdek.ru/v2/location/cities/?country_codes=RU,TR

...