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

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

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

Метод «getRedirectionOrdersList», работает в модели «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":"getRedirectionOrdersList",
  "methodProperties": {
  "Number":"номер заявки",
  "Ref":"реф заявки",
  "BeginDate":"Дата создания заявки с в формате дд.мм.гггг",
  "EndDate":"Дата создания заявки по в формате дд.мм.гггг",
  "Page":"страница",
  "Limit":"лимит на странице"
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<root>
   <apiKey>[ВАШ КЛЮЧ]</apiKey>
   <calledMethod>getRedirectionOrdersList</calledMethod>
   <methodProperties>
      <BeginDate>Дата создания заявки с в формате дд.мм.гггг</BeginDate>
      <EndDate>Дата создания заявки по в формате дд.мм.гггг</EndDate>
      <Limit>лимит на странице</Limit>
      <Number>номер заявки</Number>
      <Page>страница</Page>
      <Ref>реф заявки</Ref>
   </methodProperties>
   <modelName>AdditionalService</modelName>
</root>

Ответ 200

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


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

Параметр Тип данных Описание
OrderRef string[36] Реф заявки
OrderNumber int[36] Номер заявки
DateTime int[36] Дата создания заявки
DocumentNumber int[36] Номер документа, на который создавалась заявка
Note string[36] Причина переадресации
CityRecipient string[36] Город получателя
RecipientAddress string[36] Адрес получателя
CounterpartyRecipient string[36] Контрагент получателя
RecipientName string[36] Контактное лицо
PhoneRecipient string[36] Телефон получателя
PayerType string[36] Метод оплаты
DeliveryCost string[36] Стоимость переадресации (появляется когда создана ЕН на основании)
EstimatedDeliveryDate string[36] Расчетная дата доставки (появляется когда создана ЕН на основании)
ExpressWaybillNumber string[36] Номер ЕН переадресации (появляется когда создана ЕН на основании)
ExpressWaybillStatus string[36] Статус ЕН переадресации (появляется когда создана ЕН на основании) 

{  
  "OrderRef":"fd3b826c-2431-11e7-88d0-005056801329",
  "OrderNumber":"102-00006876",
  "DateTime":"18.04.2017 15:24:37",
  "OrderStatus":"Прийняте",
  "DocumentNumber":"20600000065470",
  "Note":"какая-то причина переадресации",
  "CityRecipient":"Полтава",
  "RecipientAddress":"м. Полтава, вул. Авіаційна, 10, квартира 10",
  "CounterpartyRecipient":"Приватна особа",
  "RecipientName":"Лололо Степан Степанович",
  "PhoneRecipient":"380671234567",
  "PayerType":"Recipient",
  "PaymentMethod":"Cash",
  "DeliveryCost":3425,
  "EstimatedDeliveryDate":"19.04.2017",
  "ExpressWaybillNumber":"59000042661412",
  "ExpressWaybillStatus":"Готується до відправлення"
}

<?xml version="1.0" encoding="UTF-8"?>
<root>
   <CityRecipient>Полтава</CityRecipient>
   <CounterpartyRecipient>Приватна особа</CounterpartyRecipient>
   <DateTime>18.04.2017 15:24:37</DateTime>
   <DeliveryCost>3425</DeliveryCost>
   <DocumentNumber>20600000065470</DocumentNumber>
   <EstimatedDeliveryDate>19.04.2017</EstimatedDeliveryDate>
   <ExpressWaybillNumber>59000042661412</ExpressWaybillNumber>
   <ExpressWaybillStatus>Готується до відправлення</ExpressWaybillStatus>
   <Note>какая-то причина переадресации</Note>
   <OrderNumber>102-00006876</OrderNumber>
   <OrderRef>fd3b826c-2431-11e7-88d0-005056801329</OrderRef>
   <OrderStatus>Прийняте</OrderStatus>
   <PayerType>Recipient</PayerType>
   <PaymentMethod>Cash</PaymentMethod>
   <PhoneRecipient>380671234567</PhoneRecipient>
   <RecipientAddress>м. Полтава, вул. Авіаційна, 10, квартира 10</RecipientAddress>
   <RecipientName>Лололо Степан Степанович</RecipientName>
</root>