Список регионов


 

Метод предназначен для получения детальной информации о регионах. 
Список регионов может быть ограничен характеристиками, задаваемыми пользователем.

Запрос на получение списка регионов

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

Среда

URL

тестоваяhttps://api.edu.cdek.ru/v2/location/regions
боеваяhttps://api.cdek.ru/v2/location/regions

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

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

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

Описание

Тип поля

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

1country_codesМассив кодов стран в формате  ISO_3166-1_alpha-2string(2) [ ]нет
2region_code

Код региона СДЭК

Устаревшее поле

integerнет
3kladr_region_code

Код КЛАДР региона

Устаревшее поле

string(255)нет
4fias_region_guid

Уникальный идентификатор ФИАС региона

Устаревшее поле

UUIDнет
5sizeОграничение выборки результата. По умолчанию 1000integerда, если указан page
6pageНомер страницы выборки результата. По умолчанию 0integerнет
7langЛокализация. По умолчанию "rus" (доступны eng и zho)string(3)нет

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

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

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

Описание

Тип поля

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

1country_codeКод страны в формате  ISO_3166-1_alpha-2string(2)да
2countryНазвание страны регионаstring(255)да
3regionНазвание регионаstring(255)да
4prefix

Префикс региона

Устаревшее поле

string(255)нет
5region_codeКод региона СДЭКintegerнет
6kladr_region_code

Код КЛАДР региона

Устаревшее поле

string(255)нет
7fias_region_guid

Уникальный идентификатор ФИАС региона

Устаревшее поле

UUIDнет
8errorsСписок ошибокerror[]нет
8.1codeКод ошибкиstring()да
8.2messageОписание ошибки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, Курьерская компания СДЭК