API Адреса
Работа с адресами
- Онлайн поиск в справочнике населенных пунктов
- Онлайн поиск улиц в справочнике населенных пунктов
- Создать адрес контрагента (отправитель/получатель)
- Редактировать адрес контрагента (отправитель/получатель)
- Удалить адрес контрагента (отправитель/получатель)
- Справочник городов компании
- Справочник населенных пунктов Украины
- Справочник географических областей Украины
- Справочник отделений и типов отделений
- Справочник улиц компании
Редактировать адрес контрагента (отправитель/получатель)
Метод «update», работает в модели «Address», этот метод необходим для обновления адреса контрагента отправителя/получателя.
Редактировать данные контрагента можно только с момента его создания и до момента создания интернет документа с ним.
URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]/
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/
Доступность: Требует использования API-ключа.
URL-адрес запроса
Параметры запроса
string
Форматы JSON, XML
Заголовки запросов
(дополнительный)
string
Тип формата текста, отправляемого в API.
Текст запроса
Параметр | Тип данных | Описание |
apiKey* | string[36] | Ваш ключ API 2.0 |
modelName* | string | Имя модели |
calledMethod* | string | Имя вызываемого метода |
methodProperties | Свойства метода | |
Ref | string[36] | Идентификатор адреса |
CounterpartyRef | string[36] | Идентификатор контрагента |
StreetRef | string[36] | Идентификатор улицы |
BuildingNumber | string | Номер дома |
Flat | string | Квартира |
Note | string[40] | Комментарий |
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "Address",
"calledMethod": "update",
"methodProperties": {
"CounterpartyRef": "5ace4a2e-13ee-11e5-add9-005056887b8d",
"Ref": "5fdf0be8-c4e6-11e5-a70c-005056801333",
"StreetRef": "bba0d9b3-4148-11dd-9198-001d60451983",
"BuildingNumber": "45",
"Flat": "12",
"Note": "Комментарий"
}
}
<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>Address</modelName>
<calledMethod>update</calledMethod>
<methodProperties>
<CounterpartyRef>5ace4a2e-13ee-11e5-add9-005056887b8d</CounterpartyRef>
<Ref>5fdf0be8-c4e6-11e5-a70c-005056801333</Ref>
<StreetRef>bba0d9b3-4148-11dd-9198-001d60451983</StreetRef>
<BuildingNumber>45</BuildingNumber>
<Flat>12</Flat>
<Note>Комментарий</Note>
</methodProperties>
</file>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
Ref | string[36] | Идентификатор адреса |
Description | string[50] | Адрес |
{
"success": true,
"data": [
{
"Ref": "503702df-cd4c-11e4-bdb5-005056801329",
"Description": "Бердичівська вул. 12 кв. 10 Коментар"
}
],
"errors": [],
"warnings": [],
"info": []
}
<root>
<success>true</success>
<data>
<Ref>503702df-cd4c-11e4-bdb5-005056801329</Ref>
<Description>Бердичівська вул. 12 кв. 10 Коментар</Description>
</data>
<warnings></warnings>
</root>