Адреси
Робота з адресами
Метод searchSettlementStreets працює в моделі Address (або AddressGeneral) та необхідний для онлайн-пошуку вулиць у вибраному населеному пункті.
Завдяки цьому методу немає необхідності на своїй стороні зберігати довідники та здійснювати їхнє оновлення.
API-ключ користувача
AddressGeneralsearchSettlementStreetsУспішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки, що виникли під час виконання запиту
Масив попереджень щодо виконання запиту
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json HTTP/1.1
Host: api.novaposhta.ua
Content-Type: application/json
Accept: */*
Content-Length: 221
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "AddressGeneral",
"calledMethod": "searchSettlementStreets",
"methodProperties": {
"StreetName": "Хрещатик",
"SettlementRef": "00000000-0000-0000-0000-000000000000",
"Limit": "50"
}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"TotalCount": "1",
"Addresses": [
{
"SettlementRef": "e718a680-4b33-11e4-ab6d-005056801329",
"SettlementStreetRef": "ad090b1f-6845-11e6-8304-00505688561d",
"SettlementStreetDescription": "Хрещатик",
"Present": "вул. Хрещатик",
"StreetsType": "0f1d7fbb-4bba-11e4-ab6d-005056801329",
"StreetsTypeDescription": "вул.",
"Location": {
"lat": 50.44806099962443,
"lon": 30.52225599065423
},
"SettlementStreetDescriptionRu": "Крещатик"
}
]
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод searchSettlementStreets працює в моделі Address (або AddressGeneral) та дозволяє здійснювати онлайн-пошук вулиць у форматі XML.
API-ключ користувача
AddressGeneralsearchSettlementStreetsУспішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки, що виникли під час виконання запиту
Масив попереджень щодо виконання запиту
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml HTTP/1.1
Host: api.novaposhta.ua
Content-Type: application/xml
Accept: */*
Content-Length: 386
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>AddressGeneral</modelName>
<calledMethod>searchSettlementStreets</calledMethod>
<methodProperties>
<StreetName>Хрещатик</StreetName>
<SettlementRef>00000000-0000-0000-0000-000000000000</SettlementRef>
<Limit>50</Limit>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<TotalCount>1</TotalCount>
<Addresses>
<item>
<SettlementRef>e718a680-4b33-11e4-ab6d-005056801329</SettlementRef>
<SettlementStreetRef>ad090b1f-6845-11e6-8304-00505688561d</SettlementStreetRef>
<SettlementStreetDescription>Хрещатик</SettlementStreetDescription>
<Present>вул. Хрещатик</Present>
<StreetsType>0f1d7fbb-4bba-11e4-ab6d-005056801329</StreetsType>
<StreetsTypeDescription>вул.</StreetsTypeDescription>
<Location>
<lat>50.448060999624</lat>
<lon>30.522255990654</lon>
</Location>
<SettlementStreetDescriptionRu>Крещатик</SettlementStreetDescriptionRu>
</item>
</Addresses>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Метод searchSettlements працює в моделі Address (або AddressGeneral) та необхідний для онлайн-пошуку населених пунктів.
Завдяки цьому методу немає необхідності на своїй стороні зберігати довідники та здійснювати їхнє оновлення.
API-ключ користувача
AddressGeneralsearchSettlementsУспішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки, що виникли під час виконання запиту
Масив попереджень щодо виконання запиту
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json HTTP/1.1
Host: api.novaposhta.ua
Content-Type: application/json
Accept: */*
Content-Length: 161
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "AddressGeneral",
"calledMethod": "searchSettlements",
"methodProperties": {
"CityName": "київ",
"Limit": "50",
"Page": "2"
}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"StreetsAvailability": true,
"RegionTypesCode": "",
"AddressDeliveryAllowed": true,
"TotalCount": "235",
"Addresses": [
{
"Present": "м. Київ, Київська обл.",
"Warehouses": "6382",
"MainDescription": "Київ",
"Area": "Київська",
"Region": " ",
"SettlementTypeCode": "м.",
"Ref": "00000000-0000-0000-0000-000000000000",
"DeliveryCity": "00000000-0000-0000-0000-000000000000",
"AddressDeliveryAllowed": true,
"StreetsAvailability": true,
"ParentRegionTypes": "область",
"ParentRegionCode": "обл.",
"RegionTypes": " ",
"RegionTypesCode": " "
}
],
"Warehouses": "568",
"MainDescription": "Київ",
"Area": "обл",
"Region": "Київська",
"SettlementTypeCode": "м.",
"Ref": "00000000-0000-0000-0000-000000000000",
"DeliveryCity": "00000000-0000-0000-0000-000000000000",
"Present": "м. Київ, Київська обл.",
"RegionTypes": "",
"ParentRegionCode": "обл.",
"ParentRegionTypes": "область"
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод searchSettlements працює в моделі Address (або AddressGeneral) та дозволяє здійснювати онлайн-пошук населених пунктів у форматі XML.
API-ключ користувача
AddressGeneralsearchSettlementsУспішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки, що виникли під час виконання запиту
Масив попереджень щодо виконання запиту
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml HTTP/1.1
Host: api.novaposhta.ua
Content-Type: application/xml
Accept: */*
Content-Length: 315
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>AddressGeneral</modelName>
<calledMethod>searchSettlements</calledMethod>
<methodProperties>
<CityName>київ</CityName>
<Limit>50</Limit>
<Page>2</Page>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<StreetsAvailability>true</StreetsAvailability>
<RegionTypesCode></RegionTypesCode>
<AddressDeliveryAllowed>true</AddressDeliveryAllowed>
<TotalCount>235</TotalCount>
<Addresses>
<item>
<Present>м. Київ, Київська обл.</Present>
<Warehouses>6382</Warehouses>
<MainDescription>Київ</MainDescription>
<Area>Київська</Area>
<Region> </Region>
<SettlementTypeCode>м.</SettlementTypeCode>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<DeliveryCity>00000000-0000-0000-0000-000000000000</DeliveryCity>
<AddressDeliveryAllowed>true</AddressDeliveryAllowed>
<StreetsAvailability>true</StreetsAvailability>
<ParentRegionTypes>область</ParentRegionTypes>
<ParentRegionCode>обл.</ParentRegionCode>
<RegionTypes> </RegionTypes>
<RegionTypesCode> </RegionTypesCode>
</item>
</Addresses>
<Warehouses>568</Warehouses>
<MainDescription>Київ</MainDescription>
<Area>обл</Area>
<Region>Київська</Region>
<SettlementTypeCode>м.</SettlementTypeCode>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<DeliveryCity>00000000-0000-0000-0000-000000000000</DeliveryCity>
<Present>м. Київ, Київська обл.</Present>
<RegionTypes></RegionTypes>
<ParentRegionCode>обл.</ParentRegionCode>
<ParentRegionTypes>область</ParentRegionTypes>
</item>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Метод save працює в моделі AddressGeneral (або Address). Цей метод зберігає адресу контрагента (отримувача чи відправника).
API-ключ користувача
AddressGeneralsaveУспішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки, що виникли під час виконання запиту
Масив попереджень щодо виконання запиту
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json HTTP/1.1
Host: api.novaposhta.ua
Content-Type: application/json
Accept: */*
Content-Length: 268
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "AddressGeneral",
"calledMethod": "save",
"methodProperties": {
"CounterpartyRef": "00000000-0000-0000-0000-000000000000",
"StreetRef": "00000000-0000-0000-0000-000000000000",
"BuildingNumber": "7",
"Flat": "2",
"Note": "Коментар"
}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"Ref": "00000000-0000-0000-0000-000000000000",
"Description": "вул. Хрещатик, 7 кв. 2"
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод save працює в моделі AddressGeneral (або Address) та зберігає адресу контрагента у форматі XML.
API-ключ користувача
AddressGeneralsaveУспішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки, що виникли під час виконання запиту
Масив попереджень щодо виконання запиту
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml HTTP/1.1
Host: api.novaposhta.ua
Content-Type: application/xml
Accept: */*
Content-Length: 491
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>AddressGeneral</modelName>
<calledMethod>save</calledMethod>
<methodProperties>
<CounterpartyRef>00000000-0000-0000-0000-000000000000</CounterpartyRef>
<StreetRef>00000000-0000-0000-0000-000000000000</StreetRef>
<BuildingNumber>7</BuildingNumber>
<Flat>2</Flat>
<Note>Коментар</Note>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<Description>вул. Хрещатик, 7 кв. 2</Description>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Метод delete працює в моделі AddressGeneral (або Address). Цей метод необхідний для видалення адреси контрагента (відправника чи отримувача).
Редагувати або видаляти дані контрагента можна лише з моменту його створення та до моменту створення інтернет-документа (ІД) із цим контрагентом.
API-ключ користувача
AddressGeneraldeleteУспішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки, що виникли під час виконання запиту
Масив попереджень щодо виконання запиту
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json HTTP/1.1
Host: api.novaposhta.ua
Content-Type: application/json
Accept: */*
Content-Length: 149
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "AddressGeneral",
"calledMethod": "delete",
"methodProperties": {
"Ref": "00000000-0000-0000-0000-000000000000"
}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"Ref": "00000000-0000-0000-0000-000000000000"
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод delete працює в моделі AddressGeneral (або Address). Цей метод необхідний для видалення адреси контрагента (відправника чи отримувача).
Редагувати або видаляти дані контрагента можна лише з моменту його створення та до моменту створення інтернет-документа (ІД) із цим контрагентом.
API-ключ користувача
AddressGeneraldeleteУспішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки, що виникли під час виконання запиту
Масив попереджень щодо виконання запиту
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml HTTP/1.1
Host: api.novaposhta.ua
Content-Type: application/xml
Accept: */*
Content-Length: 293
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>AddressGeneral</modelName>
<calledMethod>delete</calledMethod>
<methodProperties>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Метод update моделі AddressGeneral (або Address) дозволяє оновити адресу контрагента (відправника чи отримувача).
Умова виконання: Редагувати дані контрагента можна лише від моменту його створення та до моменту створення інтернет-документа (ІД) із цим контрагентом.
API-ключ користувача
[ВАШ КЛЮЧ]Назва моделі API
Назва методу API
Успішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 321
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "AddressGeneral",
"calledMethod": "update",
"methodProperties": {
"CounterpartyRef": "00000000-0000-0000-0000-000000000000",
"StreetRef": "00000000-0000-0000-0000-000000000000",
"BuildingNumber": "7",
"Flat": "2",
"Note": "Комментарий",
"Ref": "00000000-0000-0000-0000-000000000000"
}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"Ref": "00000000-0000-0000-0000-000000000000",
"Description": "вул. Хрещатик, 7 кв. 2"
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод update моделі AddressGeneral (або Address) дозволяє оновити адресу контрагента (відправника чи отримувача) у форматі XML.
Умова виконання: Редагувати дані контрагента можна лише від моменту його створення та до моменту створення інтернет-документа (ІД) із цим контрагентом.
API-ключ користувача
Назва моделі API
Назва методу API
Успішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 556
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>AddressGeneral</modelName>
<calledMethod>update</calledMethod>
<methodProperties>
<CounterpartyRef>00000000-0000-0000-0000-000000000000</CounterpartyRef>
<StreetRef>00000000-0000-0000-0000-000000000000</StreetRef>
<BuildingNumber>7</BuildingNumber>
<Flat>2</Flat>
<Note>Комментарий</Note>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<Description>вул. Хрещатик, 7 кв. 2</Description>
</item>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Метод getSettlements працює в моделі AddressGeneral (або Address) та надає можливість завантажити довідник міст України, до яких здійснюється доставка вантажів компанією «Нова пошта».
Важлива інформація та обмеження:
Відповідь містить область та район для кожного населеного пункту.
Метод повертає не більше 150 записів на сторінку. Для перегляду більш ніж 150 записів необхідно використовувати параметр
Pageразом із параметромLimit.Підтримується пошук за рядком за допомогою параметра
FindByString. Пошук можливий лише українською мовою.Параметр
Warehouseзі значенням «1» або «0» дозволяє відобразити лише ті населені пункти, в яких є відділення компанії «Нова пошта».Необхідно зберігати копію довідника на стороні клієнта та підтримувати його в актуальному стані. Рекомендовано проводити оновлення довідників раз на місяць.
API-ключ користувача
[ВАШ КЛЮЧ]Назва моделі API
Назва методу API
Успішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 323
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "AddressGeneral",
"calledMethod": "getSettlements",
"methodProperties": {
"AreaRef": "00000000-0000-0000-0000-000000000000",
"Ref": "00000000-0000-0000-0000-000000000000",
"RegionRef": "00000000-0000-0000-0000-000000000000",
"Page": "1",
"Warehouse": "1",
"FindByString": "Київ",
"Limit": "20"
}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"Ref": "00000000-0000-0000-0000-000000000000",
"SettlementType": "00000000-0000-0000-0000-000000000000",
"Latitude": "50.450418000000000",
"Longitude": "30.523541000000000",
"Description": "Київ",
"DescriptionRu": "Киев",
"SettlementTypeDescription": "місто",
"SettlementTypeDescriptionRu": "город",
"Region": "",
"RegionsDescription": "Київська",
"RegionsDescriptionRu": "Киевская",
"Area": "00000000-0000-0000-0000-000000000000",
"AreaDescription": "Київська область",
"AreaDescriptionRu": "Киевская область",
"Index1": "001001",
"Index2": "004655",
"IndexCOATSU1": "3200000000",
"Delivery1": "1",
"Delivery2": "1",
"Delivery3": "1",
"Delivery4": "1",
"Delivery5": "1",
"Delivery6": "1",
"Delivery7": "0",
"Warehouse": "1",
"Conglomerates": [
"00000000-0000-0000-0000-000000000000",
"00000000-0000-0000-0000-000000000000"
]
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод getSettlements працює в моделі AddressGeneral (або Address) та надає можливість завантажити довідник міст України, до яких здійснюється доставка вантажів компанією «Нова пошта».
Важлива інформація та обмеження:
Відповідь містить область та район для кожного населеного пункту.
Метод повертає не більше 150 записів на сторінку. Для перегляду більш ніж 150 записів необхідно використовувати параметр
Pageразом із параметромLimit.Підтримується пошук за рядком за допомогою параметра
FindByString. Пошук можливий лише українською мовою.Параметр
Warehouseзі значенням «1» або «0» дозволяє відобразити лише ті населені пункти, в яких є відділення компанії «Нова пошта».Необхідно зберігати копію довідника на стороні клієнта та підтримувати його в актуальному стані. Рекомендовано проводити оновлення довідників раз на місяць.
API-ключ користувача
Назва моделі API
Назва методу API
Успішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 567
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>AddressGeneral</modelName>
<calledMethod>getSettlements</calledMethod>
<methodProperties>
<AreaRef>00000000-0000-0000-0000-000000000000</AreaRef>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<RegionRef>00000000-0000-0000-0000-000000000000</RegionRef>
<Page>1</Page>
<Warehouse>1</Warehouse>
<FindByString>Київ</FindByString>
<Limit>20</Limit>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<SettlementType>00000000-0000-0000-0000-000000000000</SettlementType>
<Latitude>50.450418000000000</Latitude>
<Longitude>30.523541000000000</Longitude>
<Description>Київ</Description>
<DescriptionRu>Киев</DescriptionRu>
<SettlementTypeDescription>місто</SettlementTypeDescription>
<SettlementTypeDescriptionRu>город</SettlementTypeDescriptionRu>
<Region></Region>
<RegionsDescription>Київська</RegionsDescription>
<RegionsDescriptionRu>Киевская</RegionsDescriptionRu>
<Area>00000000-0000-0000-0000-000000000000</Area>
<AreaDescription>Київська область</AreaDescription>
<AreaDescriptionRu>Киевская область</AreaDescriptionRu>
<Index1>001001</Index1>
<Index2>004655</Index2>
<IndexCOATSU1>3200000000</IndexCOATSU1>
<Delivery1>1</Delivery1>
<Delivery2>1</Delivery2>
<Delivery3>1</Delivery3>
<Delivery4>1</Delivery4>
<Delivery5>1</Delivery5>
<Delivery6>1</Delivery6>
<Delivery7>0</Delivery7>
<Warehouse>1</Warehouse>
<Conglomerates>
<item>00000000-0000-0000-0000-000000000000</item>
<item>00000000-0000-0000-0000-000000000000</item>
</Conglomerates>
</item>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Метод getCities працює в моделі Address (або AddressGeneral) та завантажує довідник населених пунктів України, де є відділення компанії «Нова пошта» і можна оформити доставку на відділення чи за адресою.
Важлива інформація та обмеження:
Щоб знайти конкретний населений пункт, потрібно в значенні параметра
FindByString(пошук за рядками) задати назву.Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. Рекомендовано оновлювати довідники щодня.
API-ключ користувача
[ВАШ КЛЮЧ]Назва моделі API
Назва методу API
Успішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 202
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "AddressGeneral",
"calledMethod": "getCities",
"methodProperties": {
"Ref": "00000000-0000-0000-0000-000000000000",
"Page": "1",
"FindByString": "Київ",
"Limit": "20"
}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"Description": "Київ",
"DescriptionRu": "Киев",
"Ref": "00000000-0000-0000-0000-000000000000",
"Delivery1": "1",
"Delivery2": "1",
"Delivery3": "1",
"Delivery4": "1",
"Delivery5": "1",
"Delivery6": "0",
"Delivery7": "0",
"Area": "00000000-0000-0000-0000-000000000000",
"SettlementType": "00000000-0000-0000-0000-000000000000",
"IsBranch": "0",
"PreventEntryNewStreetsUser": "null",
"Conglomerates": "null",
"CityID": "890",
"SettlementTypeDescriptionRu": "село",
"SettlementTypeDescription": "село"
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод getCities працює в моделі Address (або AddressGeneral) та завантажує довідник населених пунктів України, де є відділення компанії «Нова пошта» і можна оформити доставку на відділення чи за адресою.
Важлива інформація та обмеження:
Щоб знайти конкретний населений пункт, потрібно в значенні параметра
FindByString(пошук за рядками) задати назву.Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. Рекомендовано оновлювати довідники щодня.
API-ключ користувача
Назва моделі API
Назва методу API
Успішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 394
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>AddressGeneral</modelName>
<calledMethod>getCities</calledMethod>
<methodProperties>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<Page>1</Page>
<FindByString>Київ</FindByString>
<Limit>20</Limit>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Description>Київ</Description>
<DescriptionRu>Киев</DescriptionRu>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<Delivery1>1</Delivery1>
<Delivery2>1</Delivery2>
<Delivery3>1</Delivery3>
<Delivery4>1</Delivery4>
<Delivery5>1</Delivery5>
<Delivery6>0</Delivery6>
<Delivery7>0</Delivery7>
<Area>00000000-0000-0000-0000-000000000000</Area>
<SettlementType>00000000-0000-0000-0000-000000000000</SettlementType>
<IsBranch>0</IsBranch>
<PreventEntryNewStreetsUser>null</PreventEntryNewStreetsUser>
<Conglomerates>null</Conglomerates>
<CityID>890</CityID>
<SettlementTypeDescriptionRu>село</SettlementTypeDescriptionRu>
<SettlementTypeDescription>село</SettlementTypeDescription>
</item>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Метод getAreas працює в моделі Address (або AddressGeneral) та завантажує довідник географічних областей України, де є відділення компанії «Нова пошта».
Важлива інформація та обмеження:
Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані.
Рекомендовано оновлювати довідник щомісяця.
API-ключ користувача
[ВАШ КЛЮЧ]Назва моделі API
Назва методу API
Успішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 107
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "AddressGeneral",
"calledMethod": "getAreas",
"methodProperties": {}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"Ref": "00000000-0000-0000-0000-000000000000",
"AreasCenter": "00000000-0000-0000-0000-000000000000",
"DescriptionRu": "Киевская",
"Description": "Київська"
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод getAreas працює в моделі Address (або AddressGeneral) та завантажує довідник географічних областей України, де є відділення компанії «Нова пошта».
Важлива інформація та обмеження:
Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані.
Рекомендовано оновлювати довідник щомісяця.
API-ключ користувача
Назва моделі API
Назва методу API
Успішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 238
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>AddressGeneral</modelName>
<calledMethod>getAreas</calledMethod>
<methodProperties>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<AreasCenter>00000000-0000-0000-0000-000000000000</AreasCenter>
<DescriptionRu>Киевская</DescriptionRu>
<Description>Київська</Description>
</item>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Метод getWarehouses працює в моделі Address (або AddressGeneral) та завантажує довідник відділень компанії «Нова пошта» у контексті населених пунктів України.
API-ключ користувача
[ВАШ КЛЮЧ]Назва моделі API
Назва методу API
Успішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 320
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "AddressGeneral",
"calledMethod": "getWarehouses",
"methodProperties": {
"FindByString": "",
"CityName": "Київ",
"CityRef": "00000000-0000-0000-0000-000000000000",
"Page": "1",
"Limit": "50",
"Language": "UA",
"TypeOfWarehouseRef": "00000000-0000-0000-0000-000000000000",
"WarehouseId": "151"
}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"SiteKey": "10119",
"Description": "Відділення №1: вул. М. Грушевського, 3",
"DescriptionRu": "Отделение №1: ул. М. Грушевского, 3",
"ShortAddress": "Заболотів, М. Грушевського, 3",
"ShortAddressRu": "Заболотов, Грушевского, 3",
"Phone": "380800500609",
"TypeOfWarehouse": "00000000-0000-0000-0000-000000000000",
"Ref": "00000000-0000-0000-0000-000000000000",
"Number": "1",
"CityRef": "00000000-0000-0000-0000-000000000000",
"CityDescription": "Заболотів (Снятинський р-н)",
"CityDescriptionRu": "Заболотов (Снятинский р-н)",
"SettlementRef": "00000000-0000-0000-0000-000000000000",
"SettlementDescription": "Заболотів",
"SettlementAreaDescription": "Івано-Франківська область",
"SettlementRegionsDescription": "Снятинський р-н",
"SettlementTypeDescription": "селище міського типу",
"SettlementTypeDescriptionRu": "поселок городского типа",
"Longitude": 25.284086,
"Latitude": 48.467503,
"PostFinance": "1",
"BicycleParking": "0",
"PaymentAccess": "1",
"POSTerminal": "1",
"InternationalShipping": "1",
"SelfServiceWorkplacesCount": "0",
"TotalMaxWeightAllowed": "0",
"PlaceMaxWeightAllowed": "1000",
"SendingLimitationsOnDimensions": {
"Width": 170,
"Height": 170,
"Length": 300
},
"ReceivingLimitationsOnDimensions": {
"Width": 170,
"Height": 170,
"Length": 300
},
"Reception": {
"Monday": "16:45-18:00",
"Tuesday": "16:45-18:00",
"Wednesday": "16:45-18:00",
"Thursday": "16:45-18:00",
"Friday": "16:45-18:00",
"Saturday": "16:30-17:00",
"Sunday": "10:00-15:00"
},
"Delivery": {
"Monday": "08:00-12:00",
"Tuesday": "08:00-12:00",
"Wednesday": "08:00-12:00",
"Thursday": "08:00-12:00",
"Friday": "08:00-12:00",
"Saturday": "09:00-12:00",
"Sunday": "09:00-14:30"
},
"Schedule": {
"Monday": "09:00-19:00",
"Tuesday": "09:00-19:00",
"Wednesday": "09:00-19:00",
"Thursday": "09:00-19:00",
"Friday": "09:00-19:00",
"Saturday": "09:00-18:00",
"Sunday": "10:00-18:00"
},
"DistrictCode": "Ск За",
"WarehouseStatus": "Working",
"WarehouseStatusDate": "4/2/21 0:00",
"CategoryOfWarehouse": "Branch",
"RegionCity": "ЧЕРНІВЦІ",
"WarehouseForAgent": "1",
"MaxDeclaredCost": "0",
"DenyToSelect": "1",
"PostMachineType": "",
"PostalCodeUA": "15001",
"OnlyReceivingParcel": "0",
"WarehouseIndex": "101/102"
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод getWarehouses працює в моделі Address (або AddressGeneral) та завантажує довідник відділень компанії «Нова пошта» у контексті населених пунктів України.
API-ключ користувача
Назва моделі API
Назва методу API
Успішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 597
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>AddressGeneral</modelName>
<calledMethod>getWarehouses</calledMethod>
<methodProperties>
<FindByString></FindByString>
<CityName>Київ</CityName>
<CityRef>00000000-0000-0000-0000-000000000000</CityRef>
<Page>1</Page>
<Limit>50</Limit>
<Language>UA</Language>
<TypeOfWarehouseRef>00000000-0000-0000-0000-000000000000</TypeOfWarehouseRef>
<WarehouseId>151</WarehouseId>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<SiteKey>10119</SiteKey>
<Description>Відділення №1: вул. М. Грушевського, 3</Description>
<DescriptionRu>Отделение №1: ул. М. Грушевского, 3</DescriptionRu>
<ShortAddress>Заболотів, М. Грушевського, 3</ShortAddress>
<ShortAddressRu>Заболотов, Грушевского, 3</ShortAddressRu>
<Phone>380800500609</Phone>
<TypeOfWarehouse>00000000-0000-0000-0000-000000000000</TypeOfWarehouse>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<Number>1</Number>
<CityRef>00000000-0000-0000-0000-000000000000</CityRef>
<CityDescription>Заболотів (Снятинський р-н)</CityDescription>
<CityDescriptionRu>Заболотов (Снятинский р-н)</CityDescriptionRu>
<SettlementRef>00000000-0000-0000-0000-000000000000</SettlementRef>
<SettlementDescription>Заболотів</SettlementDescription>
<SettlementAreaDescription>Івано-Франківська область</SettlementAreaDescription>
<SettlementRegionsDescription>Снятинський р-н</SettlementRegionsDescription>
<SettlementTypeDescription>селище міського типу</SettlementTypeDescription>
<SettlementTypeDescriptionRu>поселок городского типа</SettlementTypeDescriptionRu>
<Longitude>25.284086000000000</Longitude>
<Latitude>48.467503000000000</Latitude>
<PostFinance>1</PostFinance>
<BicycleParking>0</BicycleParking>
<PaymentAccess>1</PaymentAccess>
<POSTerminal>1</POSTerminal>
<InternationalShipping>1</InternationalShipping>
<SelfServiceWorkplacesCount>0</SelfServiceWorkplacesCount>
<TotalMaxWeightAllowed>0</TotalMaxWeightAllowed>
<PlaceMaxWeightAllowed>1000</PlaceMaxWeightAllowed>
<SendingLimitationsOnDimensions>
<Width>170</Width>
<Height>170</Height>
<Length>300</Length>
</SendingLimitationsOnDimensions>
<ReceivingLimitationsOnDimensions>
<Width>170</Width>
<Height>170</Height>
<Length>300</Length>
</ReceivingLimitationsOnDimensions>
<Reception>
<Monday>16:45-18:00</Monday>
<Tuesday>16:45-18:00</Tuesday>
<Wednesday>16:45-18:00</Wednesday>
<Thursday>16:45-18:00</Thursday>
<Friday>16:45-18:00</Friday>
<Saturday>16:30-17:00</Saturday>
<Sunday>10:00-15:00</Sunday>
</Reception>
<Delivery>
<Monday>08:00-12:00</Monday>
<Tuesday>08:00-12:00</Tuesday>
<Wednesday>08:00-12:00</Wednesday>
<Thursday>08:00-12:00</Thursday>
<Friday>08:00-12:00</Friday>
<Saturday>09:00-12:00</Saturday>
<Sunday>09:00-14:30</Sunday>
</Delivery>
<Schedule>
<Monday>09:00-19:00</Monday>
<Tuesday>09:00-19:00</Tuesday>
<Wednesday>09:00-19:00</Wednesday>
<Thursday>09:00-19:00</Thursday>
<Friday>09:00-19:00</Friday>
<Saturday>09:00-18:00</Saturday>
<Sunday>10:00-18:00</Sunday>
</Schedule>
<DistrictCode>Ск За</DistrictCode>
<WarehouseStatus>Working</WarehouseStatus>
<WarehouseStatusDate>4/2/21 0:00</WarehouseStatusDate>
<CategoryOfWarehouse>Branch</CategoryOfWarehouse>
<RegionCity>ЧЕРНІВЦІ</RegionCity>
<WarehouseForAgent>1</WarehouseForAgent>
<MaxDeclaredCost>0</MaxDeclaredCost>
<DenyToSelect>1</DenyToSelect>
<PostMachineType></PostMachineType>
<PostalCodeUA>15001</PostalCodeUA>
<OnlyReceivingParcel>0</OnlyReceivingParcel>
<WarehouseIndex>101/102</WarehouseIndex>
</item>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Метод getWarehouseTypes працює в моделі Address (або AddressGeneral) та завантажує довідник типів відділень компанії «Нова пошта».
API-ключ користувача
[ВАШ КЛЮЧ]Назва моделі API
Назва методу API
Успішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 116
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "AddressGeneral",
"calledMethod": "getWarehouseTypes",
"methodProperties": {}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"Ref": "00000000-0000-0000-0000-000000000000",
"Description": "Поштове відділення",
"DescriptionRu": "Почтовое отделение"
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод getWarehouseTypes працює в моделі Address (або AddressGeneral) та завантажує довідник типів відділень компанії «Нова пошта».
API-ключ користувача
Назва моделі API
Назва методу API
Успішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 247
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>AddressGeneral</modelName>
<calledMethod>getWarehouseTypes</calledMethod>
<methodProperties>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<Description>Поштове відділення</Description>
<DescriptionRu>Почтовое отделение</DescriptionRu>
</item>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Метод getStreet працює в моделі Address (або AddressGeneral) та завантажує довідник вулиць в межах населених пунктів України, куди здійснює доставку компанія «Нова пошта».
Довідник використовується під час створення відправлень з типом доставки від/до адреси клієнта. Щоб знайти конкретний проспект чи вулицю, потрібно в запит додати параметр FindByString (пошук за рядками) і задати назву у його значенні.
API-ключ користувача
[ВАШ КЛЮЧ]Назва моделі API
Назва методу API
Успішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 204
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "AddressGeneral",
"calledMethod": "getStreet",
"methodProperties": {
"CityRef": "00000000-0000-0000-0000-000000000000",
"FindByString": "Київ",
"Page": "1",
"Limit": ""
}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"Ref": "00000000-0000-0000-0000-000000000000",
"Description": "Хрещатик",
"StreetsTypeRef": "00000000-0000-0000-0000-000000000000",
"StreetsType": "00000000-0000-0000-0000-000000000000"
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод getStreet працює в моделі Address (або AddressGeneral) та завантажує довідник вулиць в межах населених пунктів України, куди здійснює доставку компанія «Нова пошта».
Довідник використовується під час створення відправлень з типом доставки від/до адреси клієнта. Щоб знайти конкретний проспект чи вулицю, потрібно в запит додати параметр FindByString (пошук за рядками) і задати назву у його значенні.
API-ключ користувача
Назва моделі API
Назва методу API
Успішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 400
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>AddressGeneral</modelName>
<calledMethod>getStreet</calledMethod>
<methodProperties>
<CityRef>00000000-0000-0000-0000-000000000000</CityRef>
<FindByString>Київ</FindByString>
<Page>1</Page>
<Limit></Limit>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<Description>Хрещатик</Description>
<StreetsTypeRef>00000000-0000-0000-0000-000000000000</StreetsTypeRef>
<StreetsType>00000000-0000-0000-0000-000000000000</StreetsType>
</item>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Метод getSettlementCountryRegion працює в моделі Address (або AddressGeneral). За допомогою цього методу можна завантажити довідник районів областей населених пунктів, аналогічний даним методу getSettlements.
API-ключ користувача
[ВАШ КЛЮЧ]Назва моделі API
Назва методу API
Успішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 173
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "AddressGeneral",
"calledMethod": "getSettlementCountryRegion",
"methodProperties": {
"AreaRef": "00000000-0000-0000-0000-000000000000"
}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"Ref": "00000000-0000-0000-0000-000000000000",
"AreasCenter": "00000000-0000-0000-0000-000000000000",
"Description": "Барський",
"RegionType": "район"
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод getSettlementCountryRegion працює в моделі Address (або AddressGeneral). За допомогою цього методу можна завантажити довідник районів областей населених пунктів, аналогічний даним методу getSettlements.
API-ключ користувача
Назва моделі API
Назва методу API
Успішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 321
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>AddressGeneral</modelName>
<calledMethod>getSettlementCountryRegion</calledMethod>
<methodProperties>
<AreaRef>00000000-0000-0000-0000-000000000000</AreaRef>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<AreasCenter>00000000-0000-0000-0000-000000000000</AreasCenter>
<Description>Барський</Description>
<RegionType>район</RegionType>
</item>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Метод getSettlementAreas працює в моделі AddressGeneral. Метод надає довідник областей населених пунктів, відповідний інформації, яку повертає метод getSettlements.
API-ключ користувача
[ВАШ КЛЮЧ]Назва моделі API
Назва методу API
Успішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 125
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "AddressGeneral",
"calledMethod": "getSettlementAreas",
"methodProperties": {
"Ref": ""
}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"Description": "Вінницька",
"Ref": "00000000-0000-0000-0000-000000000000",
"AreasCenter": "00000000-0000-0000-0000-000000000000",
"RegionType": "область"
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод getSettlementAreas працює в моделі AddressGeneral. Метод надає довідник областей населених пунктів, відповідний інформації, яку повертає метод getSettlements.
API-ключ користувача
Назва моделі API
Назва методу API
Успішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 269
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>AddressGeneral</modelName>
<calledMethod>getSettlementAreas</calledMethod>
<methodProperties>
<Ref></Ref>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Description>Вінницька</Description>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<AreasCenter>00000000-0000-0000-0000-000000000000</AreasCenter>
<RegionType>область</RegionType>
</item>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Останнє оновлення