API Контрагенты

Работа с данными Контрагента

Удалить Контрагента получателя

Удалить контрагента отправителя/получателя

Метод «delete», работает в модели «Counterparty», этот метод необходим для удаления контрагента получателя. Для удаления данных контрагента отправителя необходимо обращаться к Вашему менеджеру.

URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/


Доступность: Требует использования API-ключа.

Try it

URL-адрес запроса

Параметры запроса

string

Форматы JSON, XML

Заголовки запросов

(дополнительный)
string
Тип формата текста, отправляемого в API.

Текст запроса

Параметр Тип данных Описание
apiKey* string[36] Ваш ключ API 2.0
modelName* string Имя модели
calledMethod* string Имя вызываемого метода
methodProperties string Свойства метода
Ref string[36] Идентификатор Контрагента
* Обозначение обязательного параметра

{
"apiKey": "[ВАШ КЛЮЧ]",
 "modelName": "Counterparty",
 "calledMethod": "delete",
 "methodProperties": {
 "Ref": "eb7c1c2e-cc85-11e4-bdb5-005056801329"
 }
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
 <modelName>Counterparty</modelName>
 <calledMethod>delete</calledMethod>
 <methodProperties>
 <Ref>eb7c1c2e-cc85-11e4-bdb5-005056801329</Ref>
 </methodProperties>
</root>

Ответ 200

Всегда возвращает код 200 даже при логических ошибках.


Тело ответа на запрос

Параметр Тип данных Описание
Ref string[36] Идентификатор удаленого контрагента

<?xml version="1.0" encoding="UTF-8"?>
<root>
 <success>true</success>
 <data>
 <item>
 <Ref>6cd66439-d9ef-11e4-bdb5-005056801329</Ref>
 </item>
 </data>
 <errors></errors>
 <warnings></warnings>
 <info></info>
 </root>
{
 "success": true,
 "data": [
 {
 "Ref": "eb7c1c2e-cc85-11e4-bdb5-005056801329"
 }
 ],
 "errors": [],
 "warnings": [],
 "info": []
}