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

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

4. Создание заявки на возврат

Метод «save», работает в модели «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*   Свойства метода
IntDocNumber* string[36] Номер интернет-документа
PaymentMethod* string[36] Форма оплаты, доступны Cash или NonCash
Reason* string[36] Ref причины возврата
SubtypeReason* string[36] Ref подтипа причины
Note string[100] Описание от клиента, не обязательно
OrderType* string Константа - orderCargoReturn
ReturnAddressRef* string[36] Ref блока из запроса CheckPossibilityCreateReturn

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

{  
  "apiKey":"[ВАШ КЛЮЧ]",
  "modelName":"AdditionalService",
  "calledMethod":"save",
  "methodProperties":{  
    "IntDocNumber":"206004560074695",
    "PaymentMethod":"Cash",
    "Reason":"7d07b1de-1d6d-11e4-acce-0050568002cf",
    "SubtypeReason":"faaeb2b9-1d6d-11e4-acce-0050568002cf",
    "Note":"Произвольное описание",
    "OrderType":"orderCargoReturn",
    "ReturnAddressRef":"6cec19e5-cb80-11e6-aaab-005056801329"
  }
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <calledMethod>save</calledMethod>
    <methodProperties>
        <IntDocNumber>206004560074695</IntDocNumber>
        <Note>Произвольное описание</Note>
        <OrderType>orderCargoReturn</OrderType>
        <PaymentMethod>Cash</PaymentMethod>
        <Reason>7d07b1de-1d6d-11e4-acce-0050568002cf</Reason>
        <ReturnAddressRef>6cec19e5-cb80-11e6-aaab-005056801329</ReturnAddressRef>
        <SubtypeReason>faaeb2b9-1d6d-11e4-acce-0050568002cf</SubtypeReason>
    </methodProperties>
    <modelName>AdditionalService</modelName>
</root>

Ответ 200

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


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

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

{  
  "success":true,
  "data":[  
    {  
      "Number":"102-00006096",
      "Ref": "53ccabcb-08c7-11e7-af9a-005056886752"
    }
  ],
  "errors":[],
  "warnings":[],
  "info":[],
  "messageCodes":[],
  "errorCodes":[
  "warningCodes":[],
  "infoCodes":[]
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <data>
        <item>
            <Number>102-00006096</Number>
            <Ref>53ccabcb-08c7-11e7-af9a-005056886752</Ref>
        </item>
            </data>
    <errorCodes />
    <errors />
    <info />
    <infoCodes />
    <messageCodes />
    <success>true</success>
    <warningCodes />
    <warnings />
</root>