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

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

2. Получение списка причин возврата

Метод «getReturnReasons», работает в модели «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   Свойства метода

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

{  
  "apiKey":"[ВАШ КЛЮЧ]",
  "modelName":"AdditionalService",
  "calledMethod":"getReturnReasons",
  "methodProperties":{  

  }
}
<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalService</modelName>
    <calledMethod>getReturnReasons</calledMethod>
    <methodProperties></methodProperties>
</file>

Ответ 200

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


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

Параметр Тип данных Описание
Ref string[36] Идентификатор причины
Description string[100] Описание причины на Украинском языке

{  
  "success":true,
  "data":[  
    {  
      "Ref":"49754eb2-a9e1-11e3-9fa0-0050568002cf",
      "Description":"Відмова Одержувача"
    },
    {  
      "Ref":"7d07b1de-1d6d-11e4-acce-0050568002cf",
      "Description":"Відправник відмінив доставку відправлення"
    }
  ],
  "errors":[],
  "warnings":[],
  "info":[],
  "messageCodes":[],
  "errorCodes":[],
  "warningCodes":[],
  "infoCodes":[]
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <data>
        <item>
            <Description>Відмова Одержувача</Description>
            <Ref>49754eb2-a9e1-11e3-9fa0-0050568002cf</Ref>
        </item>
        <item>
            <Description>Відправник відмінив доставку відправлення</Description>
            <Ref>7d07b1de-1d6d-11e4-acce-0050568002cf</Ref>
        </item>
    </data>
    <errorCodes />
    <errors />
    <info />
    <infoCodes />
    <messageCodes />
    <success>true</success>
    <warningCodes />
    <warnings />
</root>