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.

Текст запроса

Типы грузов

  1. Формирование запроса с типом груза «шины-диски»
    "CargoType": "TiresWheels",
    "CargoDetails": [
    {
    "CargoDescription": "20f7b626-9add-11e3-b441-0050568002cf",
    "Amount": "4"
    } ],

    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ мы видим указанный тип груза «шины-диски» также указаны его параметры и количество.

    2) Формирование запроса с типом груза «пеллеты или груз» с указанием параметров каждого места
    "CargoType": "Pallet",
    "OptionsSeat": [
    {
    "volumetricVolume": "10",
    "volumetricWidth": "10",
    "volumetricLength": "10",
    "volumetricHeight": "10",
    "weight": "10"
    },
    {
    "volumetricVolume": "10",
    "volumetricWidth": "10",
    "volumetricLength": "10",
    "volumetricHeight": "10",
    "weight": "10"
    } ],

    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ мы видим указанный тип груза «пеллеты или груз» также указаны его параметры и количество.

    3) Формирование запроса с типом груза «документы»
    "CargoType": "Documents",
    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ мы видим указанный тип груза «документы» также указаны его параметры и количество.

    Приведенный пример из запроса - Формирование запроса с типом груза «шины-диски»

{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "InternetDocument",
"calledMethod": "save",
"methodProperties": {
"PayerType": "Sender",
"PaymentMethod": "Cash",
"DateTime": "04.03.2015",
"CargoType": "TiresWheels",
"CargoDetails": [
{
"CargoDescription": "20f7b626-9add-11e3-b441-0050568002cf",
"Amount": "4"
}
],
"Weight": "10",
"ServiceType": "WarehouseDoors",
"SeatsAmount": "1",
"Description": "",
"Cost": "2000",
"CitySender": "8d5a980d-391c-11dd-90d9-001a92567626",
"Sender": "5953fb16-08d8-11e4-8958-0025909b4e33",
"SenderAddress": "0d545ecf-e1c2-11e3-8c4a-0050568002cf",
"ContactSender": "9b9d5f71-6e3c-11e4-ab6d-005056801329",
"SendersPhone": "380971155109",
"CityRecipient": "8d5a980d-391c-11dd-90d9-001a92567626",
"Recipient": "b9188002-c0c8-11e4-bdb5-005056801329",
"RecipientAddress": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",
"ContactRecipient": "0fdfcde9-c0c9-11e4-bdb5-005056801329",
"RecipientsPhone": "380997579789"
}
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>InternetDocument</modelName>
<calledMethod>save</calledMethod>
<methodProperties>
<PayerType>Sender</PayerType>
<PaymentMethod>Cash</PaymentMethod>
<DateTime>07.04.2015</DateTime>
<CargoType>TiresWheels</CargoType>
<CargoDetails>
<item>
<CargoDescription>20f7b626-9add-11e3-b441-0050568002cf</CargoDescription>
<Amount>4</Amount>
</item>
</CargoDetails>
<Weight>10</Weight>
<ServiceType>WarehouseDoors</ServiceType>
<SeatsAmount>1</SeatsAmount>
<Description>
</Description>
<Cost>2000</Cost>
<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] Прогноз даты доставки/td>
IntDocNumber int[36] Номер экспресс-накладной
TypeDocument string[36] Тип экспресс-накладной

{
"success": true,
"data": [
{
"Ref": "925aeb95-c24d-11e4-bdb5-005056801329",
"CostOnSite": 190,
"EstimatedDeliveryDate": "05.03.2015",
"IntDocNumber": "20400030200726",
"TypeDocument": "InternetDocument"
}
],
"errors": [],
"warnings": [
"Weight is changed",
"SeatsAmount is changed",
"Description is changed"
],
"info": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Ref>0078e074-dd02-11e4-bdb5-005056801329</Ref>
<CostOnSite>260</CostOnSite>
<EstimatedDeliveryDate>08.04.2015</EstimatedDeliveryDate>
<IntDocNumber>20400030201100</IntDocNumber>
<TypeDocument>InternetDocument</TypeDocument>
</item>
</data>
<errors></errors>
<warnings>
<item>Weight is changed</item>
<item>SeatsAmount is changed</item>
<item>Description is changed</item>
</warnings>
<info></info>
</root>