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

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

Создание экспресс-накладной на адрес (указание адреса строкой)

Метод «save», работает в модели «InternetDocument», этот метод позволяет создавать/формировать экспресс-накладную (интернет-документа) на АДРЕС.

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 string Свойства метода
NewAddress* string[36] Использование нового адресного справочника. 1 - ДА, 0 - НЕТ
PayerType* string[36] Значение из справочника Тип плательщика
PaymentMethod* 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] Целое число, объявленная стоимость (если объявленная стоимость не указана, API автоматически подставит минимальную объявленную цену - 300.00
CitySender* string[36] Идентификатор города отправителя
Sender* string[36] Идентификатор отправителя
SenderAddress* string[36] Идентификатор адреса отправителя
ContactSender* string[36] Идентификатор контактного лица отправителя
SendersPhone* int[36] Телефон отправителя в формате: +380660000000, 380660000000, 0660000000
RecipientCityName* string[36] Идентификатор города получателя (УКАЗЫВАЕТЬСЯ СТРОКОЙ)
RecipientArea* string[36] Идентификатор области (УКАЗЫВАЕТЬСЯ СТРОКОЙ)
RecipientAreaRegions* string[36] Идентификатор района(УКАЗЫВАЕТЬСЯ СТРОКОЙ)
RecipientAddressName* string[36] Идентификатор улицы (УКАЗЫВАЕТЬСЯ СТРОКОЙ)
RecipientHouse* string[36] Идентификатор номера дома (УКАЗЫВАЕТЬСЯ СТРОКОЙ)
RecipientFlat* string[36] Идентификатор этажа (УКАЗЫВАЕТЬСЯ СТРОКОЙ)
RecipientName* string[36] Идентификатор ФИО получателя (УКАЗЫВАЕТЬСЯ СТРОКОЙ)
RecipientType* string[36] Идентификатор получателя
RecipientsPhone* string[36] Телефон получателя
DateTime* string[36] Дата отправки в формате дд.мм.гггг
SettlementType string[36] Тип населенного пункта (значение для параметра есть у каждого населенного пункта предоставляемого через метод «getSettlements» в свойстве «SettlementTypeDescription»)
* Обозначение обязательного параметра

{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "InternetDocument",
"calledMethod": "save",
"methodProperties": {
"NewAddress": "1",
"PayerType": "Sender",
"PaymentMethod": "Cash",
"CargoType": "Cargo",
"VolumeGeneral": "0.1",
"Weight": "10",
"ServiceType": "WarehouseDoors",
"SeatsAmount": "1",
"Description": "абажур",
"Cost": "500",
"CitySender": "8d5a980d-391c-11dd-90d9-001a92567626",
"Sender": "5ace4a2e-13ee-11e5-add9-005056887b8d",
"SenderAddress": "d492290b-55f2-11e5-ad08-005056801333",
"ContactSender": "613b77c4-1411-11e5-ad08-005056801333",
"SendersPhone": "380991234567",
"RecipientCityName": "київ",
"RecipientArea": "",
"RecipientAreaRegions": "",
"RecipientAddressName": "Столичне шосе",
"RecipientHouse": "20",
"RecipientFlat": "37",
"RecipientName": "Тест Тест Тест",
"RecipientType": "PrivatePerson",
"RecipientsPhone": "380991234567",
"DateTime": "25.09.2016"
}
}
<?xml version="1.0" encoding="UTF-8" ?>
<root>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>InternetDocument</modelName>
<calledMethod>save</calledMethod>
<methodProperties>
<NewAddress>1</NewAddress>
<PayerType>Sender</PayerType>
<PaymentMethod>Cash</PaymentMethod>
<CargoType>Cargo</CargoType>
<VolumeGeneral>0.1</VolumeGeneral>
<Weight>10</Weight>
<ServiceType>WarehouseDoors</ServiceType>
<SeatsAmount>1</SeatsAmount>
<Description>абажур</Description>
<Cost>500</Cost>
<CitySender>8d5a980d-391c-11dd-90d9-001a92567626</CitySender>
<Sender>5ace4a2e-13ee-11e5-add9-005056887b8d</Sender>
<SenderAddress>d492290b-55f2-11e5-ad08-005056801333</SenderAddress>
<ContactSender>613b77c4-1411-11e5-ad08-005056801333</ContactSender>
<SendersPhone>380991234567</SendersPhone>
<RecipientCityName>київ</RecipientCityName>
<RecipientArea></RecipientArea>
<RecipientAreaRegions></RecipientAreaRegions>
<RecipientAddressName>Столичне шосе</RecipientAddressName>
<RecipientHouse>20</RecipientHouse>
<RecipientFlat>37</RecipientFlat>
<RecipientName>Тест Тест Тест</RecipientName>
<RecipientType>PrivatePerson</RecipientType>
<RecipientsPhone>380991234567</RecipientsPhone>
<DateTime>23.09.2016</DateTime>
</methodProperties>
</root>

Ответ 200

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


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

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

{
    "success": true,
    "data": [
        {
            "Ref": "cccdd310-770d-11e5-ad08-005056801333",
            "CostOnSite": 93,
            "EstimatedDeliveryDate": "27.09.2016",
            "IntDocNumber": "20400002696147",
            "TypeDocument": "InternetDocument"
        }
    ],
    "errors": [],
    "warnings": [],
    "info": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
   <success>true</success>
   <data>
      <item>
         <Ref>ed3bd19c-770d-11e5-ad08-005056801333</Ref>
         <CostOnSite>93</CostOnSite>
         <EstimatedDeliveryDate>24.09.2016</EstimatedDeliveryDate>
         <IntDocNumber>20400002696192</IntDocNumber>
         <TypeDocument>InternetDocument</TypeDocument>
      </item>
   </data>
   <errors />
   <warnings />
   <info />
</root>