API V1.0 – 6.1 Створення накладної з деталізацією місць
Створення накладних на вантаж за переданими параметрами
URL-Адреса запиту:
https://api.sat.ua/study/hs/api/v1.0/documents/nng/{format}/save[?apiKey]Параметри запиту:
Текст запиту (доступні поля):
-
ID:
власний ідентифікатор накладної. Повертається після створення
-
date:
дата накладної у форматі DD-MM-YYYY
-
departure:
ознака виїзду до дверей відправника (true/false)
-
delivery:
ознака доставки до дверей одержувача (true/false)
-
arrivalDate:
дата доставки у форматі DD-MM-YYYYY
- contactSender:
-
senderPhone:
телефон відправника (380XXXXXXXXXXX)
-
rspSender:
ідентифікатор відділення відправника (не потрібен під час передачі apiKey)
-
townSender:
ідентифікатор міста відправника (не потрібен при передачі apiKey)
-
senderAddress:
адреса відправника
- rspRecipient:
- townRecipient:
- recipient:
-
contactRecipient:
ідентифікатор контактної особи одержувача
-
recipientAddress:
адреса одержувача
-
recipientPhone:
телефон одержувача (380XXXXXXXXXXX)
-
declaredCost:
задекларована вартість
- departureCondition:
- deliveryCondition:
- payerType:
- paymentMethod:
-
addServices:
додаткові послуги
service: ідентифікатор додаткової послуги
count кількість додаткових послуг -
units:
таблиця місць вантажу
rows: масив місць вантажу в таблиці
weight: вага місця
height: висота місця
length: довжина місц
width: ширина місця
declaredCost: задекларована вартість місця
description: ідентифікатор опису вантажу
cargoType: ідентифікатор типу вантажу -
additionalInformation:
примітка
-
banDeliveryPhone:
номер телефону, на який буде надіслано код зняття заборони на видачу в разі додавання відповідної послуги (380XXXXXXXXX)
-
isDetailingByUnits:
true (обов'язковий параметр)
приклад запиту
<request>
<item>
<rspRecipient>bbf8e497-33a7-11dd-a17a-001a4d3b885e</rspRecipient>
<payerType>Получатель</payerType>
<paymentMethod>Cash</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>
<isDetailingByUnits>true</isDetailingByUnits>
<units>
<rows>
<declaredCost>300</declaredCost>
<description>80ca645c-51d4-11e8-9403-00505601031c</description>
<weight>2</weight>
<width>1</width>
<length>1</length>
<height>1</height>
<volume>1</volume>
<cargoType>Базовый</cargoType>
</rows>
<rows>
<declaredCost>300</declaredCost>
<description>80ca645c-51d4-11e8-9403-00505601031c</description>
<weight>24</weight>
<width>1</width>
<length>11</length>
<height>1</height>
<volume>1</volume>
<cargoType>Базовый</cargoType>
</rows>
</units>
</item>
</request>
Відповідь 200
приклад відповіді
<response>
<success>true</success>
<data>
<item>
<ref>59cb9c04-2eb6-4792-9efb-d0bfac25392e</ref>
<number>122000030</number>
<date>07.02.2024 09:57:17</date>
<departureCost>0</departureCost>
<deliveryCost>0</deliveryCost>
<cost>542</cost>
<barcode>12202053177009</barcode>
<barcode>12202053178009</barcode>
<addServices>
<service>4293056e-4cb1-406d-a2cd-e8f6d2ae6721</service>
<cost>370</cost>
</addServices>
<addServices>
<service>4fdbcdc1-72ed-4e7b-bd69-6a8cd19ee00b</service>
<cost>14</cost>
</addServices>
<orderDeparture/>
</item>
</data>
</response>
інтерфейси API