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-YYYY
-
departure:
ознака виїзду до дверей відправника (true/false)
-
departureCost:
вартість виїзду. Вказується, якщо необхідно вартість виїзду розподілити на кілька накладних
-
delivery:
ознака доставки до дверей одержувача (true/false)
-
arrivalDate:
дата доставки у форматі DD-MM-YYYYY
- contactSender:
-
senderPhone:
телефон відправника (380XXXXXXXXXXX)
-
rspSender:
ідентифікатор відділення відправника (не потрібен під час передачі apiKey)
-
townSender:
ідентифікатор міста відправника (не потрібен при передачі apiKey)
-
senderAddress:
адреса відправника
- rspRecipient:
- townRecipient:
- recipient:
-
contactRecipient:
ідентифікатор контактної особи одержувача
-
recipientAddress:
адреса одержувача
-
recipientPhone:
телефон одержувача (380XXXXXXXXXXX)
-
declaredCost:
задекларована вартість
- description:
- cargoType:
-
seatsAmount:
кількість місць
-
weight:
вага вантажу (Усіх місць загальна)
-
width:
ширина (максимальна 1го місця)
-
length:
довжина (максимальна 1го місця)
-
height:
висота (максимальна 1го місця)
-
volume:
об'єм вантажу (всіх місць загальний)
- departureCondition:
- deliveryCondition:
- payerType:
- paymentMethod:
-
addServices:
додаткові послуги
service: ідентифікатор додаткової послуги
count кількість додаткових послуг -
additionalInformation:
примітка
-
banDeliveryPhone:
номер телефону, на який буде надіслано код зняття заборони на видачу в разі додавання відповідної послуги (380XXXXXXXXX)
-
isDetailingByUnits:
true (обов'язковий параметр)
приклад запиту
<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