API Адреса
Работа с адресами
- Онлайн поиск в справочнике населенных пунктов
- Онлайн поиск улиц в справочнике населенных пунктов
- Создать адрес контрагента (отправитель/получатель)
- Редактировать адрес контрагента (отправитель/получатель)
- Удалить адрес контрагента (отправитель/получатель)
- Справочник городов компании
- Справочник населенных пунктов Украины
- Справочник географических областей Украины
- Справочник отделений и типов отделений
- Справочник улиц компании
Справочник улиц компании
Метод «getStreet» работает в модели «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 | Свойства метода | |
CityRef* | string[36] | Идентификатор города |
FindByString* | string[36] | Поиск по строкам |
Page | int[10] | Страница до 500 записей на странице |
{
"modelName": "Address",
"calledMethod": "getStreet",
"methodProperties": {
"CityRef": "ebc0eda9-93ec-11e3-b441-0050568002cf"
},
"apiKey": "[ВАШ КЛЮЧ]"
}
<?xml version="1.0" encoding="utf-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>Address</modelName>
<calledMethod>getStreet</calledMethod>
<methodProperties>
<CityRef>ebc0eda9-93ec-11e3-b441-0050568002cf</CityRef>
</methodProperties>
</file>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
Ref | string[36] | Идентификатор адреса |
Ref | string[36] | Идентификатор улицы |
Description | string[100] | Название улицы на украинском языке |
StreetsTypeRef | string[36] | Название типа улицы на украинском языке |
StreetsType | string[] | Тип улицы |
{
"success": true,
"data": [
{
"Description": "Академічна",
"Ref": "b5e79222-2d34-11e4-acce-0050568002cf",
"StreetsTypeRef": "Street",
"StreetsType": "вул."
},
{
"Description": "Будівельників",
"Ref": "7b4f37cc-6e34-11e4-acce-0050568002cf",
"StreetsTypeRef": "Highway",
"StreetsType": "шосе"
},
{
"Description": "Вінницька",
"Ref": "9be2d800-0833-11e4-acce-0050568002cf",
"StreetsTypeRef": "Street",
"StreetsType": "вул."
},
{
"Description": "Гагаріна",
"Ref": "a76c21a5-0c01-11e4-acce-0050568002cf",
"StreetsTypeRef": "Street",
"StreetsType": "вул."
},
{
"Description": "Дачна",
"Ref": "2e3091c2-6195-11e4-acce-0050568002cf",
"StreetsTypeRef": "Street",
"StreetsType": "вул."
},
{
"Description": "Житня",
"Ref": "e54f35ea-c18e-11e4-a77a-005056887b8d",
"StreetsTypeRef": "Street",
"StreetsType": "вул."
},
{
"Description": "Квітнева ",
"Ref": "1e529c5c-6fba-11e4-acce-0050568002cf",
"StreetsTypeRef": "Street",
"StreetsType": "вул."
},
{
"Description": "Малиновського ",
"Ref": "487de665-cbf0-11e4-a77a-005056887b8d",
"StreetsTypeRef": "Street",
"StreetsType": "вул."
},
{
"Description": "Мічуріна",
"Ref": "a76c21a3-0c01-11e4-acce-0050568002cf",
"StreetsTypeRef": "Street",
"StreetsType": "вул."
},
{
"Description": "Молодіжна",
"Ref": "a76c21a6-0c01-11e4-acce-0050568002cf",
"StreetsTypeRef": "Street",
"StreetsType": "вул."
},
{
"Description": "Мудрого Ярослава",
"Ref": "a76c21a7-0c01-11e4-acce-0050568002cf",
"StreetsTypeRef": "Street",
"StreetsType": "вул."
},
{
"Description": "Наукова",
"Ref": "b77f7846-8756-11e4-acce-0050568002cf",
"StreetsTypeRef": "Street",
"StreetsType": "вул."
},
{
"Description": "Прибережна ",
"Ref": "b94e8a22-85bf-11e4-acce-0050568002cf",
"StreetsTypeRef": "Street",
"StreetsType": "вул."
},
{
"Description": "Садова ",
"Ref": "83c507e1-bcee-11e4-a77a-005056887b8d",
"StreetsTypeRef": "Street",
"StreetsType": "вул."
},
{
"Description": "Тимірязєва ",
"Ref": "02cb4007-6fde-11e4-acce-0050568002cf",
"StreetsTypeRef": "Street",
"StreetsType": "вул."
},
{
"Description": "Яблунева",
"Ref": "0e4a2d7e-372d-11e4-acce-0050568002cf",
"StreetsTypeRef": "Street",
"StreetsType": "вул."
}
],
"errors": [],
"warnings": [],
"info": []
}
<root>
<success>true</success>
<data>
<item>
<Description>Академічна</Description>
<Ref>b5e79222-2d34-11e4-acce-0050568002cf</Ref>
<StreetsTypeRef>Street</StreetsTypeRef>
<StreetsType>вул.</StreetsType>
</item>
<item>
<Description>Будівельників</Description>
<Ref>7b4f37cc-6e34-11e4-acce-0050568002cf</Ref>
<StreetsTypeRef>Highway</StreetsTypeRef>
<StreetsType>шосе</StreetsType>
</item>
<item>
<Description>Вінницька</Description>
<Ref>9be2d800-0833-11e4-acce-0050568002cf</Ref>
<StreetsTypeRef>Street</StreetsTypeRef>
<StreetsType>вул.</StreetsType>
</item>
<item>
<Description>Гагаріна</Description>
<Ref>a76c21a5-0c01-11e4-acce-0050568002cf</Ref>
<StreetsTypeRef>Street</StreetsTypeRef>
<StreetsType>вул.</StreetsType>
</item>
<item>
<Description>Дачна</Description>
<Ref>2e3091c2-6195-11e4-acce-0050568002cf</Ref>
<StreetsTypeRef>Street</StreetsTypeRef>
<StreetsType>вул.</StreetsType>
</item>
<item>
<Description>Житня</Description>
<Ref>e54f35ea-c18e-11e4-a77a-005056887b8d</Ref>
<StreetsTypeRef>Street</StreetsTypeRef>
<StreetsType>вул.</StreetsType>
</item>
<item>
<Description>Квітнева </Description>
<Ref>1e529c5c-6fba-11e4-acce-0050568002cf</Ref>
<StreetsTypeRef>Street</StreetsTypeRef>
<StreetsType>вул.</StreetsType>
</item>
<item>
<Description>Малиновського </Description>
<Ref>487de665-cbf0-11e4-a77a-005056887b8d</Ref>
<StreetsTypeRef>Street</StreetsTypeRef>
<StreetsType>вул.</StreetsType>
</item>
<item>
<Description>Мічуріна</Description>
<Ref>a76c21a3-0c01-11e4-acce-0050568002cf</Ref>
<StreetsTypeRef>Street</StreetsTypeRef>
<StreetsType>вул.</StreetsType>
</item>
<item>
<Description>Молодіжна</Description>
<Ref>a76c21a6-0c01-11e4-acce-0050568002cf</Ref>
<StreetsTypeRef>Street</StreetsTypeRef>
<StreetsType>вул.</StreetsType>
</item>
<item>
<Description>Мудрого Ярослава</Description>
<Ref>a76c21a7-0c01-11e4-acce-0050568002cf</Ref>
<StreetsTypeRef>Street</StreetsTypeRef>
<StreetsType>вул.</StreetsType>
</item>
<item>
<Description>Наукова</Description>
<Ref>b77f7846-8756-11e4-acce-0050568002cf</Ref>
<StreetsTypeRef>Street</StreetsTypeRef>
<StreetsType>вул.</StreetsType>
</item>
<item>
<Description>Прибережна </Description>
<Ref>b94e8a22-85bf-11e4-acce-0050568002cf</Ref>
<StreetsTypeRef>Street</StreetsTypeRef>
<StreetsType>вул.</StreetsType>
</item>
<item>
<Description>Садова </Description>
<Ref>83c507e1-bcee-11e4-a77a-005056887b8d</Ref>
<StreetsTypeRef>Street</StreetsTypeRef>
<StreetsType>вул.</StreetsType>
</item>
<item>
<Description>Тимірязєва </Description>
<Ref>02cb4007-6fde-11e4-acce-0050568002cf</Ref>
<StreetsTypeRef>Street</StreetsTypeRef>
<StreetsType>вул.</StreetsType>
</item>
<item>
<Description>Яблунева</Description>
<Ref>0e4a2d7e-372d-11e4-acce-0050568002cf</Ref>
<StreetsTypeRef>Street</StreetsTypeRef>
<StreetsType>вул.</StreetsType>
</item>
</data>
<errors />
<warnings />
<info />
</root>