API Адреса
Работа с адресами
- Онлайн поиск в справочнике населенных пунктов
- Онлайн поиск улиц в справочнике населенных пунктов
- Создать адрес контрагента (отправитель/получатель)
- Редактировать адрес контрагента (отправитель/получатель)
- Удалить адрес контрагента (отправитель/получатель)
- Справочник городов компании
- Справочник населенных пунктов Украины
- Справочник географических областей Украины
- Справочник отделений и типов отделений
- Справочник улиц компании
Справочник городов компании
Получение справочника городов компании «Новая Почта» на украинском и русском языках.
Метод «getCities» работает в модели «Address», этот метод загружает справочник населенных пунктов Украины. Стоит учитывать, справочник выгружается только с населенными пунктами где есть отделения "Нова Пошта" и можно оформить доставку на отделение, а также на доставку по адресу.
Если в этот запрос добавить параметр «FindByString» (поиск по строкам) и в его свойствах прописать название населенного пункта (Бровары), который нужно найти, то получим запрос с помощью которого в справочнике находится населенный пункт.
"methodProperties": {
"FindByString": "Бровари"
}
Необходимо сохранять копию справочников на стороне клиента и поддерживать ее в актуальном состоянии.
Рекомендуется проводить обновление справочников раз в сутки.
URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]/
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/
Доступность: Требует использования API-ключа.
URL-адрес запроса
Параметры запроса
Форматы JSON, XML
Заголовки запросов
Текст запроса
Параметр | Тип данных | Описание |
apiKey* | string[36] | Ваш ключ API 2.0 |
modelName* | string | Имя модели |
calledMethod* | string | Имя вызываемого метода |
methodProperties | Свойства метода | |
Ref | string[36] | Идентификатор города |
Page | Int[] | Номер страницы для отображения |
FindByString | string[] | Поиск по названию города |
{
"modelName": "Address",
"calledMethod": "getCities",
"methodProperties": {
"Ref": "ebc0eda9-93ec-11e3-b441-0050568002cf"
},
"apiKey": "[ВАШ КЛЮЧ]"
}
<?xml version="1.0" encoding="utf-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>Address</modelName>
<calledMethod>getCities</calledMethod>
<methodProperties>
<Ref>ebc0eda9-93ec-11e3-b441-0050568002cf</Ref>
</methodProperties>
</file>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
Ref | string[36] | Идентификатор города |
Description | string[50] | Город на Украинском языке |
DescriptionRu | string[50] | Город на русском языке |
Delivery1- Delivery7 | int[1] | Наличие доставки отправления в днях недели |
Area | string[36] | Область |
Conglomerates | null | Конгломерат |
CityID | int[] | Код населенного пункта |
SettlementType | string[36] | Идентификатор (REF) типа населенного пункта |
SettlementTypeDescriptionRu | string[36] | Описание типа населенного пункта на Русском языке |
SettlementTypeDescription | string[36] | Описание типа населенного пункта на Украинском языке |
{
"success": true,
"data": [
{
"Description": "Агрономічне",
"DescriptionRu": "Агрономичное",
"Ref": "ebc0eda9-93ec-11e3-b441-0050568002cf",
"Delivery1": "1",
"Delivery2": "1",
"Delivery3": "1",
"Delivery4": "1",
"Delivery5": "1",
"Delivery6": "0",
"Delivery7": "0",
"Area": "71508129-9b87-11de-822f-000c2965ae0e",
"SettlementType": "563ced13-f210-11e3-8c4a-0050568002cf",
"IsBranch": "0",
"PreventEntryNewStreetsUser": null,
"Conglomerates": null,
"CityID": "890",
"SettlementTypeDescriptionRu": "село",
"SettlementTypeDescription": "село"
}
],
"errors": [],
"warnings": [],
"info": {
"totalCount": 1
},
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}
<root>
<success>true</success>
<data>
<item>
<Description>Агрономічне</Description>
<DescriptionRu>Агрономичное</DescriptionRu>
<Ref>ebc0eda9-93ec-11e3-b441-0050568002cf</Ref>
<Delivery1>1</Delivery1>
<Delivery2>1</Delivery2>
<Delivery3>1</Delivery3>
<Delivery4>1</Delivery4>
<Delivery5>1</Delivery5>
<Delivery6>0</Delivery6>
<Delivery7>0</Delivery7>
<Area>71508129-9b87-11de-822f-000c2965ae0e</Area>
<SettlementType>563ced13-f210-11e3-8c4a-0050568002cf</SettlementType>
<IsBranch>0</IsBranch>
<PreventEntryNewStreetsUser />
<Conglomerates />
<CityID>890</CityID>
<SettlementTypeDescriptionRu>село</SettlementTypeDescriptionRu>
<SettlementTypeDescription>село</SettlementTypeDescription>
</item>
</data>
<errors />
<warnings />
<info>
<totalCount>1</totalCount>
</info>
<messageCodes />
<errorCodes />
<warningCodes />
<infoCodes />
</root>