Список регионов
Метод предназначен для получения детальной информации о регионах.
Список регионов может быть ограничен характеристиками, задаваемыми пользователем.
Запрос на получение списка регионов
Для использования необходимо отправить GET-запрос на URL:
Среда | URL |
---|---|
тестовая | https://api.edu.cdek.ru/v2/location/regions |
боевая | https://api.cdek.ru/v2/location/regions |
Параметры запроса
Поддерживаются следующие параметры:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
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 | size | Ограничение выборки результата. По умолчанию 1000 | integer | да, если указан page |
6 | page | Номер страницы выборки результата. По умолчанию 0 | integer | нет |
7 | lang | Локализация. По умолчанию "rus" (доступны eng и zho) | string(3) | нет |
Ответ на запрос получения списка регионов
Ответ возвращается в формате JSON:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | country_code | Код страны в формате ISO_3166-1_alpha-2 | string(2) | да |
2 | country | Название страны региона | string(255) | да |
3 | region | Название региона | string(255) | да |
4 | prefix | Префикс региона Устаревшее поле | string(255) | нет |
5 | region_code | Код региона СДЭК | integer | нет |
6 | kladr_region_code | Код КЛАДР региона Устаревшее поле | string(255) | нет |
7 | fias_region_guid | Уникальный идентификатор ФИАС региона Устаревшее поле | UUID | нет |
8 | errors | Список ошибок | error[] | нет |
8.1 | code | Код ошибки | string() | да |
8.2 | message | Описание ошибки | string() | да |
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, Курьерская компания СДЭК