> For the complete documentation index, see [llms.txt](https://api-portal.novapost.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-portal.novapost.com/api-docs-ua/zagalna-informaciya/adresi.md).
# Адреси
:link:[*Початок роботи з API*](https://api-portal.novapost.com/api-docs-ua)
## Онлайн-пошук вулиць у довіднику населених пунктів (JSON)
> Метод \*\*searchSettlementStreets\*\* працює в моделі \*\*Address\*\* (або \*\*AddressGeneral\*\*) та необхідний для \*\*онлайн-пошуку вулиць\*\* у вибраному населеному пункті.\
> \
> Завдяки цьому методу немає необхідності на своїй стороні зберігати довідники та здійснювати їхнє оновлення.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post — Address Service","version":"2.0.0"},"tags":[{"name":"Address"}],"servers":[{"description":"production","url":"https://api.novaposhta.ua/v2.0"}],"paths":{"/json":{"post":{"tags":["Address"],"summary":"Онлайн-пошук вулиць у довіднику населених пунктів (JSON)","description":"Метод **searchSettlementStreets** працює в моделі **Address** (або **AddressGeneral**) та необхідний для **онлайн-пошуку вулиць** у вибраному населеному пункті.\n\nЗавдяки цьому методу немає необхідності на своїй стороні зберігати довідники та здійснювати їхнє оновлення.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string"},"calledMethod":{"type":"string"},"methodProperties":{"type":"object","required":["StreetName","SettlementRef"],"properties":{"StreetName":{"type":"string","maxLength":36,"description":"Назва вулиці"},"SettlementRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) населеного пункту із довідника населених пунктів України"},"Limit":{"type":"string","maxLength":36,"description":"Кількість відповідей"}}}}}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"type":"object","required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Список знайдених результатів","items":{"$ref":"#/components/schemas/StreetDataItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки, що виникли під час виконання запиту","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень щодо виконання запиту","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}}}}}}}}},"components":{"schemas":{"StreetDataItem":{"type":"object","properties":{"TotalCount":{"type":"string","maxLength":36,"description":"Кількість знайдених об'єктів"},"Addresses":{"type":"array","description":"Масив об'єктів, що містить деталі кожної знайденої адреси","items":{"$ref":"#/components/schemas/StreetAddressItem"}}}},"StreetAddressItem":{"type":"object","properties":{"SettlementRef":{"type":"string","maxLength":50,"description":"Унікальний ідентифікатор (REF) населеного пункту"},"SettlementStreetRef":{"type":"string","maxLength":50,"description":"Унікальний ідентифікатор (REF) вулиці"},"SettlementStreetDescription":{"type":"string","maxLength":50,"description":"Назва вулиці"},"Present":{"type":"string","maxLength":50,"description":"Повна назва вулиці, що включає тип вулиці та її назву"},"StreetsType":{"type":"string","maxLength":50,"description":"Унікальний ідентифікатор (REF) типу вулиці"},"StreetsTypeDescription":{"type":"string","maxLength":50,"description":"Тип вулиці"},"Location":{"$ref":"#/components/schemas/Location"},"SettlementStreetDescriptionRu":{"type":"string","maxLength":50,"description":"Назва вулиці російською мовою"}}},"Location":{"type":"object","description":"Географічні координати","properties":{"lat":{"type":"number","format":"float","description":"Географічна широта локації"},"lon":{"type":"number","format":"float","description":"Географічна довгота локації"}}}}}}
```
## Онлайн-пошук вулиць у довіднику населених пунктів (XML)
> Метод \*\*searchSettlementStreets\*\* працює в моделі \*\*Address\*\* (або \*\*AddressGeneral\*\*) та дозволяє здійснювати \*\*онлайн-пошук вулиць\*\* у форматі XML.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post — Address Service","version":"2.0.0"},"tags":[{"name":"Address"}],"servers":[{"description":"production","url":"https://api.novaposhta.ua/v2.0"}],"paths":{"/xml":{"post":{"tags":["Address"],"summary":"Онлайн-пошук вулиць у довіднику населених пунктів (XML)","description":"Метод **searchSettlementStreets** працює в моделі **Address** (або **AddressGeneral**) та дозволяє здійснювати **онлайн-пошук вулиць** у форматі XML.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"type":"object","xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача","xml":{"name":"apiKey"}},"modelName":{"type":"string","xml":{"name":"modelName"}},"calledMethod":{"type":"string","xml":{"name":"calledMethod"}},"methodProperties":{"type":"object","xml":{"name":"methodProperties"},"required":["StreetName","SettlementRef"],"properties":{"StreetName":{"type":"string","maxLength":36,"description":"Назва вулиці","xml":{"name":"StreetName"}},"SettlementRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) населеного пункту","xml":{"name":"SettlementRef"}},"Limit":{"type":"string","maxLength":36,"description":"Кількість відповідей","xml":{"name":"Limit"}}}}}}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"type":"object","required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Список знайдених результатів","items":{"$ref":"#/components/schemas/StreetDataItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки, що виникли під час виконання запиту","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень щодо виконання запиту","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}}}}}}}}},"components":{"schemas":{"StreetDataItem":{"type":"object","properties":{"TotalCount":{"type":"string","maxLength":36,"description":"Кількість знайдених об'єктів"},"Addresses":{"type":"array","description":"Масив об'єктів, що містить деталі кожної знайденої адреси","items":{"$ref":"#/components/schemas/StreetAddressItem"}}}},"StreetAddressItem":{"type":"object","properties":{"SettlementRef":{"type":"string","maxLength":50,"description":"Унікальний ідентифікатор (REF) населеного пункту"},"SettlementStreetRef":{"type":"string","maxLength":50,"description":"Унікальний ідентифікатор (REF) вулиці"},"SettlementStreetDescription":{"type":"string","maxLength":50,"description":"Назва вулиці"},"Present":{"type":"string","maxLength":50,"description":"Повна назва вулиці, що включає тип вулиці та її назву"},"StreetsType":{"type":"string","maxLength":50,"description":"Унікальний ідентифікатор (REF) типу вулиці"},"StreetsTypeDescription":{"type":"string","maxLength":50,"description":"Тип вулиці"},"Location":{"$ref":"#/components/schemas/Location"},"SettlementStreetDescriptionRu":{"type":"string","maxLength":50,"description":"Назва вулиці російською мовою"}}},"Location":{"type":"object","description":"Географічні координати","properties":{"lat":{"type":"number","format":"float","description":"Географічна широта локації"},"lon":{"type":"number","format":"float","description":"Географічна довгота локації"}}}}}}
```
## Онлайн-пошук у довіднику населених пунктів (JSON)
> Метод \*\*searchSettlements\*\* працює в моделі \*\*Address\*\* (або \*\*AddressGeneral\*\*) та необхідний для \*\*онлайн-пошуку населених пунктів\*\*.\
> \
> Завдяки цьому методу немає необхідності на своїй стороні зберігати довідники та здійснювати їхнє оновлення.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post — Address Service","version":"2.0.0"},"tags":[{"name":"Address"}],"servers":[{"description":"production","url":"https://api.novaposhta.ua/v2.0"}],"paths":{"/json":{"post":{"tags":["Address"],"summary":"Онлайн-пошук у довіднику населених пунктів (JSON)","description":"Метод **searchSettlements** працює в моделі **Address** (або **AddressGeneral**) та необхідний для **онлайн-пошуку населених пунктів**.\n\nЗавдяки цьому методу немає необхідності на своїй стороні зберігати довідники та здійснювати їхнє оновлення.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string"},"calledMethod":{"type":"string"},"methodProperties":{"type":"object","required":["CityName","Limit","Page"],"properties":{"CityName":{"type":"string","maxLength":36,"description":"Назва населеного пункту або Індекс населеного пункту"},"Limit":{"type":"string","maxLength":36,"description":"Кількість записів на сторінці. Працює разом із параметром Page"},"Page":{"type":"string","maxLength":36,"description":"Сторінка, працює разом з параметром Limit"}}}}}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"type":"object","required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Список знайдених результатів","items":{"$ref":"#/components/schemas/SettlementDataItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки, що виникли під час виконання запиту","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень щодо виконання запиту","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}}}}}}}}},"components":{"schemas":{"SettlementDataItem":{"type":"object","properties":{"StreetsAvailability":{"type":"boolean","description":"Наявність довідника вулиць у населеному пункті"},"RegionTypesCode":{"type":"string","maxLength":36,"description":"Абревіатура типу району"},"AddressDeliveryAllowed":{"type":"boolean","description":"Ознака можливості адресної доставки"},"TotalCount":{"type":"string","maxLength":36,"description":"Кількість знайдених об'єктів"},"Addresses":{"type":"array","description":"Адреса","items":{"$ref":"#/components/schemas/AddressItem"}},"Warehouses":{"type":"string","maxLength":36,"description":"Кількість відділень"},"MainDescription":{"type":"string","maxLength":50,"description":"Назва населених пунктів"},"Area":{"type":"string","maxLength":50,"description":"Ознака області"},"Region":{"type":"string","maxLength":50,"description":"Ознака району"},"SettlementTypeCode":{"type":"string","maxLength":50,"description":"Абревіатура типу населеного пункту"},"Ref":{"type":"string","maxLength":50,"description":"Ідентифікатор (REF) міста із довідника getSettlements"},"DeliveryCity":{"type":"string","maxLength":50,"description":"Ідентифікатор (REF) міста із довідника getCities, з якого виконується доставка"},"Present":{"type":"string","maxLength":50,"description":"Повна назва населеного пункту"},"RegionTypes":{"type":"string","maxLength":36,"description":"Тип району"},"ParentRegionCode":{"type":"string","maxLength":36,"description":"Абревіатура типу області"},"ParentRegionTypes":{"type":"string","maxLength":36,"description":"Тип області"}}},"AddressItem":{"type":"object","properties":{"Present":{"type":"string","maxLength":50,"description":"Повна назва населеного пункту"},"Warehouses":{"type":"string","maxLength":36,"description":"Кількість відділень"},"MainDescription":{"type":"string","maxLength":50,"description":"Назва населених пунктів"},"Area":{"type":"string","maxLength":50,"description":"Ознака області"},"Region":{"type":"string","maxLength":50,"description":"Ознака району"},"SettlementTypeCode":{"type":"string","maxLength":50,"description":"Абревіатура типу населеного пункту"},"Ref":{"type":"string","maxLength":50,"description":"Ідентифікатор (REF) міста із довідника getSettlements"},"DeliveryCity":{"type":"string","maxLength":50,"description":"Ідентифікатор (REF) міста із довідника getCities, з якого виконується доставка"},"AddressDeliveryAllowed":{"type":"boolean","description":"Ознака можливості адресної доставки"},"StreetsAvailability":{"type":"boolean","description":"Наявність довідника вулиць у населеному пункті"},"ParentRegionTypes":{"type":"string","maxLength":36,"description":"Тип області"},"ParentRegionCode":{"type":"string","maxLength":36,"description":"Абревіатура типу області"},"RegionTypes":{"type":"string","maxLength":36,"description":"Тип району"},"RegionTypesCode":{"type":"string","maxLength":36,"description":"Абревіатура типу району"}}}}}}
```
## Онлайн-пошук у довіднику населених пунктів (XML)
> Метод \*\*searchSettlements\*\* працює в моделі \*\*Address\*\* (або \*\*AddressGeneral\*\*) та дозволяє здійснювати \*\*онлайн-пошук населених пунктів\*\* у форматі XML.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post — Address Service","version":"2.0.0"},"tags":[{"name":"Address"}],"servers":[{"description":"production","url":"https://api.novaposhta.ua/v2.0"}],"paths":{"/xml":{"post":{"tags":["Address"],"summary":"Онлайн-пошук у довіднику населених пунктів (XML)","description":"Метод **searchSettlements** працює в моделі **Address** (або **AddressGeneral**) та дозволяє здійснювати **онлайн-пошук населених пунктів** у форматі XML.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"type":"object","xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача","xml":{"name":"apiKey"}},"modelName":{"type":"string","xml":{"name":"modelName"}},"calledMethod":{"type":"string","xml":{"name":"calledMethod"}},"methodProperties":{"type":"object","xml":{"name":"methodProperties"},"required":["CityName","Limit","Page"],"properties":{"CityName":{"type":"string","maxLength":36,"description":"Назва населеного пункту або Індекс","xml":{"name":"CityName"}},"Limit":{"type":"string","maxLength":36,"description":"Кількість записів на сторінці","xml":{"name":"Limit"}},"Page":{"type":"string","maxLength":36,"description":"Номер сторінки","xml":{"name":"Page"}}}}}}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"type":"object","required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Список знайдених результатів","items":{"$ref":"#/components/schemas/SettlementDataItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки, що виникли під час виконання запиту","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень щодо виконання запиту","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}}}}}}}}},"components":{"schemas":{"SettlementDataItem":{"type":"object","properties":{"StreetsAvailability":{"type":"boolean","description":"Наявність довідника вулиць у населеному пункті"},"RegionTypesCode":{"type":"string","maxLength":36,"description":"Абревіатура типу району"},"AddressDeliveryAllowed":{"type":"boolean","description":"Ознака можливості адресної доставки"},"TotalCount":{"type":"string","maxLength":36,"description":"Кількість знайдених об'єктів"},"Addresses":{"type":"array","description":"Адреса","items":{"$ref":"#/components/schemas/AddressItem"}},"Warehouses":{"type":"string","maxLength":36,"description":"Кількість відділень"},"MainDescription":{"type":"string","maxLength":50,"description":"Назва населених пунктів"},"Area":{"type":"string","maxLength":50,"description":"Ознака області"},"Region":{"type":"string","maxLength":50,"description":"Ознака району"},"SettlementTypeCode":{"type":"string","maxLength":50,"description":"Абревіатура типу населеного пункту"},"Ref":{"type":"string","maxLength":50,"description":"Ідентифікатор (REF) міста із довідника getSettlements"},"DeliveryCity":{"type":"string","maxLength":50,"description":"Ідентифікатор (REF) міста із довідника getCities, з якого виконується доставка"},"Present":{"type":"string","maxLength":50,"description":"Повна назва населеного пункту"},"RegionTypes":{"type":"string","maxLength":36,"description":"Тип району"},"ParentRegionCode":{"type":"string","maxLength":36,"description":"Абревіатура типу області"},"ParentRegionTypes":{"type":"string","maxLength":36,"description":"Тип області"}}},"AddressItem":{"type":"object","properties":{"Present":{"type":"string","maxLength":50,"description":"Повна назва населеного пункту"},"Warehouses":{"type":"string","maxLength":36,"description":"Кількість відділень"},"MainDescription":{"type":"string","maxLength":50,"description":"Назва населених пунктів"},"Area":{"type":"string","maxLength":50,"description":"Ознака області"},"Region":{"type":"string","maxLength":50,"description":"Ознака району"},"SettlementTypeCode":{"type":"string","maxLength":50,"description":"Абревіатура типу населеного пункту"},"Ref":{"type":"string","maxLength":50,"description":"Ідентифікатор (REF) міста із довідника getSettlements"},"DeliveryCity":{"type":"string","maxLength":50,"description":"Ідентифікатор (REF) міста із довідника getCities, з якого виконується доставка"},"AddressDeliveryAllowed":{"type":"boolean","description":"Ознака можливості адресної доставки"},"StreetsAvailability":{"type":"boolean","description":"Наявність довідника вулиць у населеному пункті"},"ParentRegionTypes":{"type":"string","maxLength":36,"description":"Тип області"},"ParentRegionCode":{"type":"string","maxLength":36,"description":"Абревіатура типу області"},"RegionTypes":{"type":"string","maxLength":36,"description":"Тип району"},"RegionTypesCode":{"type":"string","maxLength":36,"description":"Абревіатура типу району"}}}}}}
```
## Створити адресу контрагента (відправник / одержувач) (JSON)
> Метод \*\*save\*\* працює в моделі \*\*AddressGeneral\*\* (або \*\*Address\*\*). Цей метод зберігає адресу контрагента (отримувача чи відправника).
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post — Address Service","version":"2.0.0"},"tags":[{"name":"Address"}],"servers":[{"description":"production","url":"https://api.novaposhta.ua/v2.0"}],"paths":{"/json":{"post":{"tags":["Address"],"summary":"Створити адресу контрагента (відправник / одержувач) (JSON)","description":"Метод **save** працює в моделі **AddressGeneral** (або **Address**). Цей метод зберігає адресу контрагента (отримувача чи відправника).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string"},"calledMethod":{"type":"string"},"methodProperties":{"type":"object","required":["CounterpartyRef","StreetRef","BuildingNumber","Flat"],"properties":{"CounterpartyRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контрагента"},"StreetRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) вулиці, дані з довідника вулиць компанії"},"BuildingNumber":{"type":"string","maxLength":36,"description":"Номер будинку"},"Flat":{"type":"string","maxLength":36,"description":"Номер квартири"},"Note":{"type":"string","maxLength":40,"description":"Коментар"}}}}}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"type":"object","required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Список результатiв створення","items":{"$ref":"#/components/schemas/SavedAddressItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки, що виникли під час виконання запиту","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень щодо виконання запиту","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}}}}}}}}},"components":{"schemas":{"SavedAddressItem":{"type":"object","properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси"},"Description":{"type":"string","maxLength":50,"description":"Опис адреси"}}}}}}
```
## Створити адресу контрагента (відправник / одержувач) (XML)
> Метод \*\*save\*\* працює в моделі \*\*AddressGeneral\*\* (або \*\*Address\*\*) та зберігає адресу контрагента у форматі XML.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post — Address Service","version":"2.0.0"},"tags":[{"name":"Address"}],"servers":[{"description":"production","url":"https://api.novaposhta.ua/v2.0"}],"paths":{"/xml":{"post":{"tags":["Address"],"summary":"Створити адресу контрагента (відправник / одержувач) (XML)","description":"Метод **save** працює в моделі **AddressGeneral** (або **Address**) та зберігає адресу контрагента у форматі XML.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"type":"object","xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача","xml":{"name":"apiKey"}},"modelName":{"type":"string","xml":{"name":"modelName"}},"calledMethod":{"type":"string","xml":{"name":"calledMethod"}},"methodProperties":{"type":"object","xml":{"name":"methodProperties"},"required":["CounterpartyRef","StreetRef","BuildingNumber","Flat"],"properties":{"CounterpartyRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контрагента","xml":{"name":"CounterpartyRef"}},"StreetRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) вулиці, дані з довідника вулиць компанії","xml":{"name":"StreetRef"}},"BuildingNumber":{"type":"string","maxLength":36,"description":"Номер будинку","xml":{"name":"BuildingNumber"}},"Flat":{"type":"string","maxLength":36,"description":"Номер квартири","xml":{"name":"Flat"}},"Note":{"type":"string","maxLength":40,"description":"Коментар","xml":{"name":"Note"}}}}}}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"type":"object","required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Список результатiв створення","items":{"$ref":"#/components/schemas/SavedAddressItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки, що виникли під час виконання запиту","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень щодо виконання запиту","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}}}}}}}}},"components":{"schemas":{"SavedAddressItem":{"type":"object","properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси"},"Description":{"type":"string","maxLength":50,"description":"Опис адреси"}}}}}}
```
## Видалити адресу контрагента (відправник / одержувач) (JSON)
> Метод \*\*delete\*\* працює в моделі \*\*AddressGeneral\*\* (або \*\*Address\*\*). Цей метод необхідний для видалення адреси контрагента (відправника чи отримувача).\
> \
> Редагувати або видаляти дані контрагента можна лише з моменту його створення та до моменту створення інтернет-документа (ІД) із цим контрагентом.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post — Address Service","version":"2.0.0"},"tags":[{"name":"Address"}],"servers":[{"description":"production","url":"https://api.novaposhta.ua/v2.0"}],"paths":{"/json":{"post":{"tags":["Address"],"summary":"Видалити адресу контрагента (відправник / одержувач) (JSON)","description":"Метод **delete** працює в моделі **AddressGeneral** (або **Address**). Цей метод необхідний для видалення адреси контрагента (відправника чи отримувача).\n\nРедагувати або видаляти дані контрагента можна лише з моменту його створення та до моменту створення інтернет-документа (ІД) із цим контрагентом.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string"},"calledMethod":{"type":"string"},"methodProperties":{"type":"object","required":["Ref"],"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси"}}}}}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"type":"object","required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Список результатів видалення","items":{"$ref":"#/components/schemas/DeletedAddressItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки, що виникли під час виконання запиту","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень щодо виконання запиту","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}}}}}}}}},"components":{"schemas":{"DeletedAddressItem":{"type":"object","properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси"}}}}}}
```
## Видалити адресу контрагента (відправник / одержувач) (XML)
> Метод \*\*delete\*\* працює в моделі \*\*AddressGeneral\*\* (або \*\*Address\*\*). Цей метод необхідний для видалення адреси контрагента (відправника чи отримувача).\
> \
> Редагувати або видаляти дані контрагента можна лише з моменту його створення та до моменту створення інтернет-документа (ІД) із цим контрагентом.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post — Address Service","version":"2.0.0"},"tags":[{"name":"Address"}],"servers":[{"description":"production","url":"https://api.novaposhta.ua/v2.0"}],"paths":{"/xml":{"post":{"tags":["Address"],"summary":"Видалити адресу контрагента (відправник / одержувач) (XML)","description":"Метод **delete** працює в моделі **AddressGeneral** (або **Address**). Цей метод необхідний для видалення адреси контрагента (відправника чи отримувача).\n\nРедагувати або видаляти дані контрагента можна лише з моменту його створення та до моменту створення інтернет-документа (ІД) із цим контрагентом.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"type":"object","xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача","xml":{"name":"apiKey"}},"modelName":{"type":"string","xml":{"name":"modelName"}},"calledMethod":{"type":"string","xml":{"name":"calledMethod"}},"methodProperties":{"type":"object","xml":{"name":"methodProperties"},"required":["Ref"],"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси","xml":{"name":"Ref"}}}}}}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"type":"object","required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Список результатів видалення","items":{"$ref":"#/components/schemas/DeletedAddressItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки, що виникли під час виконання запиту","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень щодо виконання запиту","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}}}}}}}}},"components":{"schemas":{"DeletedAddressItem":{"type":"object","properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси"}}}}}}
```
## Редагувати адресу контрагента (JSON)
> Метод \*\*update\*\* моделі \*\*AddressGeneral\*\* (або \*\*Address\*\*) дозволяє оновити адресу контрагента (відправника чи отримувача).\
> \
> \*\*Умова виконання:\*\* Редагувати дані контрагента можна лише від моменту його створення та до моменту створення інтернет-документа (ІД) із цим контрагентом.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами контрагентів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Address"],"operationId":"updateAddressJson","summary":"Редагувати адресу контрагента (JSON)","description":"Метод **update** моделі **AddressGeneral** (або **Address**) дозволяє оновити адресу контрагента (відправника чи отримувача).\n\n**Умова виконання:** Редагувати дані контрагента можна лише від моменту його створення та до моменту створення інтернет-документа (ІД) із цим контрагентом.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAddressJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAddressResponse"}}}}}}}},"components":{"schemas":{"UpdateAddressJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AddressGeneral","Address"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["update"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/UpdateAddressMethodProperties"}}},"UpdateAddressMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref"],"properties":{"CounterpartyRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контрагента"},"StreetRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) вулиці"},"BuildingNumber":{"type":"string","maxLength":36,"description":"Номер будинку"},"Flat":{"type":"string","maxLength":36,"description":"Квартира"},"Note":{"type":"string","maxLength":40,"description":"Коментар"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси"}}},"UpdateAddressResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив з оновленою інформацією про адресу","items":{"$ref":"#/components/schemas/AddressItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"AddressItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси"},"Description":{"type":"string","maxLength":50,"description":"Адреса"}}}}}}
```
## Редагувати адресу контрагента (XML)
> Метод \*\*update\*\* моделі \*\*AddressGeneral\*\* (або \*\*Address\*\*) дозволяє оновити адресу контрагента (відправника чи отримувача) у форматі XML.\
> \
> \*\*Умова виконання:\*\* Редагувати дані контрагента можна лише від моменту його створення та до моменту створення інтернет-документа (ІД) із цим контрагентом.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами контрагентів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Address"],"operationId":"updateAddressXml","summary":"Редагувати адресу контрагента (XML)","description":"Метод **update** моделі **AddressGeneral** (або **Address**) дозволяє оновити адресу контрагента (відправника чи отримувача) у форматі XML.\n\n**Умова виконання:** Редагувати дані контрагента можна лише від моменту його створення та до моменту створення інтернет-документа (ІД) із цим контрагентом.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateAddressXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateAddressXmlResponse"}}}}}}}},"components":{"schemas":{"UpdateAddressXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AddressGeneral","Address"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["update"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/UpdateAddressXmlMethodProperties"}}},"UpdateAddressXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/UpdateAddressMethodProperties"}],"xml":{"name":"methodProperties"}},"UpdateAddressMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref"],"properties":{"CounterpartyRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контрагента"},"StreetRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) вулиці"},"BuildingNumber":{"type":"string","maxLength":36,"description":"Номер будинку"},"Flat":{"type":"string","maxLength":36,"description":"Квартира"},"Note":{"type":"string","maxLength":40,"description":"Коментар"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси"}}},"UpdateAddressXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив з оновленою інформацією про адресу","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/AddressXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"AddressXmlItem":{"allOf":[{"$ref":"#/components/schemas/AddressItem"}],"xml":{"name":"item"}},"AddressItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси"},"Description":{"type":"string","maxLength":50,"description":"Адреса"}}}}}}
```
## Отримати довідник населених пунктів (JSON)
> Метод \*\*getSettlements\*\* працює в моделі \*\*AddressGeneral\*\* (або \*\*Address\*\*) та надає можливість завантажити довідник міст України, до яких здійснюється доставка вантажів компанією «Нова пошта».\
> \
> \*\*Важлива інформація та обмеження:\*\*\
> \- Відповідь містить область та район для кожного населеного пункту.\
> \- Метод повертає не більше 150 записів на сторінку. Для перегляду більш ніж 150 записів необхідно використовувати параметр \`Page\` разом із параметром \`Limit\`.\
> \- Підтримується пошук за рядком за допомогою параметра \`FindByString\`. Пошук можливий \*\*лише українською мовою\*\*.\
> \- Параметр \`Warehouse\` зі значенням «1» або «0» дозволяє відобразити лише ті населені пункти, в яких є відділення компанії «Нова пошта».\
> \- Необхідно зберігати копію довідника на стороні клієнта та підтримувати його в актуальному стані. Рекомендовано проводити оновлення довідників раз на місяць.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами та довідниками населених пунктів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Address"],"operationId":"getSettlementsJson","summary":"Отримати довідник населених пунктів (JSON)","description":"Метод **getSettlements** працює в моделі **AddressGeneral** (або **Address**) та надає можливість завантажити довідник міст України, до яких здійснюється доставка вантажів компанією «Нова пошта».\n\n**Важлива інформація та обмеження:**\n- Відповідь містить область та район для кожного населеного пункту.\n- Метод повертає не більше 150 записів на сторінку. Для перегляду більш ніж 150 записів необхідно використовувати параметр `Page` разом із параметром `Limit`.\n- Підтримується пошук за рядком за допомогою параметра `FindByString`. Пошук можливий **лише українською мовою**.\n- Параметр `Warehouse` зі значенням «1» або «0» дозволяє відобразити лише ті населені пункти, в яких є відділення компанії «Нова пошта».\n- Необхідно зберігати копію довідника на стороні клієнта та підтримувати його в актуальному стані. Рекомендовано проводити оновлення довідників раз на місяць.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSettlementsJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSettlementsResponse"}}}}}}}},"components":{"schemas":{"GetSettlementsJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AddressGeneral","Address"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getSettlements"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetSettlementsMethodProperties"}}},"GetSettlementsMethodProperties":{"type":"object","additionalProperties":false,"properties":{"AreaRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (`REF`) області"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (`REF`) населеного пункту"},"RegionRef":{"type":"string","maxLength":36,"description":"Фільтр за ідентифікатором (`REF`) району"},"Page":{"type":"string","maxLength":36,"description":"Номер сторінки"},"Warehouse":{"type":"string","maxLength":36,"description":"Фільтр наявності відділення (1 — наявне відділення, 0 — відсутнє)"},"FindByString":{"type":"string","maxLength":36,"description":"Пошук за рядками, тільки українською мовою"},"Limit":{"type":"string","maxLength":36,"description":"Кількість відповідей на сторінку (не більше 150)"}}},"GetSettlementsResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив населених пунктів","items":{"$ref":"#/components/schemas/SettlementItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"SettlementItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (`REF`) населеного пункту"},"SettlementType":{"type":"string","maxLength":36,"description":"Тип населеного пункту"},"Latitude":{"type":"string","maxLength":36,"description":"Широта"},"Longitude":{"type":"string","maxLength":36,"description":"Довгота"},"Description":{"type":"string","maxLength":50,"description":"Адреса українською мовою"},"DescriptionRu":{"type":"string","maxLength":50,"description":"Адреса російською мовою"},"SettlementTypeDescription":{"type":"string","maxLength":36,"description":"Тип населеного пункту українською мовою"},"SettlementTypeDescriptionRu":{"type":"string","maxLength":36,"description":"Тип населеного пункту російською мовою"},"Region":{"type":"string","maxLength":36,"description":"Код населеного пункту"},"RegionsDescription":{"type":"string","maxLength":50,"description":"Область українською мовою"},"RegionsDescriptionRu":{"type":"string","maxLength":50,"description":"Область російською мовою"},"Area":{"type":"string","maxLength":36,"description":"Позначення області"},"AreaDescription":{"type":"string","maxLength":50,"description":"Опис області українською мовою"},"AreaDescriptionRu":{"type":"string","maxLength":50,"description":"Опис області російською мовою"},"Index1":{"type":"string","maxLength":10,"description":"Індекс"},"Index2":{"type":"string","maxLength":10,"description":"Індекс"},"IndexCOATSU1":{"type":"string","maxLength":36,"description":"Діапазон індексів КОАТУУ"},"Delivery1":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery2":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery3":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery4":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery5":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery6":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery7":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Warehouse":{"type":"string","maxLength":36,"description":"Наявність відділень"},"Conglomerates":{"type":"array","description":"Конгломерати","items":{"type":"string"}}}}}}}
```
## Отримати довідник населених пунктів (XML)
> Метод \*\*getSettlements\*\* працює в моделі \*\*AddressGeneral\*\* (або \*\*Address\*\*) та надає можливість завантажити довідник міст України, до яких здійснюється доставка вантажів компанією «Нова пошта».\
> \
> \*\*Важлива інформація та обмеження:\*\*\
> \- Відповідь містить область та район для кожного населеного пункту.\
> \- Метод повертає не більше 150 записів на сторінку. Для перегляду більш ніж 150 записів необхідно використовувати параметр \`Page\` разом із параметром \`Limit\`.\
> \- Підтримується пошук за рядком за допомогою параметра \`FindByString\`. Пошук можливий \*\*лише українською мовою\*\*.\
> \- Параметр \`Warehouse\` зі значенням «1» або «0» дозволяє відобразити лише ті населені пункти, в яких є відділення компанії «Нова пошта».\
> \- Необхідно зберігати копію довідника на стороні клієнта та підтримувати його в актуальному стані. Рекомендовано проводити оновлення довідників раз на місяць.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами та довідниками населених пунктів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Address"],"operationId":"getSettlementsXml","summary":"Отримати довідник населених пунктів (XML)","description":"Метод **getSettlements** працює в моделі **AddressGeneral** (або **Address**) та надає можливість завантажити довідник міст України, до яких здійснюється доставка вантажів компанією «Нова пошта».\n\n**Важлива інформація та обмеження:**\n- Відповідь містить область та район для кожного населеного пункту.\n- Метод повертає не більше 150 записів на сторінку. Для перегляду більш ніж 150 записів необхідно використовувати параметр `Page` разом із параметром `Limit`.\n- Підтримується пошук за рядком за допомогою параметра `FindByString`. Пошук можливий **лише українською мовою**.\n- Параметр `Warehouse` зі значенням «1» або «0» дозволяє відобразити лише ті населені пункти, в яких є відділення компанії «Нова пошта».\n- Необхідно зберігати копію довідника на стороні клієнта та підтримувати його в актуальному стані. Рекомендовано проводити оновлення довідників раз на місяць.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetSettlementsXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetSettlementsXmlResponse"}}}}}}}},"components":{"schemas":{"GetSettlementsXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AddressGeneral","Address"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getSettlements"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetSettlementsXmlMethodProperties"}}},"GetSettlementsXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetSettlementsMethodProperties"}],"xml":{"name":"methodProperties"}},"GetSettlementsMethodProperties":{"type":"object","additionalProperties":false,"properties":{"AreaRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (`REF`) області"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (`REF`) населеного пункту"},"RegionRef":{"type":"string","maxLength":36,"description":"Фільтр за ідентифікатором (`REF`) району"},"Page":{"type":"string","maxLength":36,"description":"Номер сторінки"},"Warehouse":{"type":"string","maxLength":36,"description":"Фільтр наявності відділення (1 — наявне відділення, 0 — відсутнє)"},"FindByString":{"type":"string","maxLength":36,"description":"Пошук за рядками, тільки українською мовою"},"Limit":{"type":"string","maxLength":36,"description":"Кількість відповідей на сторінку (не більше 150)"}}},"GetSettlementsXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив населених пунктів","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/SettlementXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"SettlementXmlItem":{"allOf":[{"$ref":"#/components/schemas/SettlementItem"}],"xml":{"name":"item"},"properties":{"Conglomerates":{"type":"array","description":"Конгломерати","xml":{"name":"Conglomerates","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"SettlementItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (`REF`) населеного пункту"},"SettlementType":{"type":"string","maxLength":36,"description":"Тип населеного пункту"},"Latitude":{"type":"string","maxLength":36,"description":"Широта"},"Longitude":{"type":"string","maxLength":36,"description":"Довгота"},"Description":{"type":"string","maxLength":50,"description":"Адреса українською мовою"},"DescriptionRu":{"type":"string","maxLength":50,"description":"Адреса російською мовою"},"SettlementTypeDescription":{"type":"string","maxLength":36,"description":"Тип населеного пункту українською мовою"},"SettlementTypeDescriptionRu":{"type":"string","maxLength":36,"description":"Тип населеного пункту російською мовою"},"Region":{"type":"string","maxLength":36,"description":"Код населеного пункту"},"RegionsDescription":{"type":"string","maxLength":50,"description":"Область українською мовою"},"RegionsDescriptionRu":{"type":"string","maxLength":50,"description":"Область російською мовою"},"Area":{"type":"string","maxLength":36,"description":"Позначення області"},"AreaDescription":{"type":"string","maxLength":50,"description":"Опис області українською мовою"},"AreaDescriptionRu":{"type":"string","maxLength":50,"description":"Опис області російською мовою"},"Index1":{"type":"string","maxLength":10,"description":"Індекс"},"Index2":{"type":"string","maxLength":10,"description":"Індекс"},"IndexCOATSU1":{"type":"string","maxLength":36,"description":"Діапазон індексів КОАТУУ"},"Delivery1":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery2":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery3":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery4":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery5":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery6":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery7":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Warehouse":{"type":"string","maxLength":36,"description":"Наявність відділень"},"Conglomerates":{"type":"array","description":"Конгломерати","items":{"type":"string"}}}}}}}
```
## Отримати довідник міст компанії (JSON)
> \
> Метод \*\*getCities\*\* працює в моделі \*\*Address\*\* (або \*\*AddressGeneral\*\*) та завантажує довідник населених пунктів України, де є відділення компанії «Нова пошта» і можна оформити доставку на відділення чи за адресою.\
> \
> \*\*Важлива інформація та обмеження:\*\*\
> \- Щоб знайти конкретний населений пункт, потрібно в значенні параметра \`FindByString\` (пошук за рядками) задати назву.\
> \- Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. Рекомендовано оновлювати довідники щодня.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами та довідниками населених пунктів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Address"],"operationId":"getCitiesJson","summary":"Отримати довідник міст компанії (JSON)","description":"\nМетод **getCities** працює в моделі **Address** (або **AddressGeneral**) та завантажує довідник населених пунктів України, де є відділення компанії «Нова пошта» і можна оформити доставку на відділення чи за адресою.\n\n**Важлива інформація та обмеження:**\n- Щоб знайти конкретний населений пункт, потрібно в значенні параметра `FindByString` (пошук за рядками) задати назву.\n- Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. Рекомендовано оновлювати довідники щодня.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCitiesJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCitiesResponse"}}}}}}}},"components":{"schemas":{"GetCitiesJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["Address","AddressGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getCities"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetCitiesMethodProperties"}}},"GetCitiesMethodProperties":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор міста"},"Page":{"type":"string","maxLength":36,"description":"Номер сторінки для відображення"},"FindByString":{"type":"string","maxLength":36,"description":"Пошук за назвою міста"},"Limit":{"type":"string","maxLength":36,"description":"Кількість записів на сторінці. Працює разом із параметром Page"}}},"GetCitiesResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив міст","items":{"$ref":"#/components/schemas/CityItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"CityItem":{"type":"object","additionalProperties":false,"properties":{"Description":{"type":"string","maxLength":50,"description":"Місто українською мовою"},"DescriptionRu":{"type":"string","maxLength":50,"description":"Місто російською мовою"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор міста"},"Delivery1":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery2":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery3":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery4":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery5":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery6":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery7":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Area":{"type":"string","maxLength":36,"description":"Область"},"SettlementType":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) типу населеного пункту"},"IsBranch":{"type":"string","maxLength":36,"description":"Показник належності міста до філіальної мережі компанії «Нова пошта» (1 — філіал, 0 — партнер)"},"PreventEntryNewStreetsUser":{"type":"string","nullable":true,"maxLength":36,"description":"Ознака налаштування «Заборонити введення нових вулиць користувачем» (1 — так, 0 — ні)"},"Conglomerates":{"type":"string","nullable":true,"maxLength":36,"description":"Конгломерат"},"CityID":{"type":"string","maxLength":36,"description":"Код міста"},"SettlementTypeDescriptionRu":{"type":"string","maxLength":36,"description":"Опис типу населеного пункту російською мовою"},"SettlementTypeDescription":{"type":"string","maxLength":36,"description":"Опис типу населеного пункту українською мовою"}}}}}}
```
## Отримати довідник міст компанії (XML)
> \
> Метод \*\*getCities\*\* працює в моделі \*\*Address\*\* (або \*\*AddressGeneral\*\*) та завантажує довідник населених пунктів України, де є відділення компанії «Нова пошта» і можна оформити доставку на відділення чи за адресою.\
> \
> \*\*Важлива інформація та обмеження:\*\*\
> \- Щоб знайти конкретний населений пункт, потрібно в значенні параметра \`FindByString\` (пошук за рядками) задати назву.\
> \- Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. Рекомендовано оновлювати довідники щодня.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами та довідниками населених пунктів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Address"],"operationId":"getCitiesXml","summary":"Отримати довідник міст компанії (XML)","description":"\nМетод **getCities** працює в моделі **Address** (або **AddressGeneral**) та завантажує довідник населених пунктів України, де є відділення компанії «Нова пошта» і можна оформити доставку на відділення чи за адресою.\n\n**Важлива інформація та обмеження:**\n- Щоб знайти конкретний населений пункт, потрібно в значенні параметра `FindByString` (пошук за рядками) задати назву.\n- Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. Рекомендовано оновлювати довідники щодня.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetCitiesXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetCitiesXmlResponse"}}}}}}}},"components":{"schemas":{"GetCitiesXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["Address","AddressGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getCities"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetCitiesXmlMethodProperties"}}},"GetCitiesXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetCitiesMethodProperties"}],"xml":{"name":"methodProperties"}},"GetCitiesMethodProperties":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор міста"},"Page":{"type":"string","maxLength":36,"description":"Номер сторінки для відображення"},"FindByString":{"type":"string","maxLength":36,"description":"Пошук за назвою міста"},"Limit":{"type":"string","maxLength":36,"description":"Кількість записів на сторінці. Працює разом із параметром Page"}}},"GetCitiesXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив міст","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/CityXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"CityXmlItem":{"allOf":[{"$ref":"#/components/schemas/CityItem"}],"xml":{"name":"item"}},"CityItem":{"type":"object","additionalProperties":false,"properties":{"Description":{"type":"string","maxLength":50,"description":"Місто українською мовою"},"DescriptionRu":{"type":"string","maxLength":50,"description":"Місто російською мовою"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор міста"},"Delivery1":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery2":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery3":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery4":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery5":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery6":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Delivery7":{"type":"string","maxLength":36,"description":"Наявність доставки відправлення в днях тижня"},"Area":{"type":"string","maxLength":36,"description":"Область"},"SettlementType":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) типу населеного пункту"},"IsBranch":{"type":"string","maxLength":36,"description":"Показник належності міста до філіальної мережі компанії «Нова пошта» (1 — філіал, 0 — партнер)"},"PreventEntryNewStreetsUser":{"type":"string","nullable":true,"maxLength":36,"description":"Ознака налаштування «Заборонити введення нових вулиць користувачем» (1 — так, 0 — ні)"},"Conglomerates":{"type":"string","nullable":true,"maxLength":36,"description":"Конгломерат"},"CityID":{"type":"string","maxLength":36,"description":"Код міста"},"SettlementTypeDescriptionRu":{"type":"string","maxLength":36,"description":"Опис типу населеного пункту російською мовою"},"SettlementTypeDescription":{"type":"string","maxLength":36,"description":"Опис типу населеного пункту українською мовою"}}}}}}
```
## Отримати довідник географічних областей України (JSON)
> Метод \*\*getAreas\*\* працює в моделі \*\*Address\*\* (або \*\*AddressGeneral\*\*) та завантажує довідник географічних областей України, де є відділення компанії «Нова пошта».\
> \
> \*\*Важлива інформація та обмеження:\*\*\
> \- Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані.\
> \- Рекомендовано оновлювати довідник щомісяця.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами та довідниками населених пунктів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Address"],"operationId":"getAreasJson","summary":"Отримати довідник географічних областей України (JSON)","description":"Метод **getAreas** працює в моделі **Address** (або **AddressGeneral**) та завантажує довідник географічних областей України, де є відділення компанії «Нова пошта».\n\n**Важлива інформація та обмеження:**\n- Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані.\n- Рекомендовано оновлювати довідник щомісяця.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAreasJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAreasResponse"}}}}}}}},"components":{"schemas":{"GetAreasJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["Address","AddressGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getAreas"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetAreasMethodProperties"}}},"GetAreasMethodProperties":{"type":"object","additionalProperties":false,"properties":{}},"GetAreasResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив областей","items":{"$ref":"#/components/schemas/AreaItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"AreaItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) області"},"AreasCenter":{"type":"string","maxLength":36,"description":"Ідентифікатор міста, яке є обласним центром"},"DescriptionRu":{"type":"string","maxLength":50,"description":"Опис російською мовою"},"Description":{"type":"string","maxLength":50,"description":"Опис українською мовою"}}}}}}
```
## Отримати довідник географічних областей України (XML)
> Метод \*\*getAreas\*\* працює в моделі \*\*Address\*\* (або \*\*AddressGeneral\*\*) та завантажує довідник географічних областей України, де є відділення компанії «Нова пошта».\
> \
> \*\*Важлива інформація та обмеження:\*\*\
> \- Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані.\
> \- Рекомендовано оновлювати довідник щомісяця.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами та довідниками населених пунктів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Address"],"operationId":"getAreasXml","summary":"Отримати довідник географічних областей України (XML)","description":"Метод **getAreas** працює в моделі **Address** (або **AddressGeneral**) та завантажує довідник географічних областей України, де є відділення компанії «Нова пошта».\n\n**Важлива інформація та обмеження:**\n- Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані.\n- Рекомендовано оновлювати довідник щомісяця.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetAreasXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetAreasXmlResponse"}}}}}}}},"components":{"schemas":{"GetAreasXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["Address","AddressGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getAreas"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetAreasXmlMethodProperties"}}},"GetAreasXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetAreasMethodProperties"}],"xml":{"name":"methodProperties"}},"GetAreasMethodProperties":{"type":"object","additionalProperties":false,"properties":{}},"GetAreasXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив областей","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/AreaXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"AreaXmlItem":{"allOf":[{"$ref":"#/components/schemas/AreaItem"}],"xml":{"name":"item"}},"AreaItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) області"},"AreasCenter":{"type":"string","maxLength":36,"description":"Ідентифікатор міста, яке є обласним центром"},"DescriptionRu":{"type":"string","maxLength":50,"description":"Опис російською мовою"},"Description":{"type":"string","maxLength":50,"description":"Опис українською мовою"}}}}}}
```
## Отримати довідник відділень та поштоматів (JSON)
> Метод \*\*getWarehouses\*\* працює в моделі \*\*Address\*\* (або \*\*AddressGeneral\*\*) та завантажує довідник відділень компанії «Нова пошта» у контексті населених пунктів України.\
> \
> \\
> \\Особливості роботи та обробка відповідей\\
\
> \
> \- \*\*HTTP 303 Redirect / Динамічна обробка:\*\* Рекомендований формат запиту — POST. Запит повертає HTTP 303 Redirect із посиланням на кешований файл, що містить актуальні дані. Для коректного отримання даних необхідно враховувати, що для різних міст можуть використовуватися різні типи відповіді. У деяких випадках дані доступні за редіректом на кешований файл, в інших — повертаються безпосередньо. Список міст, для яких працює редірект, може змінюватися. Тому рекомендовано динамічно обробляти відповіді API.\
> \- \*\*Обмеження та посторінкове завантаження:\*\* Оскільки кількість записів у відповіді обмежена (не більше 6500), рекомендується виконувати окремі запити для поштових та вантажних відділень, а також поштоматів (за допомогою фільтра \`TypeOfWarehouseRef\` (див. метод \*\*getWarehouseTypes\*\*)). Також довідник можна завантажувати посторінково за допомогою параметрів \`Page\` та \`Limit\` (не більше 500 записів на сторінку). Умова завершення циклу — порожній блок даних.\
> \- \*\*Актуальність даних:\*\* Регулярне щоденне оновлення довідника є необхідним для того, щоб користувачі мали доступ до актуальних даних про всі наявні відділення та поштомати.\
> \ \
> \
> \\
> \\Рекомендації для забезпечення відображення актуальних даних\\
\
> \
> 1\. \*\*Налаштуйте регулярне оновлення довідника:\*\* Рекомендовано налаштувати регламентне оновлення довідника всіх складів, відділень та поштоматів щоночі для забезпечення актуальності інформації.\
> 2\. \*\*Протестуйте коректність роботи оновлення:\*\* Після впровадження функції оновлення слід переконатися, що пошук на сайті відображає всі відділення, включно з пошуком за містами та типом складу.\
> 3\. \*\*Реалізуйте ручний пошук:\*\* Для зручності користувачів рекомендовано використовувати фільтрацію за типом та номером відділення. Це дозволить клієнтам швидко знаходити необхідні пункти доставки та відправки.\
> \ \
> \
> \\
> \\Фільтрація та параметри пошуку відділень\\
\
> \
> Є можливість знайти необхідні відділення за такими значеннями:\
> \- \`TypeOfWarehouseRef\` (див. метод \*\*getWarehouseTypes\*\*) — тип відділення\
> \- \`PostFinance\` — наявність каси NovaPay\
> \- \`BicycleParking\` — наявність паркування\
> \- \`POSTerminal\` — наявність пос-термінала\
> \- \`CityName\` — пошук за назвою населеного пункту\
> \- \`CityRef\` — пошук за ідентифікатором населеного пункту\
> \- \`CityName\` та \`FindByString\` — пошук конкретного відділення у вибраному населеному пункті або ж за ідентифікатором відділення\
> \- \`WarehouseId\` — пошук відділення за його номером\
> \- \`SettlementRef\` — для отримання відділень у конкретному населеному пункті (значення \`SettlementRef\` відображається у відповіді запиту \*\*getSettlements\*\*)\
> \- \`Ref\` — ідентифікатор відділення із довідника відділень\
> \
> \
\
> \Приклад використання перелічених параметрів у запиті:\\
> \\{\
> "methodProperties": {\
> "BicycleParking": "1",\
> "TypeOfWarehouseRef": "9a68df70-0267-42a8-bb5c-37f427e36ee4",\
> "PostFinance": "1",\
> "CityName": "Київ",\
> "CityRef": "20982d74-9b6c-11e2-a57a-d4ae527baec3",\
> "WarehouseId": "151",\
> "FindByString": "Відділення №8",\
> "Ref": "47402ec5-e1c2-11e3-8c4a-0050568002cf",\
> "SettlementRef": "e71629ab-4b33-11e4-ab6d-005056801329"\
> }\
> }\\
\
> \
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами та довідниками населених пунктів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Address"],"operationId":"getWarehousesJson","summary":"Отримати довідник відділень та поштоматів (JSON)","description":"Метод **getWarehouses** працює в моделі **Address** (або **AddressGeneral**) та завантажує довідник відділень компанії «Нова пошта» у контексті населених пунктів України.\n\n\nОсобливості роботи та обробка відповідей
\n\n- **HTTP 303 Redirect / Динамічна обробка:** Рекомендований формат запиту — POST. Запит повертає HTTP 303 Redirect із посиланням на кешований файл, що містить актуальні дані. Для коректного отримання даних необхідно враховувати, що для різних міст можуть використовуватися різні типи відповіді. У деяких випадках дані доступні за редіректом на кешований файл, в інших — повертаються безпосередньо. Список міст, для яких працює редірект, може змінюватися. Тому рекомендовано динамічно обробляти відповіді API.\n- **Обмеження та посторінкове завантаження:** Оскільки кількість записів у відповіді обмежена (не більше 6500), рекомендується виконувати окремі запити для поштових та вантажних відділень, а також поштоматів (за допомогою фільтра `TypeOfWarehouseRef` (див. метод **getWarehouseTypes**)). Також довідник можна завантажувати посторінково за допомогою параметрів `Page` та `Limit` (не більше 500 записів на сторінку). Умова завершення циклу — порожній блок даних.\n- **Актуальність даних:** Регулярне щоденне оновлення довідника є необхідним для того, щоб користувачі мали доступ до актуальних даних про всі наявні відділення та поштомати.\n \n\n\nРекомендації для забезпечення відображення актуальних даних
\n\n1. **Налаштуйте регулярне оновлення довідника:** Рекомендовано налаштувати регламентне оновлення довідника всіх складів, відділень та поштоматів щоночі для забезпечення актуальності інформації.\n2. **Протестуйте коректність роботи оновлення:** Після впровадження функції оновлення слід переконатися, що пошук на сайті відображає всі відділення, включно з пошуком за містами та типом складу.\n3. **Реалізуйте ручний пошук:** Для зручності користувачів рекомендовано використовувати фільтрацію за типом та номером відділення. Це дозволить клієнтам швидко знаходити необхідні пункти доставки та відправки.\n \n\n\nФільтрація та параметри пошуку відділень
\n\nЄ можливість знайти необхідні відділення за такими значеннями:\n- `TypeOfWarehouseRef` (див. метод **getWarehouseTypes**) — тип відділення\n- `PostFinance` — наявність каси NovaPay\n- `BicycleParking` — наявність паркування\n- `POSTerminal` — наявність пос-термінала\n- `CityName` — пошук за назвою населеного пункту\n- `CityRef` — пошук за ідентифікатором населеного пункту\n- `CityName` та `FindByString` — пошук конкретного відділення у вибраному населеному пункті або ж за ідентифікатором відділення\n- `WarehouseId` — пошук відділення за його номером\n- `SettlementRef` — для отримання відділень у конкретному населеному пункті (значення `SettlementRef` відображається у відповіді запиту **getSettlements**)\n- `Ref` — ідентифікатор відділення із довідника відділень\n\n
\nПриклад використання перелічених параметрів у запиті:\n{\n \"methodProperties\": {\n \"BicycleParking\": \"1\",\n \"TypeOfWarehouseRef\": \"9a68df70-0267-42a8-bb5c-37f427e36ee4\",\n \"PostFinance\": \"1\",\n \"CityName\": \"Київ\",\n \"CityRef\": \"20982d74-9b6c-11e2-a57a-d4ae527baec3\",\n \"WarehouseId\": \"151\",\n \"FindByString\": \"Відділення №8\",\n \"Ref\": \"47402ec5-e1c2-11e3-8c4a-0050568002cf\",\n \"SettlementRef\": \"e71629ab-4b33-11e4-ab6d-005056801329\"\n }\n}
\n \n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWarehousesJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWarehousesResponse"}}}}}}}},"components":{"schemas":{"GetWarehousesJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["Address","AddressGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getWarehouses"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetWarehousesMethodProperties"}}},"GetWarehousesMethodProperties":{"type":"object","additionalProperties":false,"properties":{"FindByString":{"type":"string","maxLength":36,"description":"Пошук за відділенням / поштоматом"},"CityName":{"type":"string","maxLength":36,"description":"Додатковий фільтр за назвою міста"},"CityRef":{"type":"string","maxLength":36,"description":"Додатковий фільтр за ідентифікатором міста"},"Page":{"type":"string","maxLength":36,"description":"Сторінка, працює разом із параметром Limit (максимум 500 записів на сторінці)"},"Limit":{"type":"string","maxLength":36,"description":"Кількість записів на сторінці. Працює разом із параметром Page"},"Language":{"type":"string","maxLength":2,"enum":["UA","RU"],"default":"UA","description":"Відображення опису українською (ua) або російською (ru) мовами"},"TypeOfWarehouseRef":{"type":"string","maxLength":36,"description":"Тип відділення"},"WarehouseId":{"type":"string","maxLength":36,"description":"Пошук відділення за його номером"},"BicycleParking":{"type":"string","maxLength":1,"enum":["0","1"],"description":"Наявність паркування біля відділення (1 — є, 0 — немає)"},"PostFinance":{"type":"string","maxLength":1,"enum":["0","1"],"description":"Наявність каси NovaPay (1 — є, 0 — немає)"},"POSTerminal":{"type":"string","maxLength":1,"enum":["0","1"],"description":"Наявність пос-термінала на відділенні (1 — є, 0 — немає)"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор відділення із довідника відділень"},"SettlementRef":{"type":"string","maxLength":36,"description":"Ідентифікатор міста із довідника населених пунктів України"}}},"GetWarehousesResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив відділень та поштоматів","items":{"$ref":"#/components/schemas/WarehouseItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"WarehouseItem":{"type":"object","additionalProperties":false,"properties":{"SiteKey":{"type":"string","maxLength":10,"description":"Код відділення"},"Description":{"type":"string","maxLength":99,"description":"Назва відділення українською мовою"},"DescriptionRu":{"type":"string","maxLength":99,"description":"Назва відділення російською мовою"},"ShortAddress":{"type":"string","maxLength":36,"description":"Коротка адреса відділення українською мовою"},"ShortAddressRu":{"type":"string","maxLength":36,"description":"Коротка адреса відділення російською мовою"},"Phone":{"type":"string","maxLength":36,"description":"Телефон"},"TypeOfWarehouse":{"type":"string","maxLength":36,"description":"Тип відділення"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор відділення"},"Number":{"type":"string","maxLength":36,"description":"Номер відділення"},"CityRef":{"type":"string","maxLength":36,"description":"Ідентифікатор населеного пункту"},"CityDescription":{"type":"string","maxLength":50,"description":"Назва населеного пункту українською мовою"},"CityDescriptionRu":{"type":"string","maxLength":50,"description":"Назва населеного пункту російською мовою"},"SettlementRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) населеного пункту"},"SettlementDescription":{"type":"string","maxLength":36,"description":"Опис населеного пункту"},"SettlementAreaDescription":{"type":"string","maxLength":36,"description":"Опис області"},"SettlementRegionsDescription":{"type":"string","maxLength":36,"description":"Опис району"},"SettlementTypeDescription":{"type":"string","maxLength":36,"description":"Тип населеного пункту українською мовою"},"SettlementTypeDescriptionRu":{"type":"string","maxLength":36,"description":"Тип населеного пункту російською мовою"},"Longitude":{"type":"number","format":"float","description":"Довгота"},"Latitude":{"type":"number","format":"float","description":"Широта"},"PostFinance":{"type":"string","maxLength":36,"description":"Наявність каси NovaPay (1 — каса є, 0 — каси немає)"},"BicycleParking":{"type":"string","maxLength":1,"description":"Наявність паркування біля відділення (1 — паркування є, 0 — паркування немає)"},"PaymentAccess":{"type":"string","maxLength":1,"description":"Доступність оплати у відділенні (1 — так, 0 — ні)"},"POSTerminal":{"type":"string","maxLength":36,"description":"Наявність пос-термінала на відділенні (1 — є, 0 — немає)"},"InternationalShipping":{"type":"string","maxLength":36,"description":"Можливість оформлення міжнародного відправлення (1 — є, 0 — немає)"},"SelfServiceWorkplacesCount":{"type":"string","maxLength":1,"description":"Наявність робочого місця самообслуговування (1 — є, 0 — немає)"},"TotalMaxWeightAllowed":{"type":"string","maxLength":36,"description":"Максимальна вага відправлення"},"PlaceMaxWeightAllowed":{"type":"string","maxLength":36,"description":"Максимальна вага одного місця відправлення"},"SendingLimitationsOnDimensions":{"$ref":"#/components/schemas/DimensionLimitations","description":"Максимальні габарити відправлення для відправки"},"ReceivingLimitationsOnDimensions":{"$ref":"#/components/schemas/DimensionLimitations","description":"Максимальні габарити відправлення для отримання"},"Reception":{"$ref":"#/components/schemas/WeeklySchedule","description":"Графік приймання відправлень"},"Delivery":{"$ref":"#/components/schemas/WeeklySchedule","description":"Графік відправки день в день"},"Schedule":{"$ref":"#/components/schemas/WeeklySchedule","description":"Графік роботи"},"DistrictCode":{"type":"string","maxLength":36,"description":"Код району"},"WarehouseStatus":{"type":"string","maxLength":36,"description":"Статус відділення"},"WarehouseStatusDate":{"type":"string","maxLength":36,"description":"Дата статусу відділення"},"CategoryOfWarehouse":{"type":"string","maxLength":36,"description":"Категорія складу"},"RegionCity":{"type":"string","maxLength":36,"description":"Область / місто"},"WarehouseForAgent":{"type":"string","maxLength":36,"description":"Належність відділення до франчайзингової мережі (1 — належить, 0 — ні)"},"MaxDeclaredCost":{"type":"string","maxLength":10,"description":"Максимально допустима оціночна вартість відправлення"},"DenyToSelect":{"type":"string","maxLength":36,"description":"Заборона вибору складу в інтернет-документі (1 — з/на цей склад не можна створити документ, 0 — створюється)"},"PostMachineType":{"type":"string","maxLength":36,"description":"Тип поштомата. Допустимі значення:\n- None — не зазначено тип поштомата\n- FullDayService — поштомат доступний 24/7\n- PartTime — поштомат з обмеженим графіком роботи (встановлений у ТЦ, магазині) і не має цілодобового доступу\n- ForResidentOfEntrance — для мешканців під'їзду\n- Private — особистий\n- LimitedAccess — з обмеженим доступом, встановлений в організаціях за межами досяжності сторонніх осіб\n"},"PostalCodeUA":{"type":"string","maxLength":36,"description":"Поштовий індекс адреси відділення (складу) «Нової пошти»"},"OnlyReceivingParcel":{"type":"string","maxLength":36,"description":"Ознака, що відділення працює тільки на видачу (1 — тільки видача, 0 — можливі приймання та видача)"},"WarehouseIndex":{"type":"string","maxLength":36,"description":"Цифрова адреса складу «Нової пошти», де дані до слеша — це індекс населеного пункту, а після — номер відділення або поштомата"}}},"DimensionLimitations":{"type":"object","additionalProperties":false,"properties":{"Width":{"type":"number","description":"Ширина (см)"},"Height":{"type":"number","description":"Висота (см)"},"Length":{"type":"number","description":"Довжина (см)"}}},"WeeklySchedule":{"type":"object","additionalProperties":false,"properties":{"Monday":{"type":"string","description":"Понеділок"},"Tuesday":{"type":"string","description":"Вівторок"},"Wednesday":{"type":"string","description":"Середа"},"Thursday":{"type":"string","description":"Четвер"},"Friday":{"type":"string","description":"П'ятниця"},"Saturday":{"type":"string","description":"Субота"},"Sunday":{"type":"string","description":"Неділя"}}}}}}
```
## Отримати довідник відділень та поштоматів (XML)
> Метод \*\*getWarehouses\*\* працює в моделі \*\*Address\*\* (або \*\*AddressGeneral\*\*) та завантажує довідник відділень компанії «Нова пошта» у контексті населених пунктів України.\
> \
> \\
> \\Особливості роботи та обробка відповідей\\
\
> \
> \- \*\*HTTP 303 Redirect / Динамічна обробка:\*\* Рекомендований формат запиту — POST. Запит повертає HTTP 303 Redirect із посиланням на кешований файл, що містить актуальні дані. Для коректного отримання даних необхідно враховувати, що для різних міст можуть використовуватися різні типи відповіді. У деяких випадках дані доступні за редіректом на кешований файл, в інших — повертаються безпосередньо. Список міст, для яких працює редірект, може змінюватися. Тому рекомендовано динамічно обробляти відповіді API.\
> \- \*\*Обмеження та посторінкове завантаження:\*\* Оскільки кількість записів у відповіді обмежена (не більше 6500), рекомендується виконувати окремі запити для поштових та вантажних відділень, а також поштоматів (за допомогою фільтра \`TypeOfWarehouseRef\` (див. метод \*\*getWarehouseTypes\*\*)). Також довідник можна завантажувати посторінково за допомогою параметрів \`Page\` та \`Limit\` (не більше 500 записів на сторінку). Умова завершення циклу — порожній блок даних.\
> \- \*\*Актуальність даних:\*\* Регулярне щоденне оновлення довідника є необхідним для того, щоб користувачі мали доступ до актуальних даних про всі наявні відділення та поштомати.\
> \ \
> \
> \\
> \\Рекомендації для забезпечення відображення актуальних даних\\
\
> \
> 1\. \*\*Налаштуйте регулярне оновлення довідника:\*\* Рекомендовано налаштувати регламентне оновлення довідника всіх складів, відділень та поштоматів щоночі для забезпечення актуальності інформації.\
> 2\. \*\*Протестуйте коректність роботи оновлення:\*\* Після впровадження функції оновлення слід переконатися, що пошук на сайті відображає всі відділення, включно з пошуком за містами та типом складу.\
> 3\. \*\*Реалізуйте ручний пошук:\*\* Для зручності користувачів рекомендовано використовувати фільтрацію за типом та номером відділення. Це дозволить клієнтам швидко знаходити необхідні пункти доставки та відправки.\
> \ \
> \
> \\
> \\Фільтрація та параметри пошуку відділень\\
\
> \
> Є можливість знайти необхідні відділення за такими значеннями:\
> \- \`TypeOfWarehouseRef\` (див. метод \*\*getWarehouseTypes\*\*) — тип відділення\
> \- \`PostFinance\` — наявність каси NovaPay\
> \- \`BicycleParking\` — наявність паркування\
> \- \`POSTerminal\` — наявність пос-термінала\
> \- \`CityName\` — пошук за назвою населеного пункту\
> \- \`CityRef\` — пошук за ідентифікатором населеного пункту\
> \- \`CityName\` та \`FindByString\` — пошук конкретного відділення у вибраному населеному пункті або ж за ідентифікатором відділення\
> \- \`WarehouseId\` — пошук відділення за його номером\
> \- \`SettlementRef\` — для отримання відділень у конкретному населеному пункті (значення \`SettlementRef\` відображається у відповіді запиту \*\*getSettlements\*\*)\
> \- \`Ref\` — ідентифікатор відділення із довідника відділень\
> \
> \
\
> \Приклад використання перелічених параметрів у запиті:\\
> \\{\
> "methodProperties": {\
> "BicycleParking": "1",\
> "TypeOfWarehouseRef": "9a68df70-0267-42a8-bb5c-37f427e36ee4",\
> "PostFinance": "1",\
> "CityName": "Київ",\
> "CityRef": "20982d74-9b6c-11e2-a57a-d4ae527baec3",\
> "WarehouseId": "151",\
> "FindByString": "Відділення №8",\
> "Ref": "47402ec5-e1c2-11e3-8c4a-0050568002cf",\
> "SettlementRef": "e71629ab-4b33-11e4-ab6d-005056801329"\
> }\
> }\\
\
> \
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами та довідниками населених пунктів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Address"],"operationId":"getWarehousesXml","summary":"Отримати довідник відділень та поштоматів (XML)","description":"Метод **getWarehouses** працює в моделі **Address** (або **AddressGeneral**) та завантажує довідник відділень компанії «Нова пошта» у контексті населених пунктів України.\n\n\nОсобливості роботи та обробка відповідей
\n\n- **HTTP 303 Redirect / Динамічна обробка:** Рекомендований формат запиту — POST. Запит повертає HTTP 303 Redirect із посиланням на кешований файл, що містить актуальні дані. Для коректного отримання даних необхідно враховувати, що для різних міст можуть використовуватися різні типи відповіді. У деяких випадках дані доступні за редіректом на кешований файл, в інших — повертаються безпосередньо. Список міст, для яких працює редірект, може змінюватися. Тому рекомендовано динамічно обробляти відповіді API.\n- **Обмеження та посторінкове завантаження:** Оскільки кількість записів у відповіді обмежена (не більше 6500), рекомендується виконувати окремі запити для поштових та вантажних відділень, а також поштоматів (за допомогою фільтра `TypeOfWarehouseRef` (див. метод **getWarehouseTypes**)). Також довідник можна завантажувати посторінково за допомогою параметрів `Page` та `Limit` (не більше 500 записів на сторінку). Умова завершення циклу — порожній блок даних.\n- **Актуальність даних:** Регулярне щоденне оновлення довідника є необхідним для того, щоб користувачі мали доступ до актуальних даних про всі наявні відділення та поштомати.\n \n\n\nРекомендації для забезпечення відображення актуальних даних
\n\n1. **Налаштуйте регулярне оновлення довідника:** Рекомендовано налаштувати регламентне оновлення довідника всіх складів, відділень та поштоматів щоночі для забезпечення актуальності інформації.\n2. **Протестуйте коректність роботи оновлення:** Після впровадження функції оновлення слід переконатися, що пошук на сайті відображає всі відділення, включно з пошуком за містами та типом складу.\n3. **Реалізуйте ручний пошук:** Для зручності користувачів рекомендовано використовувати фільтрацію за типом та номером відділення. Це дозволить клієнтам швидко знаходити необхідні пункти доставки та відправки.\n \n\n\nФільтрація та параметри пошуку відділень
\n\nЄ можливість знайти необхідні відділення за такими значеннями:\n- `TypeOfWarehouseRef` (див. метод **getWarehouseTypes**) — тип відділення\n- `PostFinance` — наявність каси NovaPay\n- `BicycleParking` — наявність паркування\n- `POSTerminal` — наявність пос-термінала\n- `CityName` — пошук за назвою населеного пункту\n- `CityRef` — пошук за ідентифікатором населеного пункту\n- `CityName` та `FindByString` — пошук конкретного відділення у вибраному населеному пункті або ж за ідентифікатором відділення\n- `WarehouseId` — пошук відділення за його номером\n- `SettlementRef` — для отримання відділень у конкретному населеному пункті (значення `SettlementRef` відображається у відповіді запиту **getSettlements**)\n- `Ref` — ідентифікатор відділення із довідника відділень\n\n
\nПриклад використання перелічених параметрів у запиті:\n{\n \"methodProperties\": {\n \"BicycleParking\": \"1\",\n \"TypeOfWarehouseRef\": \"9a68df70-0267-42a8-bb5c-37f427e36ee4\",\n \"PostFinance\": \"1\",\n \"CityName\": \"Київ\",\n \"CityRef\": \"20982d74-9b6c-11e2-a57a-d4ae527baec3\",\n \"WarehouseId\": \"151\",\n \"FindByString\": \"Відділення №8\",\n \"Ref\": \"47402ec5-e1c2-11e3-8c4a-0050568002cf\",\n \"SettlementRef\": \"e71629ab-4b33-11e4-ab6d-005056801329\"\n }\n}
\n \n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetWarehousesXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetWarehousesXmlResponse"}}}}}}}},"components":{"schemas":{"GetWarehousesXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["Address","AddressGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getWarehouses"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetWarehousesXmlMethodProperties"}}},"GetWarehousesXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetWarehousesMethodProperties"}],"xml":{"name":"methodProperties"}},"GetWarehousesMethodProperties":{"type":"object","additionalProperties":false,"properties":{"FindByString":{"type":"string","maxLength":36,"description":"Пошук за відділенням / поштоматом"},"CityName":{"type":"string","maxLength":36,"description":"Додатковий фільтр за назвою міста"},"CityRef":{"type":"string","maxLength":36,"description":"Додатковий фільтр за ідентифікатором міста"},"Page":{"type":"string","maxLength":36,"description":"Сторінка, працює разом із параметром Limit (максимум 500 записів на сторінці)"},"Limit":{"type":"string","maxLength":36,"description":"Кількість записів на сторінці. Працює разом із параметром Page"},"Language":{"type":"string","maxLength":2,"enum":["UA","RU"],"default":"UA","description":"Відображення опису українською (ua) або російською (ru) мовами"},"TypeOfWarehouseRef":{"type":"string","maxLength":36,"description":"Тип відділення"},"WarehouseId":{"type":"string","maxLength":36,"description":"Пошук відділення за його номером"},"BicycleParking":{"type":"string","maxLength":1,"enum":["0","1"],"description":"Наявність паркування біля відділення (1 — є, 0 — немає)"},"PostFinance":{"type":"string","maxLength":1,"enum":["0","1"],"description":"Наявність каси NovaPay (1 — є, 0 — немає)"},"POSTerminal":{"type":"string","maxLength":1,"enum":["0","1"],"description":"Наявність пос-термінала на відділенні (1 — є, 0 — немає)"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор відділення із довідника відділень"},"SettlementRef":{"type":"string","maxLength":36,"description":"Ідентифікатор міста із довідника населених пунктів України"}}},"GetWarehousesXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив відділень та поштоматів","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/WarehouseXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"WarehouseXmlItem":{"allOf":[{"$ref":"#/components/schemas/WarehouseItem"}],"xml":{"name":"item"}},"WarehouseItem":{"type":"object","additionalProperties":false,"properties":{"SiteKey":{"type":"string","maxLength":10,"description":"Код відділення"},"Description":{"type":"string","maxLength":99,"description":"Назва відділення українською мовою"},"DescriptionRu":{"type":"string","maxLength":99,"description":"Назва відділення російською мовою"},"ShortAddress":{"type":"string","maxLength":36,"description":"Коротка адреса відділення українською мовою"},"ShortAddressRu":{"type":"string","maxLength":36,"description":"Коротка адреса відділення російською мовою"},"Phone":{"type":"string","maxLength":36,"description":"Телефон"},"TypeOfWarehouse":{"type":"string","maxLength":36,"description":"Тип відділення"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор відділення"},"Number":{"type":"string","maxLength":36,"description":"Номер відділення"},"CityRef":{"type":"string","maxLength":36,"description":"Ідентифікатор населеного пункту"},"CityDescription":{"type":"string","maxLength":50,"description":"Назва населеного пункту українською мовою"},"CityDescriptionRu":{"type":"string","maxLength":50,"description":"Назва населеного пункту російською мовою"},"SettlementRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) населеного пункту"},"SettlementDescription":{"type":"string","maxLength":36,"description":"Опис населеного пункту"},"SettlementAreaDescription":{"type":"string","maxLength":36,"description":"Опис області"},"SettlementRegionsDescription":{"type":"string","maxLength":36,"description":"Опис району"},"SettlementTypeDescription":{"type":"string","maxLength":36,"description":"Тип населеного пункту українською мовою"},"SettlementTypeDescriptionRu":{"type":"string","maxLength":36,"description":"Тип населеного пункту російською мовою"},"Longitude":{"type":"number","format":"float","description":"Довгота"},"Latitude":{"type":"number","format":"float","description":"Широта"},"PostFinance":{"type":"string","maxLength":36,"description":"Наявність каси NovaPay (1 — каса є, 0 — каси немає)"},"BicycleParking":{"type":"string","maxLength":1,"description":"Наявність паркування біля відділення (1 — паркування є, 0 — паркування немає)"},"PaymentAccess":{"type":"string","maxLength":1,"description":"Доступність оплати у відділенні (1 — так, 0 — ні)"},"POSTerminal":{"type":"string","maxLength":36,"description":"Наявність пос-термінала на відділенні (1 — є, 0 — немає)"},"InternationalShipping":{"type":"string","maxLength":36,"description":"Можливість оформлення міжнародного відправлення (1 — є, 0 — немає)"},"SelfServiceWorkplacesCount":{"type":"string","maxLength":1,"description":"Наявність робочого місця самообслуговування (1 — є, 0 — немає)"},"TotalMaxWeightAllowed":{"type":"string","maxLength":36,"description":"Максимальна вага відправлення"},"PlaceMaxWeightAllowed":{"type":"string","maxLength":36,"description":"Максимальна вага одного місця відправлення"},"SendingLimitationsOnDimensions":{"$ref":"#/components/schemas/DimensionLimitations","description":"Максимальні габарити відправлення для відправки"},"ReceivingLimitationsOnDimensions":{"$ref":"#/components/schemas/DimensionLimitations","description":"Максимальні габарити відправлення для отримання"},"Reception":{"$ref":"#/components/schemas/WeeklySchedule","description":"Графік приймання відправлень"},"Delivery":{"$ref":"#/components/schemas/WeeklySchedule","description":"Графік відправки день в день"},"Schedule":{"$ref":"#/components/schemas/WeeklySchedule","description":"Графік роботи"},"DistrictCode":{"type":"string","maxLength":36,"description":"Код району"},"WarehouseStatus":{"type":"string","maxLength":36,"description":"Статус відділення"},"WarehouseStatusDate":{"type":"string","maxLength":36,"description":"Дата статусу відділення"},"CategoryOfWarehouse":{"type":"string","maxLength":36,"description":"Категорія складу"},"RegionCity":{"type":"string","maxLength":36,"description":"Область / місто"},"WarehouseForAgent":{"type":"string","maxLength":36,"description":"Належність відділення до франчайзингової мережі (1 — належить, 0 — ні)"},"MaxDeclaredCost":{"type":"string","maxLength":10,"description":"Максимально допустима оціночна вартість відправлення"},"DenyToSelect":{"type":"string","maxLength":36,"description":"Заборона вибору складу в інтернет-документі (1 — з/на цей склад не можна створити документ, 0 — створюється)"},"PostMachineType":{"type":"string","maxLength":36,"description":"Тип поштомата. Допустимі значення:\n- None — не зазначено тип поштомата\n- FullDayService — поштомат доступний 24/7\n- PartTime — поштомат з обмеженим графіком роботи (встановлений у ТЦ, магазині) і не має цілодобового доступу\n- ForResidentOfEntrance — для мешканців під'їзду\n- Private — особистий\n- LimitedAccess — з обмеженим доступом, встановлений в організаціях за межами досяжності сторонніх осіб\n"},"PostalCodeUA":{"type":"string","maxLength":36,"description":"Поштовий індекс адреси відділення (складу) «Нової пошти»"},"OnlyReceivingParcel":{"type":"string","maxLength":36,"description":"Ознака, що відділення працює тільки на видачу (1 — тільки видача, 0 — можливі приймання та видача)"},"WarehouseIndex":{"type":"string","maxLength":36,"description":"Цифрова адреса складу «Нової пошти», де дані до слеша — це індекс населеного пункту, а після — номер відділення або поштомата"}}},"DimensionLimitations":{"type":"object","additionalProperties":false,"properties":{"Width":{"type":"number","description":"Ширина (см)"},"Height":{"type":"number","description":"Висота (см)"},"Length":{"type":"number","description":"Довжина (см)"}}},"WeeklySchedule":{"type":"object","additionalProperties":false,"properties":{"Monday":{"type":"string","description":"Понеділок"},"Tuesday":{"type":"string","description":"Вівторок"},"Wednesday":{"type":"string","description":"Середа"},"Thursday":{"type":"string","description":"Четвер"},"Friday":{"type":"string","description":"П'ятниця"},"Saturday":{"type":"string","description":"Субота"},"Sunday":{"type":"string","description":"Неділя"}}}}}}
```
## Отримати довідник типів відділень (JSON)
> Метод \*\*getWarehouseTypes\*\* працює в моделі \*\*Address\*\* (або \*\*AddressGeneral\*\*) та завантажує довідник типів відділень компанії «Нова пошта».
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами та довідниками населених пунктів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Address"],"operationId":"getWarehouseTypesJson","summary":"Отримати довідник типів відділень (JSON)","description":"Метод **getWarehouseTypes** працює в моделі **Address** (або **AddressGeneral**) та завантажує довідник типів відділень компанії «Нова пошта».\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWarehouseTypesJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWarehouseTypesResponse"}}}}}}}},"components":{"schemas":{"GetWarehouseTypesJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["Address","AddressGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getWarehouseTypes"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetWarehouseTypesMethodProperties"}}},"GetWarehouseTypesMethodProperties":{"type":"object","additionalProperties":false,"properties":{}},"GetWarehouseTypesResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив типів відділень","items":{"$ref":"#/components/schemas/WarehouseTypeItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"WarehouseTypeItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) типу відділення"},"Description":{"type":"string","maxLength":50,"description":"Опис типу відділення українською мовою"},"DescriptionRu":{"type":"string","maxLength":50,"description":"Опис типу відділення російською мовою"}}}}}}
```
## Отримати довідник типів відділень (XML)
> Метод \*\*getWarehouseTypes\*\* працює в моделі \*\*Address\*\* (або \*\*AddressGeneral\*\*) та завантажує довідник типів відділень компанії «Нова пошта».
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами та довідниками населених пунктів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Address"],"operationId":"getWarehouseTypesXml","summary":"Отримати довідник типів відділень (XML)","description":"Метод **getWarehouseTypes** працює в моделі **Address** (або **AddressGeneral**) та завантажує довідник типів відділень компанії «Нова пошта».\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetWarehouseTypesXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetWarehouseTypesXmlResponse"}}}}}}}},"components":{"schemas":{"GetWarehouseTypesXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["Address","AddressGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getWarehouseTypes"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetWarehouseTypesXmlMethodProperties"}}},"GetWarehouseTypesXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetWarehouseTypesMethodProperties"}],"xml":{"name":"methodProperties"}},"GetWarehouseTypesMethodProperties":{"type":"object","additionalProperties":false,"properties":{}},"GetWarehouseTypesXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив типів відділень","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/WarehouseTypeXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"WarehouseTypeXmlItem":{"allOf":[{"$ref":"#/components/schemas/WarehouseTypeItem"}],"xml":{"name":"item"}},"WarehouseTypeItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) типу відділення"},"Description":{"type":"string","maxLength":50,"description":"Опис типу відділення українською мовою"},"DescriptionRu":{"type":"string","maxLength":50,"description":"Опис типу відділення російською мовою"}}}}}}
```
## Отримати довідник вулиць компанії (JSON)
> Метод \*\*getStreet\*\* працює в моделі \*\*Address\*\* (або \*\*AddressGeneral\*\*) та завантажує довідник вулиць в межах населених пунктів України, куди здійснює доставку компанія «Нова пошта».\
> \
> Довідник використовується під час створення відправлень з типом доставки від/до адреси клієнта. Щоб знайти конкретний проспект чи вулицю, потрібно в запит додати параметр \`FindByString\` (пошук за рядками) і задати назву у його значенні.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами та довідниками населених пунктів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Address"],"operationId":"getStreetJson","summary":"Отримати довідник вулиць компанії (JSON)","description":"Метод **getStreet** працює в моделі **Address** (або **AddressGeneral**) та завантажує довідник вулиць в межах населених пунктів України, куди здійснює доставку компанія «Нова пошта».\n\nДовідник використовується під час створення відправлень з типом доставки від/до адреси клієнта. Щоб знайти конкретний проспект чи вулицю, потрібно в запит додати параметр `FindByString` (пошук за рядками) і задати назву у його значенні.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStreetJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStreetResponse"}}}}}}}},"components":{"schemas":{"GetStreetJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["Address","AddressGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getStreet"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetStreetMethodProperties"}}},"GetStreetMethodProperties":{"type":"object","additionalProperties":false,"required":["CityRef","FindByString"],"properties":{"CityRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста, дані з довідника міст компанії (див. метод **getCities**)"},"FindByString":{"type":"string","maxLength":36,"description":"Пошук за рядками (назва вулиці або проспекту)"},"Page":{"type":"string","maxLength":36,"description":"Сторінка (до 500 записів на сторінці)"},"Limit":{"type":"string","maxLength":36,"description":"Кількість записів на сторінці. Працює разом із параметром Page"}}},"GetStreetResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив вулиць","items":{"$ref":"#/components/schemas/StreetItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"StreetItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) вулиці"},"Description":{"type":"string","maxLength":100,"description":"Назва вулиці українською мовою"},"StreetsTypeRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) типу вулиці"},"StreetsType":{"type":"string","maxLength":36,"description":"Тип вулиці"}}}}}}
```
## Отримати довідник вулиць компанії (XML)
> Метод \*\*getStreet\*\* працює в моделі \*\*Address\*\* (або \*\*AddressGeneral\*\*) та завантажує довідник вулиць в межах населених пунктів України, куди здійснює доставку компанія «Нова пошта».\
> \
> Довідник використовується під час створення відправлень з типом доставки від/до адреси клієнта. Щоб знайти конкретний проспект чи вулицю, потрібно в запит додати параметр \`FindByString\` (пошук за рядками) і задати назву у його значенні.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами та довідниками населених пунктів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Address"],"operationId":"getStreetXml","summary":"Отримати довідник вулиць компанії (XML)","description":"Метод **getStreet** працює в моделі **Address** (або **AddressGeneral**) та завантажує довідник вулиць в межах населених пунктів України, куди здійснює доставку компанія «Нова пошта».\n\nДовідник використовується під час створення відправлень з типом доставки від/до адреси клієнта. Щоб знайти конкретний проспект чи вулицю, потрібно в запит додати параметр `FindByString` (пошук за рядками) і задати назву у його значенні.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetStreetXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetStreetXmlResponse"}}}}}}}},"components":{"schemas":{"GetStreetXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["Address","AddressGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getStreet"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetStreetXmlMethodProperties"}}},"GetStreetXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetStreetMethodProperties"}],"xml":{"name":"methodProperties"}},"GetStreetMethodProperties":{"type":"object","additionalProperties":false,"required":["CityRef","FindByString"],"properties":{"CityRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста, дані з довідника міст компанії (див. метод **getCities**)"},"FindByString":{"type":"string","maxLength":36,"description":"Пошук за рядками (назва вулиці або проспекту)"},"Page":{"type":"string","maxLength":36,"description":"Сторінка (до 500 записів на сторінці)"},"Limit":{"type":"string","maxLength":36,"description":"Кількість записів на сторінці. Працює разом із параметром Page"}}},"GetStreetXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив вулиць","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/StreetXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"StreetXmlItem":{"allOf":[{"$ref":"#/components/schemas/StreetItem"}],"xml":{"name":"item"}},"StreetItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) вулиці"},"Description":{"type":"string","maxLength":100,"description":"Назва вулиці українською мовою"},"StreetsTypeRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) типу вулиці"},"StreetsType":{"type":"string","maxLength":36,"description":"Тип вулиці"}}}}}}
```
## Отримати довідник районів областей населених пунктів (JSON)
> Метод \*\*getSettlementCountryRegion\*\* працює в моделі \*\*Address\*\* (або \*\*AddressGeneral\*\*). За допомогою цього методу можна завантажити довідник районів областей населених пунктів, аналогічний даним методу \*\*getSettlements\*\*.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами та довідниками населених пунктів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Address"],"operationId":"getSettlementCountryRegionJson","summary":"Отримати довідник районів областей населених пунктів (JSON)","description":"Метод **getSettlementCountryRegion** працює в моделі **Address** (або **AddressGeneral**). За допомогою цього методу можна завантажити довідник районів областей населених пунктів, аналогічний даним методу **getSettlements**.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSettlementCountryRegionJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSettlementCountryRegionResponse"}}}}}}}},"components":{"schemas":{"GetSettlementCountryRegionJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AddressGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getSettlementCountryRegion"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetSettlementCountryRegionMethodProperties"}}},"GetSettlementCountryRegionMethodProperties":{"type":"object","additionalProperties":false,"required":["AreaRef"],"properties":{"AreaRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) області"}}},"GetSettlementCountryRegionResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив районів областей","items":{"$ref":"#/components/schemas/SettlementCountryRegionItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"SettlementCountryRegionItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) району"},"AreasCenter":{"type":"string","maxLength":36,"description":"Адміністративний центр області. Одночасно ідентифікатор населеного пункту (REF)"},"Description":{"type":"string","maxLength":50,"description":"Назва району"},"RegionType":{"type":"string","maxLength":50,"description":"Назва типу районного об'єкта"}}}}}}
```
## Отримати довідник районів областей населених пунктів (XML)
> Метод \*\*getSettlementCountryRegion\*\* працює в моделі \*\*Address\*\* (або \*\*AddressGeneral\*\*). За допомогою цього методу можна завантажити довідник районів областей населених пунктів, аналогічний даним методу \*\*getSettlements\*\*.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами та довідниками населених пунктів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Address"],"operationId":"getSettlementCountryRegionXml","summary":"Отримати довідник районів областей населених пунктів (XML)","description":"Метод **getSettlementCountryRegion** працює в моделі **Address** (або **AddressGeneral**). За допомогою цього методу можна завантажити довідник районів областей населених пунктів, аналогічний даним методу **getSettlements**.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetSettlementCountryRegionXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetSettlementCountryRegionXmlResponse"}}}}}}}},"components":{"schemas":{"GetSettlementCountryRegionXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AddressGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getSettlementCountryRegion"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetSettlementCountryRegionXmlMethodProperties"}}},"GetSettlementCountryRegionXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetSettlementCountryRegionMethodProperties"}],"xml":{"name":"methodProperties"}},"GetSettlementCountryRegionMethodProperties":{"type":"object","additionalProperties":false,"required":["AreaRef"],"properties":{"AreaRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) області"}}},"GetSettlementCountryRegionXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив районів областей","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/SettlementCountryRegionXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"SettlementCountryRegionXmlItem":{"allOf":[{"$ref":"#/components/schemas/SettlementCountryRegionItem"}],"xml":{"name":"item"}},"SettlementCountryRegionItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) району"},"AreasCenter":{"type":"string","maxLength":36,"description":"Адміністративний центр області. Одночасно ідентифікатор населеного пункту (REF)"},"Description":{"type":"string","maxLength":50,"description":"Назва району"},"RegionType":{"type":"string","maxLength":50,"description":"Назва типу районного об'єкта"}}}}}}
```
## Отримати довідник областей населених пунктів (JSON)
> Метод \*\*getSettlementAreas\*\* працює в моделі \*\*AddressGeneral\*\*. Метод надає довідник областей населених пунктів, відповідний інформації, яку повертає метод \*\*getSettlements\*\*.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами та довідниками населених пунктів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Address"],"operationId":"getSettlementAreasJson","summary":"Отримати довідник областей населених пунктів (JSON)","description":"Метод **getSettlementAreas** працює в моделі **AddressGeneral**. Метод надає довідник областей населених пунктів, відповідний інформації, яку повертає метод **getSettlements**.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSettlementAreasJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSettlementAreasResponse"}}}}}}}},"components":{"schemas":{"GetSettlementAreasJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AddressGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getSettlementAreas"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetSettlementAreasMethodProperties"}}},"GetSettlementAreasMethodProperties":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) області"}}},"GetSettlementAreasResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив областей населених пунктів","items":{"$ref":"#/components/schemas/SettlementAreaItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"SettlementAreaItem":{"type":"object","additionalProperties":false,"properties":{"Description":{"type":"string","maxLength":50,"description":"Назва області"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) області"},"AreasCenter":{"type":"string","maxLength":36,"description":"Адміністративний центр області. Одночасно ідентифікатор населеного пункту (REF)"},"RegionType":{"type":"string","maxLength":50,"description":"Назва типу обласного об'єкта"}}}}}}
```
## Отримати довідник областей населених пунктів (XML)
> Метод \*\*getSettlementAreas\*\* працює в моделі \*\*AddressGeneral\*\*. Метод надає довідник областей населених пунктів, відповідний інформації, яку повертає метод \*\*getSettlements\*\*.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Address","version":"2.0.0"},"tags":[{"name":"Address","description":"Операції, пов'язані з адресами та довідниками населених пунктів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Address"],"operationId":"getSettlementAreasXml","summary":"Отримати довідник областей населених пунктів (XML)","description":"Метод **getSettlementAreas** працює в моделі **AddressGeneral**. Метод надає довідник областей населених пунктів, відповідний інформації, яку повертає метод **getSettlements**.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetSettlementAreasXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetSettlementAreasXmlResponse"}}}}}}}},"components":{"schemas":{"GetSettlementAreasXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AddressGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getSettlementAreas"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetSettlementAreasXmlMethodProperties"}}},"GetSettlementAreasXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetSettlementAreasMethodProperties"}],"xml":{"name":"methodProperties"}},"GetSettlementAreasMethodProperties":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) області"}}},"GetSettlementAreasXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив областей населених пунктів","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/SettlementAreaXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"SettlementAreaXmlItem":{"allOf":[{"$ref":"#/components/schemas/SettlementAreaItem"}],"xml":{"name":"item"}},"SettlementAreaItem":{"type":"object","additionalProperties":false,"properties":{"Description":{"type":"string","maxLength":50,"description":"Назва області"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) області"},"AreasCenter":{"type":"string","maxLength":36,"description":"Адміністративний центр області. Одночасно ідентифікатор населеного пункту (REF)"},"RegionType":{"type":"string","maxLength":50,"description":"Назва типу обласного об'єкта"}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://api-portal.novapost.com/api-docs-ua/zagalna-informaciya/adresi.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.