API Адреса

Работа с адресами

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

Метод «searchSettlements», работает в модели «Address», этот метод необходим для ОНЛАЙН ПОИСКА населенных пунктов. С данным методом нет необходимости хранить на своей стороне справочники и заботиться о их обновлениях.

URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]/
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/


Доступность: Не требует использования API-ключа.

Try it

URL-адрес запроса

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

string

Форматы JSON, XML

Заголовки запросов

(дополнительный)
string
Тип формата текста, отправляемого в API.

Текст запроса

Параметр Тип данных Описание
apiKey* string[36] Ваш ключ API 2.0
modelName* string Имя модели
calledMethod* string Имя вызываемого метода
methodProperties*   Свойства метода
CityName* string[36] Название населенного пункта или ИНДКЕС населенного пункта
Limit* int[36] Количество ответов

* Обозначение обязательного параметра

{
"apiKey": "[ВАШ КЛЮЧ]",
 "modelName": "Address",
    "calledMethod": "searchSettlements",
    "methodProperties": {
        "CityName": "київ",
        "Limit": 5
    }
}
<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>Address</modelName>
<calledMethod>searchSettlements</calledMethod>
<methodProperties>
<CityName>київ</CityName>
<Limit>5</Limit>
</methodProperties>
</file>

Ответ 200

Всегда возвращает код 200 даже при логических ошибках.


Тело ответа на запрос

Параметр Тип данных Описание
Warehouses int[36] Количество отделений
MainDescription string[50] Название населенных пунктов
Area string[50] Обозначение области
Region string[50] Обозначение района
SettlementTypeCode string[50] Аббревиатура типа населенного пункта
Ref string[50] REF города из справочника getSettlements
DeliveryCity string[50] REF города из справочника getCities, из которого осуществляется доставка

{
  "success": true,
  "data": [
    {
      "TotalCount": 9,
      "Addresses": [
        {
          "Warehouses": 568,
          "MainDescription": "Київ",
          "Area": "",
          "Region": "Київська",
          "SettlementTypeCode": "м.",
          "Ref": "e718a680-4b33-11e4-ab6d-005056801329",
          "DeliveryCity": "8d5a980d-391c-11dd-90d9-001a92567626"
        },
        {
          "Warehouses": 0,
          "MainDescription": "Київ",
          "Area": "Миколаївська",
          "Region": "Доманівський",
          "SettlementTypeCode": "с.",
          "Ref": "0db2df4b-4b3a-11e4-ab6d-005056801329",
          "DeliveryCity": "06f8795a-4079-11de-b509-001d92f78698"
        },
        {
          "Warehouses": 0,
          "MainDescription": "Київець",
          "Area": "Львівська",
          "Region": "Миколаївський",
          "SettlementTypeCode": "с.",
          "Ref": "0df25497-4b3a-11e4-ab6d-005056801329",
          "DeliveryCity": "acecfca8-1488-11df-8caf-000c2965ae0e"
        },
        {
          "Warehouses": 0,
          "MainDescription": "Київка",
          "Area": "Херсонська",
          "Region": "Голопристанський",
          "SettlementTypeCode": "с.",
          "Ref": "0dd153b3-4b3a-11e4-ab6d-005056801329",
          "DeliveryCity": "db5c88e7-391c-11dd-90d9-001a92567626"
        },
        {
          "Warehouses": 0,
          "MainDescription": "Київське",
          "Area": "Запорізька",
          "Region": "Новомиколаївський",
          "SettlementTypeCode": "с.",
          "Ref": "0e40bf5a-4b3a-11e4-ab6d-005056801329",
          "DeliveryCity": "cfbeaca4-4063-11de-b509-001d92f78698"
        },
        {
          "Warehouses": 0,
          "MainDescription": "Київське",
          "Area": "Миколаївська",
          "Region": "Баштанський",
          "SettlementTypeCode": "с.",
          "Ref": "0d94f546-4b3a-11e4-ab6d-005056801329",
          "DeliveryCity": "000655dc-4079-11de-b509-001d92f78698"
        }
      ]
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <TotalCount>9</TotalCount>
            <Addresses>
                <item>
                    <Warehouses>568</Warehouses>
                    <MainDescription>Київ</MainDescription>
                    <Area></Area>
                    <Region>Київська</Region>
                    <SettlementTypeCode>м.</SettlementTypeCode>
                    <Ref>e718a680-4b33-11e4-ab6d-005056801329</Ref>
                    <DeliveryCity>8d5a980d-391c-11dd-90d9-001a92567626</DeliveryCity>
                </item>
                <item>
                    <Warehouses>0</Warehouses>
                    <MainDescription>Київ</MainDescription>
                    <Area>Миколаївська</Area>
                    <Region>Доманівський</Region>
                    <SettlementTypeCode>с.</SettlementTypeCode>
                    <Ref>0db2df4b-4b3a-11e4-ab6d-005056801329</Ref>
                    <DeliveryCity>06f8795a-4079-11de-b509-001d92f78698</DeliveryCity>
                </item>
                <item>
                    <Warehouses>0</Warehouses>
                    <MainDescription>Київець</MainDescription>
                    <Area>Львівська</Area>
                    <Region>Миколаївський</Region>
                    <SettlementTypeCode>с.</SettlementTypeCode>
                    <Ref>0df25497-4b3a-11e4-ab6d-005056801329</Ref>
                    <DeliveryCity>acecfca8-1488-11df-8caf-000c2965ae0e</DeliveryCity>
                </item>
                <item>
                    <Warehouses>0</Warehouses>
                    <MainDescription>Київка</MainDescription>
                    <Area>Херсонська</Area>
                    <Region>Голопристанський</Region>
                    <SettlementTypeCode>с.</SettlementTypeCode>
                    <Ref>0dd153b3-4b3a-11e4-ab6d-005056801329</Ref>
                    <DeliveryCity>db5c88e7-391c-11dd-90d9-001a92567626</DeliveryCity>
                </item>
                <item>
                    <Warehouses>0</Warehouses>
                    <MainDescription>Київське</MainDescription>
                    <Area>Запорізька</Area>
                    <Region>Новомиколаївський</Region>
                    <SettlementTypeCode>с.</SettlementTypeCode>
                    <Ref>0e40bf5a-4b3a-11e4-ab6d-005056801329</Ref>
                    <DeliveryCity>cfbeaca4-4063-11de-b509-001d92f78698</DeliveryCity>
                </item>
            </Addresses>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>