API Контрагенты
Работа с данными Контрагента
- Создать Контрагента
- Создать контактное лицо Контрагента
- Создать Контрагента с типом (юридическое лицо) организация
- Создать Контрагента с типом третьего лица
- Загрузить список адресов Контрагентов
- Загрузить параметры Контрагента
- Загрузить список контактных лиц Контрагента
- Загрузить список Контрагентов отправителей/получателей/третье лицо
- Обновить данные Контрагента
- Обновить данные контактного лица Контрагента
- Удалить Контрагента получателя
- Удалить Контактное лицо Контрагента
Удалить Контактное лицо Контрагента
Метод «delete», работает в модели «ContactPerson», этот метод необходим для удаления контактного лица контрагента отправителя/получателя. Удалять данные контактного лица контрагента могут только юридические лица.
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 | string | Свойства метода |
Ref | string[36] | Идентификатор Контактного лица Контрагента |
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "ContactPerson",
"calledMethod": "delete",
"methodProperties": {
"Ref": "9ad69c2b-159d-11e5-ad08-005056801333"
}
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>ContactPerson</modelName>
<calledMethod>delete</calledMethod>
<methodProperties>
<Ref>862aa244-159f-11e5-ad08-005056801333</Ref>
</methodProperties>
</root>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
Ref | string[36] | Идентификатор |
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data><item>
<Ref>862aa244-159f-11e5-ad08-005056801333</Ref>
</item></data>
<errors/><warnings/><info/>
</root>
{
"success": true,
"data": [
{
"Ref": "9ad69c2b-159d-11e5-ad08-005056801333"
}
],
"errors": [],
"warnings": [],
"info": []
}