API V1.0 – 6.1 Создание накладной с детализацией мест
Создание накладных на груз по переданным параметрам
URL-Адрес запроса:
https://api.sat.ua/study/hs/api/v1.0/documents/nng/{format}/save[?apiKey]Параметры запроса:
Текст запроса (доступные поля):
-
ID:
собственный идентификатор накладной. Возвращается после создания
-
date:
дата накладной в формате DD-MM-YYYYY
-
departure:
признак выезда к двери отправителя (true/false)
-
delivery:
признак доставки до дверей получателя (true/false)
-
arrivalDate:
дата доставки в формате DD-MM-YYYYYY
- contactSender:
-
senderPhone:
телефон отправителя (380XXXXXXXXXXXXX)
-
rspSender:
идентификатор отделения отправителя (не нужен при передаче apiKey)
-
townSender:
идентификатор города отправителя (не нужен при передаче apiKey)
-
senderAddress:
адрес отправителя
- rspRecipient:
- townRecipient:
- recipient:
-
contactRecipient:
идентификатор контактного лица получателя
-
recipientAddress:
адрес получателя
-
recipientPhone:
телефон получателя (380XXXXXXXXXXXXXXX)
-
declaredCost:
задекларированная стоимость
- departureCondition:
- deliveryCondition:
- payerType:
- paymentMethod:
-
addServices:
дополнительные услуги
service: идентификатор дополнительной услуги
count количество дополнительных услуг -
units:
таблица мест груза
rows: массив мест груза в таблице
weight: вес места
height: высота места
length: длина места
width: ширина места
declaredCost: задекларированная стоимость места
description: идентификатор описания груза
cargoType: идентификатор типа груза -
additionalInformation::
примечание
-
banDeliveryPhone:
номер телефона, на который будет отправлен код снятия запрета на выдачу в случае добавления соответствующей услуги (380XXXXXXXXXXX)
-
isDetailingByUnits:
истинный (обязательный параметр)
пример запроса
<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