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

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

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

Метод «getReturnOrdersList», работает в модели «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] Номер заявки на возврат
Ref string[36] Ref заявки на возврат
BeginDate int[36] Дата создания заявки с в формате дд.мм.гггг
EndDate int[36] Дата создания заявки по в формате дд.мм.гггг
Page string[36] Номер страницы
Limit string[36] Лимит на странице

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

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

Расширенный пример

{  
  "apiKey":"[ВАШ КЛЮЧ]",
  "modelName":"AdditionalService",
  "calledMethod":"getReturnOrdersList",
  "methodProperties":{
  "Number":"номер заявки"
  "Ref":"реф заявки"
  "BeginDate":"Дата создания заявки с в формате дд.мм.гггг"
  "EndDate":" Дата создания заявки по в формате дд.мм.гггг "
  "Page":"страница"
  "Limit":"лимит на странице"
  }
}

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

Ответ 200

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


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

Параметр Тип данных Описание
OrderRef string[36] Ref заявки на возврат
OrderNumber int[36] Номер заявкина возврат
OrderStatus string[36] Статус заявки
DocumentNumber string[36] Номер документа, на основании которого создана заявка
CounterpartyRecipient string[36] Контрагент, который будет получателем в ЕН возврата
ContactPersonRecipient string[36] Контактное лицо, которое будет получателем в ЕН возврата
AddressRecipient string[36] Адрес на который будет оформлена ЕН возврата
DeliveryCost string[36] Стоимость ЕН возврата (если создана ЕН)
EstimatedDeliveryDate string[36] Расчетная дата доставки возврата (если есть ЕН)
ExpressWaybillNumber string[36] Номер ЕН возврата (если создана ЕН)
ExpressWaybillStatus string[36] статус ЕН на основании (если создана ЕН)

{  
  "success":true,
  "data":[  
    {  
      "OrderRef":"d729fae2-9f25-11e5-83bc-005056886752",
      "OrderNumber":"102-00003168",
      "OrderStatus":"Прийняте",
      "DocumentNumber":"20600000043015",
      "CounterpartyRecipient":"Комунальник",
      "ContactPersonRecipient":"Іванов Іван Іванович",
      "AddressRecipient":"Ангеліної Паші вул. 45 кв. 12",
      "DeliveryCost":"20",
      "EstimatedDeliveryDate":"2015-12-10 10:33:47",
      "ExpressWaybillNumber":"59000042651620",
      "ExpressWaybillStatus":"Відправлення у місті Київ"
    }
  ],
  "errors":[],
  "warnings":[],
  "info":[],
  "messageCodes":[],
  "errorCodes":[],
  "warningCodes":[],
  "infoCodes":[]
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
   <data>
      <element>
         <AddressRecipient>Ангеліної Паші вул. 45 кв. 12</AddressRecipient>
         <ContactPersonRecipient>Іванов Іван Іванович</ContactPersonRecipient>
         <CounterpartyRecipient>Комунальник</CounterpartyRecipient>
         <DeliveryCost>20</DeliveryCost>
         <DocumentNumber>20600000043015</DocumentNumber>
         <EstimatedDeliveryDate>2015-12-10 10:33:47</EstimatedDeliveryDate>
         <ExpressWaybillNumber>59000042651620</ExpressWaybillNumber>
         <ExpressWaybillStatus>Відправлення у місті Київ</ExpressWaybillStatus>
         <OrderNumber>102-00003168</OrderNumber>
         <OrderRef>d729fae2-9f25-11e5-83bc-005056886752</OrderRef>
         <OrderStatus>Прийняте</OrderStatus>
      </element>
   </data>
   <errorCodes />
   <errors />
   <info />
   <infoCodes />
   <messageCodes />
   <success>true</success>
   <warningCodes />
   <warnings />
</root>