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

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

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

Метод «checkPossibilityForRedirecting», работает в модели «AdditionalServiceGeneral», этот метод позволяет проверить возможность создания заявки на переадресацию отправления. Метод доступен только для клиентов отправителей.
В случае успеха возвращаются необходимые параметры для создания заявки.

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 Имя модели
calledMetdod* string Имя вызываемого метода
metdodProperties   Свойства метода
Number* int[36] Номер документа для которого будет создавать заявка переадресации

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

Ответ 200

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


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

Параметр Тип данных Описание
Ref string[36] Идентификатор документа
Number int[36] Номер документа
PayerType string[36] Тип плательщика
PaymentMethod string[36] Метод оплаты
WarehouseRef string[36] Идентификатор отделения
WarehouseDescription string[36] Описание отделения
AddressDescription string[36] Текстовое представление адреса (в случае возможности переадресации на адрес)
StreetDescription string[36] Текстовое представление улицы (в случае возможности переадресации на адрес)
BuildingNumber string[36] № дома (в случае возможности переадресации на адрес)
CityRecipient string[36] Идентификатор города получателя
CityRecipientDescription string[36] Название города получателя
SettlementRecipient string[36] Идентификатор населенного пункта получателя
SettlementRecipientDescription string[36] Название населенного пункта получателя
SettlementType string[36] Идентификатор типа населенного пункта получателя
CounterpartyRecipientRef string[36] Идентификатор интернет контрагента получателя
CounterpartyRecipientDescription string[36] Название интернет контрагента получателя
RecipientName string[36] ФИО контактного лица получателя
PhoneSender int[36] Телефон отправителя
PhoneRecipient int[36] Телефон получателя
DocumentWeight int[36] Общий вес документа

{  
  "success":true,
  "data":[  
    {  
      "Ref":"cb7a6cfc-2446-11e7-88d0-005056801329",
      "Number":"20600000065609",
      "PayerType":"Sender",
      "PaymentMethod":"Cash",
      "ServiceType":"DoorsWarehouse",
      "WarehouseRef":"cd492aec-860c-11e0-8140-969cd9edcd68",
      "WarehouseDescription":"Відділення №23 (до 30 кг): просп. М. Бажана, 24/1 (м. Позняки)",
      "CityRecipient":"8d5a980d-391c-11dd-90d9-001a92567626",
      "CityRecipientDescription":"Київ",
      "SettlementRecipient":"e718a680-4b33-11e4-ab6d-005056801329",
      "SettlementRecipientDescription":"Київ",
      "SettlementType":"563ced10-f210-11e3-8c4a-0050568002cf",
      "CounterpartyRecipientRef":"4396fd68-6387-11e5-b119-0025909b4e33",
      "CounterpartyRecipientDescription":"101-10378782",
      "RecipientName":"Тест Тест Тестович",
      "PhoneSender":"380675387254",
      "PhoneRecipient":"380991234567",
      "DocumentWeight":"1.00"
    }
  ],
  "errors":[],
  "warnings":[],
  "info":[],
  "messageCodes":[],
  "errorCodes":[],
  "warningCodes":[],
  "infoCodes":[]
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
   <data>
      <element>
         <CityRecipient>8d5a980d-391c-11dd-90d9-001a92567626</CityRecipient>
         <CityRecipientDescription>Київ</CityRecipientDescription>
         <CounterpartyRecipientDescription>101-10378782</CounterpartyRecipientDescription>
         <CounterpartyRecipientRef>4396fd68-6387-11e5-b119-0025909b4e33</CounterpartyRecipientRef>
         <DocumentWeight>1.00</DocumentWeight>
         <Number>20600000065609</Number>
         <PayerType>Sender</PayerType>
         <PaymentMethod>Cash</PaymentMethod>
         <PhoneRecipient>380991234567</PhoneRecipient>
         <PhoneSender>380675387254</PhoneSender>
         <RecipientName>Тест Тест Тестович</RecipientName>
         <Ref>cb7a6cfc-2446-11e7-88d0-005056801329</Ref>
         <ServiceType>DoorsWarehouse</ServiceType>
         <SettlementRecipient>e718a680-4b33-11e4-ab6d-005056801329</SettlementRecipient>
         <SettlementRecipientDescription>Київ</SettlementRecipientDescription>
         <SettlementType>563ced10-f210-11e3-8c4a-0050568002cf</SettlementType>
         <WarehouseDescription>Відділення №23 (до 30 кг): просп. М. Бажана, 24/1 (м. Позняки)</WarehouseDescription>
         <WarehouseRef>cd492aec-860c-11e0-8140-969cd9edcd68</WarehouseRef>
      </element>
   </data>
   <errorCodes />
   <errors />
   <info />
   <infoCodes />
   <messageCodes />
   <success>true</success>
   <warningCodes />
   <warnings />
</root>