API Услуга возврат отправления

Возможность самостоятельного оформления Клиентом услуги «Возврат отправления» при использовании API.
Услуга доступна только для клиентов отправителей.

6. Удаление заявки на возврат

Метод «delete», работает в модели «AdditionalService», этот метод позволяет удалить заявку на возврат.

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   Свойства метода
Ref string[36] Ref заявки

* Обозначение обязательного параметра

{  
  "apiKey":"[ВАШ КЛЮЧ]",
  "modelName":"AdditionalService",
  "calledMethod":"delete",
  "methodProperties":{  
    "Ref":"ed799f37-d804-11e6-af9a-005056886752"
  }
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
   <apiKey>[ВАШ КЛЮЧ]</apiKey>
   <calledMethod>delete</calledMethod>
   <methodProperties>
      <Ref>ed799f37-d804-11e6-af9a-005056886752</Ref>
   </methodProperties>
   <modelName>AdditionalService</modelName>
</root>

Ответ 200

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


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

Параметр Тип данных Описание
Number int[36] Номер удаленной заявки

{  
  "success":true,
  "data":[  
    {  
      "Number":"102-00006101"
    }
  ],
  "errors":[],
  "warnings":[],
  "info":[],
  "messageCodes":[],
  "errorCodes":[],
  "warningCodes":[],
  "infoCodes":[]
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <data>
        <item>
            <Number>102-00006101</Number>
        </item>
            </data>
    <errorCodes />
    <errors />
    <info />
    <infoCodes />
    <messageCodes />
    <success>true</success>
    <warningCodes />
    <warnings />
</root>