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

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

Редактировать экспресс-накладную

Метод «update», работает в модели «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 Свойства метода
Ref * string[36] Идентификатор экспресс-накладной
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] Целое число, объявленная стоимость (если объявленная стоимость не указана, API автоматически подставит минимальную объявленную цену - 300.00
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
* Обозначение обязательного параметра 

{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "InternetDocument",
"calledMethod": "update",
"methodProperties": {
"Ref": "06188e5f-1dc2-11e6-a70c-005056801333",
"PayerType": "Sender",
"PaymentMethod": "Cash",
"DateTime": "21.05.2016",
"CargoType": "Cargo",
"VolumeGeneral": "10",
"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": "0937640250",
"CityRecipient": "8d5a980d-391c-11dd-90d9-001a92567626",
"Recipient": "39245c46-7653-11e5-ad08-005056801333",
"RecipientAddress":
"17421ce1-dad9-11e5-a70c-005056801333",
"ContactRecipient":
"3931e80d-7653-11e5-ad08-005056801333",
"RecipientsPhone": "0663456655"
}
}

<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>InternetDocument</modelName>
<calledMethod>update</calledMethod>
<methodProperties>
<Ref>06188e5f-1dc2-11e6-a70c-005056801333</Ref>
<PayerType>Sender</PayerType>
<PaymentMethod>Cash</PaymentMethod>
<DateTime>21.05.2016</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>5ace4a2e-13ee-11e5-add9-005056887b8d</Sender>
<SenderAddress>d492290b-55f2-11e5-ad08-005056801333</SenderAddress>
<ContactSender>613b77c4-1411-11e5-ad08-005056801333</ContactSender>
<SendersPhone>380678734567</SendersPhone>
<CityRecipient>8d5a980d-391c-11dd-90d9-001a92567626</CityRecipient>
<Recipient>39245c46-7653-11e5-ad08-005056801333</Recipient>
<RecipientAddress>17421ce1-dad9-11e5-a70c-005056801333</RecipientAddress>
<ContactRecipient>3931e80d-7653-11e5-ad08-005056801333</ContactRecipient>
<RecipientsPhone>380631112223</RecipientsPhone>
</methodProperties>
</root>

Ответ 200

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


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

Параметр Тип данных Описание
Ref string[36] Идентификатор экспресс-накладной
CostOnSite string[36] Оценочная стоимость
EstimatedDeliveryDate string[36] Ориентировочная дата доставки
IntDocNumber string[36] Номер ЭН
TypeDocument string[36] Тип документа 

{  
   "success":true,
   "data":[  
      {  
         "Ref":"06188e5f-1dc2-11e6-a70c-005056801333",
         "CostOnSite":3278,
         "EstimatedDeliveryDate":"23.05.2016",
         "IntDocNumber":"20400010787555",
         "TypeDocument":"InternetDocument"
      }
   ],
   "errors":[  

   ],
   "warnings":[  

   ],
   "info":[  

   ]
}
<root>
	<success>true</success>
	<data>
		<item>
			<Ref>06188e5f-1dc2-11e6-a70c-005056801333</Ref>
			<CostOnSite>93</CostOnSite>
			<EstimatedDeliveryDate>23.05.2016</EstimatedDeliveryDate>
			<IntDocNumber>20400010787555</IntDocNumber>
			<TypeDocument>InternetDocument</TypeDocument>
		</item>
	</data>
	<errors />
	<warnings />
	<info />
</root>