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. Формирование запроса на создание «ЭН» с услугой «Забрать доверенность»
    "IsTakeAttorney": "1", - забор доверенности "1" - ДА "0" – НЕТ
    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную дополнительную услугу «Забор доверенности»
  2. Формирование запроса на создание «ЭН» с услугой «Субботняя доставка»
    "SaturdayDelivery ": "1", - суботня доставка "1" - ДА "0" – НЕТ
    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную дополнительную услугу «Субботняя доставка»
  3. Формирование запроса на создание «ЭН» с услугой «Контроль оплаты»
    "AfterpaymentOnGoodsCost": "1005",
    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную дополнительную услугу «Контроль оплаты»
  4. Формирование запроса на создание «ЭН» с услугой «Локал Експрес»
    "LocalExpress": "1",
    "TimeInterval": "CityDeliveryTimeInterval2", - доступные интервалы 2, 3, 4. Если это значение пустое, API проставит пометку "Впродовж дня"
    Детальней о временных интервала можно ознакомиться по ссылке.
    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную дополнительную услугу «Локал Експрес». Услуга доступна только в пределах доставки в одном городе.
  5. Формирование запроса на создание «ЭН» с услугой «Желаемая дата доставки»
    "PreferredDeliveryDate": "07.03.2015",
    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную дополнительную услугу «Желаемая дата доставки»
  6. Формирование запроса на создание «ЭН» с услугой «Доставка во временные интервалы»
    "PreferredDeliveryDate": "25.03.2015",
    "TimeInterval": "CityDeliveryTimeInterval1/2/3/4",

    Услуга «Доставка во временные интервалы» возможна только при заказе услуги «Желаемая дата доставки» Как загрузить список видов временных интервалов можно увидеть в «Виды временных интервалов»
    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную дополнительную услугу «Желаемая дата доставки»
  7. Формирование запроса на создание «ЭН» с услугой «Указать номера упаковки»
    "PackingNumber": "4545", - "4545" номера упаковки
    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную дополнительную услугу «Указать номера упаковки»
  8. Формирование запроса на создание «ЭН» с услугой «Указать внутренний номер заказа клиента»
    "InfoRegClientBarcodes": "121212", - "121212" внутренний номер
    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную дополнительную услугу «Указать внутренний номер заказа клиента»
  9. Формирование запроса на создание «ЭН» с описанием «Сопровождающие документы»
    "AccompanyingDocuments" : "Договор";
    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную дополнительную услугу «Сопровождающие документы»
  10. Формирование запроса на создание «ЭН» с описанием «Дополнительная информация об отправке»
    "AdditionalInformation" : "Смартфон";
    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную дополнительную услугу «Дополнительная информация об отправке»
  11. Формирование запроса на создание «ЭН» с услугой «Подъем на этаж »
    "NumberOfFloorsLifting": "3", 3 - номер этажа
    "Elevator": "1", 1 - лифт есть, 0 - лифта нет.

    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете.
  12. Формирование запроса на создание «ЭН» с дополнительной услугой «Доставка лично в руки»
    "DeliveryByHand": "1", - "1" - ДА "0" – НЕТ
    "DeliveryByHandRecipients": [ - перечень получателей которым можно отдавать отправления
    "Могилевська Юлія Костянтинівна",
    "Колесник Костянтин Олександрович"
    ],

    При заказе услуги можно загружать до 15 человек включительно. При этом первое лицо всегда - получатель (подтягивается с «Данные получателя»), остальные 14 (Четырнадцать) - произвольные получатели.
  13. Формирование запроса на создание ЕН с заказом услуги «Экспресс паллета»
    "CargoType": "Pallet", - тип груза (паллета)
    "OptionsSeat": [ - Параметр груза для каждого места отправления
    {
    "volumetricVolume": "10", - Объем одного места отправления
    "volumetricWidth": "10", - Ширина одного места отправления
    "volumetricLength": "10", - Длина одного места отправления
    "volumetricHeight": "10", - Высота одного места отправления
    "weight": "10" - Фактический вес
    }
    ],
    "ExpressPallet": "1", - 1 заказать, 0 не заказывать

    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете. Открыв документ видим указанную дополнительную услугу «Экспресс паллета».
  14. Формирование запроса на создание «ЭН» с услугой «Контроль поштучної передачі» (експедирування)
    "ForwardingCount":"126" 126 - количество штук
    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете.
  15. Формирование запроса на создание «ЭН» с услугой «Red Box»
    "RedBoxBarcode":"0105QD26L"
    0105QD26L - код учитывает только верхний регист
    После создания интернет документа в программной среде API, ЕН появляется в списке ЕН в личном кабинете.

    Приведенный пример из запроса - Формирование запроса на создание «ЭН» с услугой «забрать доверенность»


{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "InternetDocument",
"calledMethod": "save",
"methodProperties": {
"IsTakeAttorney": "1",
"PayerType": "Sender",
"PaymentMethod": "Cash",
"DateTime": "18.02.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>
<IsTakeAttorney>1</IsTakeAttorney>
<PayerType>Sender</PayerType>
<PaymentMethod>Cash</PaymentMethod>
<DateTime>02.04.2015</DateTime>
<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>5953fb16-08d8-11e4-8958-0025909b4e33</Sender>
<SenderAddress>01ae2635-e1c2-11e3-8c4a-0050568002cf</SenderAddress>
<ContactSender>344a7107-ccac-11e4-bdb5-005056801329</ContactSender>
<SendersPhone>380678734567</SendersPhone>
<CityRecipient>8d5a980d-391c-11dd-90d9-001a92567626</CityRecipient>
<Recipient>56300fb9-cbd3-11e4-bdb5-005056801329</Recipient>
<RecipientAddress>511fcfbd-e1c2-11e3-8c4a-0050568002cf</RecipientAddress>
<ContactRecipient>563ad2d8-cbd3-11e4-bdb5-005056801329</ContactRecipient>
<RecipientsPhone>380631112223</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": "55babc0d-c279-11e4-bdb5-005056801329",
"CostOnSite": 55,
"EstimatedDeliveryDate": "19.02.2015",
"IntDocNumber": "20600000002368",
"TypeDocument": "InternetDocument"
}
],
"errors": [],
"warnings": [],
"info": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Ref>112f9765-d913-11e4-bdb5-005056801329</Ref>
<CostOnSite>22</CostOnSite>
<EstimatedDeliveryDate>03.04.2015</EstimatedDeliveryDate>
<IntDocNumber>20400030201056</IntDocNumber>
<TypeDocument>InternetDocument</TypeDocument>
</item>
</data>
<errors></errors>
<warnings></warnings>
<info></info>
</root>