API Услуга переадресация отправления
Возможность самостоятельного оформления Клиентом услуги «Переадресация» при использовании API.
Услуга доступна для клиентов отправителей и получателей.
- Проверка возможности создания заявки на переадресацию отправления
- Создание заявки переадресация отправления (отделение/адрес)
- Удаление заявки
- Получение списка заявок
3. Удаление заявки
Метод «delete», работает в модели «AdditionalServiceGeneral», этот метод позволяет удалить заявку переадресации.
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 | Имя модели |
calledMetdod* | string | Имя вызываемого метода |
metdodProperties | Свойства метода | |
Ref* | string[36] | Идентификатор заявки |
OrderType* | string[36] | Константа orderRedirecting |
* Обозначение обязательного параметра
{
"apiKey":"[ВАШ КЛЮЧ]",
"modelName":"AdditionalServiceGeneral",
"calledMethod":"delete",
"methodProperties":{
"Ref":"",
"OrderType":"orderRedirecting"
}
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<calledMethod>delete</calledMethod>
<methodProperties>
<OrderType>orderRedirecting</OrderType>
<Ref></Ref>
</methodProperties>
<modelName>AdditionalServiceGeneral</modelName>
</root>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
---|---|---|
Number | string[36] | Номер удаленной заявки |
{
"success":true,
"data":[
{
"Number":"102-00006096",
}
],
"errors":[],
"warnings":[],
"info":[],
"messageCodes":[],
"errorCodes":[],
"warningCodes":[],
"infoCodes":[]
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<data>
<element>
<Number>102-00006096</Number>
</element>
</data>
<errorCodes />
<errors />
<info />
<infoCodes />
<messageCodes />
<success>true</success>
<warningCodes />
<warnings />
</root>