API Экспресс-накладная
Работа с экспресс-накладными
- Рассчитать стоимость услуг
- Прогноз даты доставки груза
- Создать экспресс-накладную
- Создать экспресс-накладную на адрес
- Создать экспресс-накладную на отделение
- Создать экспресс-накладную на почтомат "Нова пошта"
- Создать экспресс-накладную с обратной доставкой
- Редактировать экспресс-накладную
- Трекинг
- Получить список ЭН
- Удалить экспресс-накладную
- Формирование запроса для получения полного отчета по накладным
- Формирование запросов на создание ЭН с дополнительными услугами
- Формирование запросов на создание ЭН с различными видами груза
Создать экспресс-накладную
Метод «save», работает в модели «InternetDocument», этот метод позволяет создавать/формировать экспресс-накладную (интернет-документа).
При выборе типа доставки "CargoType": "Documents",
доступны следующие параметры веса: 0,1 или 0,5 или 1. Во всех остальных случаях будет возращена ошибка.
В данном запросе возможно указание обратной доставки. Достаточно указать параметр метода BackwardDeliveryData
Более детально просмотреть всевозможные варианты обратной доставки можно в разделе Создать экспресс-накладную с обратной доставкой
Возможен вариант создания экспресс-накладной с оплатой от "Третьего лица", в таком случае необходимо заменить параметр PayerType на:
"PayerType": "ThirdPerson",
Форма оплаты может быть только "Безналичный расчет"
"ThirdPerson": "5953fb16-08d8-11e4-8958-0025909b4e33",
URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/
Доступность: Требует использования API-ключа.
URL-адрес запроса
Параметры запроса
Форматы JSON, XML
Заголовки запросов
Текст запроса
Основные параметры
Параметр | Тип данных | Описание |
---|---|---|
apiKey* | string[36] | Ваш ключ API 2.0 |
modelName* | string | Имя модели |
calledMethod* | string | Имя вызываемого метода |
methodProperties | string | Свойства метода |
PayerType* | string[36] | значение из справочника Тип плательщика |
PaymentMethod* | string[36] | Значение из справочника Форма оплаты |
DateTime* | string[36] | Дата отправки в формате дд.мм.гггг |
CargoType* | string[36] | Значение из справочника Тип груза |
VolumeGeneral | int[36] | Объем общий, м.куб (min - 0.0004), обязательно для заполнения, если не указаны значения OptionsSeat |
Weight* | int[36] | min - 0,1 Вес фактический, кго |
ServiceType* | string[36] | Значение из справочника Технология доставки |
SeatsAmount* | string[36] | Целое число, количество мест отправления |
Description* | string[50] | Текстовое поле, вводиться для доп. описания |
Cost* | int[36] | Целое число, объявленная стоимость |
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 |
RedBoxBarcode | Номер шрихкода RedBox (Верхний регистр обязателен) |
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "InternetDocument",
"calledMethod": "save",
"methodProperties": {
"PayerType": "Sender",
"PaymentMethod": "Cash",
"DateTime": "02.03.2015",
"CargoType": "Cargo",
"VolumeGeneral": "0.1",
"Weight": "10",
"ServiceType": "WarehouseDoors",
"SeatsAmount": "1",
"Description": "абажур",
"Cost": "500",
"CitySender": "8d5a980d-391c-11dd-90d9-001a92567626",
"Sender": "6e9acced-d072-11e3-95eb-0050568046cd",
"SenderAddress": "01ae2635-e1c2-11e3-8c4a-0050568002cf",
"ContactSender": "d0b9f592-b600-11e4-a77a-005056887b8d",
"SendersPhone": "380678734567",
"CityRecipient": "db5c8892-391c-11dd-90d9-001a92567626",
"Recipient": "d00f2319-b743-11e4-a77a-005056887b8d",
"RecipientAddress": "511fcfbd-e1c2-11e3-8c4a-0050568002cf",
"ContactRecipient": "bc7b61ea-b6eb-11e4-a77a-005056887b8d",
"RecipientsPhone": "380631112223"
}
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>InternetDocument</modelName>
<calledMethod>save</calledMethod>
<methodProperties>
<BackwardDeliveryData>
<item>
<CargoType>Money</CargoType>
<PayerType>Sender или Recipient</PayerType>
<RedeliveryString>4552</RedeliveryString>
</item>
</BackwardDeliveryData>
<CargoType>Cargo</CargoType>
<Cost>500</Cost>
<DateTime>07.04.2015</DateTime>
<Description>абажур</Description>
<PayerType>Sender</PayerType>
<PaymentMethod>Cash</PaymentMethod>
<ServiceType>WarehouseDoors</ServiceType>
<VolumeGeneral>0.1</VolumeGeneral>
<Weight>50</Weight>
<SeatsAmount>1</SeatsAmount>
<CitySender>8d5a980d-391c-11dd-90d9-001a92567626</CitySender>
<Sender>5953fb16-08d8-11e4-8958-0025909b4e33</Sender>
<SenderAddress>0d545ecf-e1c2-11e3-8c4a-0050568002cf</SenderAddress>
<ContactSender>9b9d5f71-6e3c-11e4-ab6d-005056801329</ContactSender>
<SendersPhone>380971155109</SendersPhone>
<CityRecipient>8d5a980d-391c-11dd-90d9-001a92567626</CityRecipient>
<Recipient>b9188002-c0c8-11e4-bdb5-005056801329</Recipient>
<RecipientAddress>1ec09d88-e1c2-11e3-8c4a-0050568002cf</RecipientAddress>
<ContactRecipient>0fdfcde9-c0c9-11e4-bdb5-005056801329</ContactRecipient>
<RecipientsPhone>380997579789</RecipientsPhone>
</methodProperties>
</root>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
---|---|---|
Ref | string[36] | Идентификатор экспресс-накладной |
CostOnSite | int[36] | Стоимость доставки |
EstimatedDeliveryDate | string[36] | Прогноз даты доставки |
IntDocNumber | int[36] | Номер экспресс-накладной |
TypeDocument | string[36] | Тип экспресс-накладной |
{
"success": true,
"data": [
{
"Ref": "f6abf2bb-7bc6-11e4-acce-0050568002cf",
"CostOnSite": 90,
"EstimatedDeliveryDate": "03.03.2015",
"IntDocNumber": "20600000002545",
"TypeDocument": "InternetDocument"
}
],
"errors": [],
"warnings": [],
"info": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root><success>true</success>
<data>
<item>
<Ref>37b36069-da0c-11e5-a70c-005056801333</Ref>
<CostOnSite>93</CostOnSite>
<EstimatedDeliveryDate>24.02.2016</EstimatedDeliveryDate>
<IntDocNumber>20600000057217</IntDocNumber>
<TypeDocument>InternetDocument</TypeDocument>
<RegionCode>П13</RegionCode>
RegionCity>Полтава</RegionCity>
</item>
</data>
<errors/>
<warnings/>
<info/>
</root>