API Адреса
Работа с адресами
- Онлайн поиск в справочнике населенных пунктов
- Онлайн поиск улиц в справочнике населенных пунктов
- Создать адрес контрагента (отправитель/получатель)
- Редактировать адрес контрагента (отправитель/получатель)
- Удалить адрес контрагента (отправитель/получатель)
- Справочник городов компании
- Справочник населенных пунктов Украины
- Справочник географических областей Украины
- Справочник отделений и типов отделений
- Справочник улиц компании
Удалить адрес контрагента (отправитель/получатель)
Метод «delete», работает в модели «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] | Идентификатор адреса |
{
"modelName": "Address",
"calledMethod": "delete",
"methodProperties": {
"Ref": "d5aa1638-1dbf-11e6-a70c-005056801333"
},
"apiKey": "[ВАШ КЛЮЧ]"
}
<?xml version="1.0" encoding="utf-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>Address</modelName>
<calledMethod>delete</calledMethod>
<methodProperties>
<Ref>d5aa1638-1dbf-11e6-a70c-005056801333</Ref>
</methodProperties>
</file>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
Ref | string[36] | Идентификатор адреса |
{
"success": true,
"data": [
{
"Ref": "d5aa1638-1dbf-11e6-a70c-005056801333"
}
],
"errors": [],
"warnings": [],
"info": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<data>
<element>
<Ref>d5aa1638-1dbf-11e6-a70c-005056801333</Ref>
</element>
</data>
<errors />
<info />
<success>true</success>
<warnings />
</root>