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

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

1. Проверка возможности создания заявки на возврат

Метод «CheckPossibilityCreateReturn», работает в модели «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   Свойства метода
Number int[36] Номер интернет-документа

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

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

Ответ 200

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


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

Параметр Тип данных Описание
NonCash Bool Возможность использования безнала
City string[36] Город получателя
Counterparty string[36] Контрагент-получатель
Address string[100] Адрес получения
Phone int[36] Телефон получателя
Ref string[36] Идентификатор блока

{  
  "success":true,
  "data":[  
    {  
      "NonCash":true,
      "City":"Київ",
      "Counterparty":"ПП Вікна",
      "ContactPerson":"Білл Гейтс",
      "Address":"м. Київ, шосе Столичне, 1",
      "Phone":"380950000000",
      "Ref":"3оf65e0d-d7dc-11e6-af9a-00505486752"
    },
    {  
      "NonCash":false,
      "City":"Львів",
      "Counterparty":" ТОВ Яблуневий сад",
      "ContactPerson":"Джобс Стівен",
      "Address":"м. Львів,  вул. 5-а Білогорська, буд. 555",
      "Phone":"380950000000",
      "Ref":"4f761149-cc25-11e6-aaab-005056801329"
    },
    {  
      "NonCash":false,
      "City":"Київ",
      "Counterparty":"ТОВ Фабрика дзеркал",
      "ContactPerson":"Ілон Макс Максович",
      "Address":"м. Київ, Відділення №3, вул. Калачівська, 13",
      "Phone":"380950000000",
      "Ref":"6cec19e5-cb80-11e6-aaab-005056801329"
    }
  ],
  "errors":[],
  "warnings":[],
  "info":[],
  "messageCodes":[],
  "errorCodes":[],
  "warningCodes":[],
  "infoCodes":[]
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Address>м. Київ, шосе Столичне, 1</Address>
            <City>Київ</City>
            <ContactPerson>Білл Гейтс</ContactPerson>
            <Counterparty>ПП Вікна</Counterparty>
            <NonCash>true</NonCash>
            <Phone>380950000000</Phone>
            <Ref>3оf65e0d-d7dc-11e6-af9a-00505486752</Ref>
        </item>
        <item>
            <Address>м. Львів,  вул. 5-а Білогорська, буд. 555</Address>
            <City>Львів</City>
            <ContactPerson>Джобс Стівен</ContactPerson>
            <Counterparty> ТОВ Яблуневий сад</Counterparty>
            <NonCash>false</NonCash>
            <Phone>380950000000</Phone>
            <Ref>4f761149-cc25-11e6-aaab-005056801329</Ref>
        </item>
        <item>
            <Address>м. Київ, Відділення №3, вул. Калачівська, 13</Address>
            <City>Київ</City>
            <ContactPerson>Ілон Макс Максович</ContactPerson>
            <Counterparty>ТОВ Фабрика дзеркал</Counterparty>
            <NonCash>false</NonCash>
            <Phone>380950000000</Phone>
            <Ref>6cec19e5-cb80-11e6-aaab-005056801329</Ref>
        </item>
    </data>
    <errorCodes />
    <errors />
    <info />
    <infoCodes />
    <messageCodes />
    <warningCodes />
    <warnings />
</root>