API Услуга переадресация отправления
Возможность самостоятельного оформления Клиентом услуги «Переадресация» при использовании API.
Услуга доступна для клиентов отправителей и получателей.
- Проверка возможности создания заявки на переадресацию отправления
- Создание заявки переадресация отправления (отделение/адрес)
- Удаление заявки
- Получение списка заявок
2. Создание заявки переадресация отправления (отделение/адрес)
Метод «save», работает в модели «AdditionalServiceGeneral», этот метод позволяет создать заявку переадресации отправления на отделение или на адрес.
Метод доступен только для клиентов отправителей.
URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами). Например: https://api.novaposhta.ua/v2.0/json/
Доступность: Требует использования API-ключа.
URL-адрес запроса
Параметры запроса
string
Форматы JSON, XML
Заголовки запросов
(дополнительный)
string
Тип формата текста, отправляемого в API.
Текст запроса
Параметр | Тип данных | Описание |
---|---|---|
apiKey* | string[36] | Ваш ключ API 2.0 |
modelName* | string | Имя модели |
calledMetdod* | string | Имя вызываемого метода |
metdodProperties* | Свойства метода | |
OrderType* | string[36] | Константа orderRedirecting |
IntDocNumber* | int[36] | Номер документа, на который нужно оформить переадресацию |
Customer* | string[36] | Заказчик переадресации (получателю запрещено менять данные получателя) |
ServiceType* | string[36] | Тип услуги (DoorsWarehouse или WarehouseWarehouse) |
RecipientSettlement* | string[36] | Идентификатор населенного пункта (При условии создания заявления переадресации на адрес) |
RecipientSettlementStreet* | string[36] | Идентификатор улицы населенного пункта (При условии создания заявления переадресации на адрес) |
BuildingNumber* | string[36] | номер дома (При условии создания заявления переадресации на адрес) |
NoteAddressRecipient* | string[45] | Комментарий к адресу (При условии создания заявления переадресации на адрес) |
RecipientWarehouse* | string[36] | Идентификатор отделения получателя (куда нужно переадресовать груз) |
Recipient* | string[36] | Идентификатор интернет контрагента получателя (если заказывает получателя – игнорируется) |
RecipientContactName* | string[36] | ФИО контактного лица (если заказывает получателя – игнорируется) |
RecipientPhone* | string[36] | Телефон получателя (если заказывает получателя – игнорируется) |
PayerType* | string[36] | Плательщик |
PaymentMethod* | string[36] | Метод оплаты |
Note* | string[36] | Причина переадресации |
* Обозначение обязательного параметра
//Создание заявки переадресация (на отделение)
{
"apiKey":"[ВАШ КЛЮЧ]",
"modelName":"AdditionalServiceGeneral",
"calledMethod":"save",
"methodProperties":{
"OrderType":"orderRedirecting",
"IntDocNumber":"",
"Customer":"Sender",
"ServiceType":"DoorsWarehouse",
"RecipientWarehouse":"67b2f507-1cb5-11e1-bdca-0024e83b596e",
"Recipient":"7c9e1f7a-33cb-11e6-bbb6-005056886752",
"RecipientContactName":"Лололо Степан Степанович",
"RecipientPhone":"380671234567",
"PayerType":"Recipient",
"PaymentMethod":"Cash",
"Note":"какая-то причина переадресации"
}
}
//Создание заявки переадресация (на адрес)
{
"apiKey":"[ВАШ КЛЮЧ]",
"modelName":"AdditionalServiceGeneral",
"calledMethod":"save",
"methodProperties":{
"OrderType":"orderRedirecting",
"IntDocNumber":"",
"Customer":"Recipient",
"ServiceType":"DoorsDoors",
"RecipientSettlement":"e718a680-4b33-11e4-ab6d-005056801329",
"RecipientSettlementStreet":"0000a6ca-684e-11e6-8304-00505688561d",
"BuildingNumber":"4",
"NoteAddressRecipient":"",
"Recipient":"0c38cdbe-84b9-11e6-af9a-005056886752",
"RecipientContactName":"Лололо Степан Степанович",
"RecipientPhone":"380671234567",
"PayerType":"Recipient",
"PaymentMethod":"Cash",
"Note":"какая-то причина переадресации"
}
}
//Создание заявки переадресация (на отделение)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<calledMethod>save</calledMethod>
<methodProperties>
<Customer>Sender</Customer>
<IntDocNumber />
<Note>какая-то причина переадресации</Note>
<OrderType>orderRedirecting</OrderType>
<PayerType>Recipient</PayerType>
<PaymentMethod>Cash</PaymentMethod>
<Recipient>7c9e1f7a-33cb-11e6-bbb6-005056886752</Recipient>
<RecipientContactName>Лололо Степан Степанович</RecipientContactName>
<RecipientPhone>380671234567</RecipientPhone>
<RecipientWarehouse>67b2f507-1cb5-11e1-bdca-0024e83b596e</RecipientWarehouse>
<ServiceType>DoorsWarehouse</ServiceType>
</methodProperties>
<modelName>AdditionalServiceGeneral</modelName>
</root>
//Создание заявки переадресация (на адрес)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<calledMethod>save</calledMethod>
<methodProperties>
<BuildingNumber>4</BuildingNumber>
<Customer>Recipient</Customer>
<IntDocNumber />
<Note>какая-то причина переадресации</Note>
<NoteAddressRecipient />
<OrderType>orderRedirecting</OrderType>
<PayerType>Recipient</PayerType>
<PaymentMethod>Cash</PaymentMethod>
<Recipient>0c38cdbe-84b9-11e6-af9a-005056886752</Recipient>
<RecipientContactName>Лололо Степан Степанович</RecipientContactName>
<RecipientPhone>380671234567</RecipientPhone>
<RecipientSettlement>e718a680-4b33-11e4-ab6d-005056801329</RecipientSettlement>
<RecipientSettlementStreet>0000a6ca-684e-11e6-8304-00505688561d</RecipientSettlementStreet>
<ServiceType>DoorsDoors</ServiceType>
</methodProperties>
<modelName>AdditionalServiceGeneral</modelName>
</root>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
---|---|---|
Number | string[36] | Номер заявки |
Ref | string[36] | Идентификатор заявки |
{
"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>
<element>
<Number>102-00006096</Number>
<Ref>53ccabcb-08c7-11e7-af9a-005056886752</Ref>
</element>
</data>
<errorCodes />
<errors />
<info />
<infoCodes />
<messageCodes />
<success>true</success>
<warningCodes />
<warnings />
</root>