API V1.0 - 6.2. ИЗМЕНЕНИЕ СОЗДАННОЙ НАКЛАДНОЙ НА ГРУЗ
Изменение ранее созданной накладной на груз. Возможно до обработки накладной оператором САТ и до помещения накладной в ведомость передачи груза.
URL-Адрес запроса:
https://api.sat.ua/study/hs/api/v1.0/documents/nng/{format}/update[?apiKey]Параметры запроса:
Текст запроса (доступные поля):
-
ID:
собственный идентификатор накладной. Возвращается после создания
-
ref:
идентификатор созданной накладной на груз, полученный в ответе операции "Создание накладной на груз" (обязательное поле)
-
date:
дата накладной в формате DD-MM-YYYYY
-
departure:
признак выезда к двери отправителя (true/false)
-
departureCost:
стоимость выезда. Указывается, если необходимо стоимость выезда распределить на несколько накладных
-
delivery:
признак доставки до дверей получателя (true/false)
-
arrivalDate:
дата доставки в формате DD-MM-YYYYYY
- contactSender:
-
senderPhone:
телефон отправителя (380XXXXXXXXXXXXX)
-
rspSender:
идентификатор отделения отправителя (не нужен при передаче apiKey)
-
townSender:
идентификатор города отправителя (не нужен при передаче apiKey)
-
senderAddress:
адрес отправителя
- rspRecipient:
- townRecipient:
- recipient:
-
contactRecipient:
идентификатор контактного лица получателя
-
recipientAddress:
адрес получателя
-
recipientPhone:
телефон получателя (380XXXXXXXXXXXXXXX)
-
declaredCost:
задекларированная стоимость
- description:
- cargoType:
-
seatsAmount:
количество мест
-
weight:
вес груза (всех мест общий)
-
width:
ширина (максимальная 1го места)
-
length:
длина (максимальная 1го места)
-
height:
высота (максимальная 1го места)
-
volume:
объем груза (всех мест общий)
- departureCondition:
- deliveryCondition:
- payerType:
- paymentMethod:
-
addServices:
дополнительные услуги
service: идентификатор дополнительной услуги
count количество дополнительных услуг -
additionalInformation::
примечание
-
banDeliveryPhone:
номер телефона, на который будет отправлен код снятия запрета на выдачу в случае добавления соответствующей услуги (380XXXXXXXXXXX)
-
isDetailingByUnits:
истинный (обязательный параметр)
пример запроса
<request>
<item>
<ID>123</ID>
<ref>ee40d084-3b3d-434f-877a-09fee724a5ed</ref>
<rspRecipient>bbf8e4a1-33a7-11dd-a17a-001a4d3b885e</rspRecipient>
<weight>1</weight>
<cargoType>Стандарт</cargoType>
<seatsAmount>4</seatsAmount>
<payerType>Получатель</payerType>
<paymentMethod>NonCash</paymentMethod>
<description>106c69c5-fe17-4107-a211-ba9f0032e2c5</description>
<recipient>f99c20ea-182e-11e2-89e8-0017a4770440</recipient>
<addServices>
<service>4293056e-4cb1-406d-a2cd-e8f6d2ae6721</service>
<count>2</count>
</addServices>
<addServices>
<service>4fdbcdc1-72ed-4e7b-bd69-6a8cd19ee00b</service>
<count>2</count>
</addServices>
</item>
</request>
Ответ 200
Список контактных лиц получателей
-
ID:
свой идентификатор набора параметров, переданный в запросе
-
ref:
идентификатор созданной накладной
-
number:
номер созданной накладной
-
cost:
рассчитанная стоимость перевозки
-
barcode:
массив штрихкодов, по количеству мест (поле seatsAmount)
-
addServices:
массив дополнительных услуг
service идентификатор дополнительной услуги
cost стоимость дополнительной услуги
пример ответа
<response>
<success>true</success>
<data>
<item>
<ID>123</ID>
<ref>ee40d084-3b3d-434f-877a-09fee724a5ed</ref>
<number>009000359</number>
<cost>69</cost>
<barcode>00901385514020</barcode>
<barcode>00901385515020</barcode>
<barcode>00901385516020</barcode>
<barcode>00901385517020</barcode>
<barcode>00901385518020</barcode>
<addServices>
<service>4293056e-4cb1-406d-a2cd-e8f6d2ae6721</service>
<cost>50</cost>
</addServices>
<addServices>
<service>4fdbcdc1-72ed-4e7b-bd69-6a8cd19ee00b</service>
<cost>6</cost>
</addServices>
</item>
</data>
</response>
интерфейсы API