API Экспресс-накладная

Работа с экспресс-накладными

Создать экспресс-накладную на почтомат "Приват Банк"

Метод «save», работает в модели «InternetDocument», этот метод позволяет создавать/формировать экспресс-накладную (интернет-документа) на почтомат "Приват Банк".
При создании ЕН на отделение почтомат обязательно указываются параметры габаритов.
Ограничения:
Почтомат может быть только отделением получателя;
Отправлять на почтомат можно только груз (Cargo) и документы (Document);
Максимальные габариты 37х35х61 см ;
Максимальный вес 30 кг;
При создании отправления на почтомат, можно указывать только одно место на одно отправление.

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   Свойства метода
Sender* string[36] Код отправителя
Cash string[36] тип оплаты
DateTime* string[36] Фактическая дата отправки
CargoType* string[36] Тип груза
OptionsSeat string[36] Параметр груза для каждого места отправления
volumetricVolume string[36] Объем одного места отправления
olumetricWidth string[36] Ширина одного места отправления
volumetricLength string[36] Длина одного места отправления
volumetricHeight string[36] Высота одного места отправления
weight string[36] Фактический вес
ServiceType* string[36] Значение из справочника Технология доставки
SeatsAmount* string[36] Количество мест отправления
Description* string[50] Текстовое поле, вводиться для доп. описания
Cost* int[36] Целое число, объявленная стоимость (если объявленная стоимость не указана, API автоматически подставит минимальную объявленную цену - 300.00
CitySender string[36] Код города отправителя
Sender string[36] Идентификатор отправителя
SenderAddress* string[36] Код адреса отправителя
ContactSender* string[36] Код контактного лица отправителя
SendersPhone* int[36] Телефон отправителя в формате: +380660000000, 380660000000, 0660000000
CityRecipient* string[36] код города получателя
Recipient* string[36] Код получателя
RecipientAddress string[36] Идентификатор почтомата
ContactRecipient* string[36] Код контактного лица получателя
RecipientsPhone* int[36] телефон получателя в формате: +380660000000, 80660000000, 0660000000
* Обозначение обязательного параметра

{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "InternetDocument",
"calledMethod": "save",
"methodProperties": {
"PayerType": "Sender",
"PaymentMethod": "Cash",
"DateTime": "10.12.2016",
"CargoType": "Cargo",
"OptionsSeat": [
{
"volumetricVolume": "1",
"volumetricWidth": "30",
"volumetricLength": "30",
"volumetricHeight": "30",
"weight": "28"
}
],
"ServiceType": "WarehouseWarehouse",
"SeatsAmount": "1",
"Description": "одяг",
"Cost": "500",
"CitySender": "8d5a980d-391c-11dd-90d9-001a92567626",
"Sender": "5ace4a2e-13ee-11e5-add9-005056887b8d",
"SenderAddress": "31866ddc-0097-11e6-a70c-005056801333",
"ContactSender": "613b77c4-1411-11e5-ad08-005056801333",
"SendersPhone": "380677777788",
"CityRecipient": "8d5a980d-391c-11dd-90d9-001a92567626",
"Recipient": "768da332-159d-11e5-ad08-005056801333",
"RecipientAddress": "e77f2c07-60f6-11e4-acce-0050568002cf",
"ContactRecipient": "e5ac6c51-deef-11e5-a70c-005056801333",
"RecipientsPhone": "380997979789"
}
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>InternetDocument</modelName>
<calledMethod>save</calledMethod>
<methodProperties>
<PayerType>Sender</PayerType>
<PaymentMethod>Cash</PaymentMethod>
<DateTime>23.12.2016</DateTime>
<CargoType>Cargo</CargoType>
<OptionsSeat>
<item>
<volumetricVolume>1</volumetricVolume>
<volumetricWidth>30</volumetricWidth>
<volumetricLength>30</volumetricLength>
<volumetricHeight>30</volumetricHeight>
<weight>28</weight>
</item>
</OptionsSeat>
<ServiceType>WarehouseWarehouse</ServiceType>
<SeatsAmount>1</SeatsAmount>
<Description>одяг</Description>
<Cost>500</Cost>
<CitySender>8d5a980d-391c-11dd-90d9-001a92567626</CitySender>
<Sender>5ace4a2e-13ee-11e5-add9-005056887b8d</Sender>
<SenderAddress>31866ddc-0097-11e6-a70c-005056801333</SenderAddress>
<ContactSender>613b77c4-1411-11e5-ad08-005056801333</ContactSender>
<SendersPhone>380677777788</SendersPhone>
<CityRecipient>8d5a980d-391c-11dd-90d9-001a92567626</CityRecipient>
<Recipient>768da332-159d-11e5-ad08-005056801333</Recipient>
<RecipientAddress>e77f2c07-60f6-11e4-acce-0050568002cf</RecipientAddress>
<ContactRecipient>e5ac6c51-deef-11e5-a70c-005056801333</ContactRecipient>
<RecipientsPhone>380997979789</RecipientsPhone>
</methodProperties>
</root>

Ответ 200

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


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

Параметр Тип данных Описание
Ref string[36] Идентификатор экспресс-накладной
CostOnSite int[36] Стоимость
EstimatedDeliveryDate string[36] Прогноз даты доставки/td>
IntDocNumber int[36] Номер экспресс-накладной
TypeDocument string[36] Тип экспресс-накладной
RegionCode string[36]
RegionCity string[36]

{
"success": true,
"data": [
{
"Ref": "f84f0a9d-cfc8-11e5-a70c-005056801333",
"CostOnSite": 88,
"EstimatedDeliveryDate": "11.02.2016",
"IntDocNumber": "20600000055002",
"TypeDocument": "InternetDocument",
"RegionCode": "2с300",
"RegionCity": "Київ"
}
],
"errors": [],
"warnings": [
"VolumeWeight is changed",
"SeatsAmount is changed",
"VolumeGeneral is changed",
"Weight is changed"
],
"info": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Ref>baefb88f-da02-11e5-a70c-005056801333</Ref>
<CostOnSite>88</CostOnSite>
<EstimatedDeliveryDate>24.02.2016</EstimatedDeliveryDate>
<IntDocNumber>20600000057214</IntDocNumber>
<TypeDocument>InternetDocument</TypeDocument>
<RegionCode>2ПБ41</RegionCode>
<RegionCity>Київ</RegionCity>
</item><
/data>
<errors/>
<warnings>
<item>VolumeWeight is changed</item>
<item>SeatsAmount is changed</item>
<item>VolumeGeneral is changed</item>
<item>Weight is changed</item></warnings>
<info/>
</root>