API Экспресс-накладная

Работа с экспресс-накладными

Удалить экспресс-накладную

Метод «delete», работает в модели «InternetDocument», этот метод необходим для удаления экспресс-накладной (интернет-документа)

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   Свойства метода
DocumentRefs* string[36] Массив идентификаторов удаляемых экспресс-накладных
* Обозначение обязательного параметра

{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "InternetDocument",
"calledMethod": "delete",
"methodProperties": {
"DocumentRefs": "2813aec6-be5b-11e4-a77a-005056887b8d"
}
}
<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>InternetDocument</modelName>
<calledMethod>delete</calledMethod>
<methodProperties>
<DocumentRefs>
<item>288af9a6-8509-11e4-8d2b-005056801329</item>
</DocumentRefs>
</methodProperties>
</file>

Ответ 200

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


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

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

{
"success": true,
"data": [
{
"Ref": "556b15ce-b744-11e4-a77a-005056887b8d"
}
],
"errors": [],
"warnings": [],
"info": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Ref>fced4429-8523-11e4-8d2b-005056801329</Ref>
</item>
</data>
<errors />
<warnings />
<info />
</root>