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

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

Прогноз даты доставки груза

Метод «getDocumentDeliveryDate», работает в модели «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   Свойства метода
DateTime string[36] Дата создание ЕН (не обязательный параметр)
ServiceType* string Значение из справочника Технология доставки
CitySender* string[36] Код города отправителя
CityRecipient* string[36] Код города получателя
* Обозначение обязательного параметра

<?xml version="1.0" encoding="UTF-8"?>
<root>
   <apiKey>[Ваш ключ АРІ]</apiKey>
   <calledMethod>getDocumentDeliveryDate</calledMethod>
   <methodProperties>
      <CityRecipient>8d5a980d-391c-11dd-90d9-001a92567626</CityRecipient>
      <CitySender>8d5a980d-391c-11dd-90d9-001a92567626</CitySender>
      <DateTime>10.11.2016</DateTime>
      <ServiceType>WarehouseDoors</ServiceType>
   </methodProperties>
   <modelName>InternetDocument</modelName>
</root>
 {
 "apiKey": "[Ваш ключ АРІ]",
 "modelName": "InternetDocument",
 "calledMethod": "getDocumentDeliveryDate",
 "methodProperties": {
 "DateTime": "10.11.2016",
 "ServiceType": "WarehouseDoors",
 "CitySender": "8d5a980d-391c-11dd-90d9-001a92567626",
 "CityRecipient": "8d5a980d-391c-11dd-90d9-001a92567626"
 }
}

Ответ 200

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


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

Параметр Тип данных Описание
date string[] Дата доставки

{
  "success": true,
  "data": [
    {
      "DeliveryDate": {
        "date": "2016-11-11 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/Kiev"
      }
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}
<root>
	<success>true</success>
	<data>
		<item>
			<DeliveryDate>
				<date>2016-11-11 00:00:00.000000/date>
				<timezone_type>3</timezone_type>
				<timezone>Europe/Kiev</timezone>
			</DeliveryDate>
		</item>
	</data>
	<errors />
	<warnings />
	<info />
</root>