API V1.0 – 4.1. СТВОРЕННЯ ЗАЯВКИ НА ВИЇЗД ЗА ВАНТАЖЕМ
Оформлення заявки на виїзд експедитора ТК САТ до відправника.
Для отримання ключа потрібно пройти реєстрацію. Ключ може бути переданий як через параметр URL, так і в заголовку HTTP запиту У режимі тестування без реєстрації використовуйте ключ: devApiKey
URL-Адреса запиту:
https://api.sat.ua/study/hs/api/v1.0/documents/order/departure/{format}/save[?apiKey]Параметри запиту:
Текст запиту (доступні поля):
-
(жирним виділено поля, правила заповнення яких відрізняються для авторизованих користувачів, що мають apiKey):
-
ID:
власний ідентифікатор заявки. Повертається після створення
-
orderDate:
планована дата і час відправлення вантажу (у форматі DD-MM-YYYY HH:mm:ss)
-
sender:
найменування відправника вантажу (не потрібне під час передання apiKey)
-
rspSender:
ідентифікатор відділення відправника (не вимагається при передачі apiKey)
-
townSender:
ідентифікатор міста відправника (не вимагається при передачі apiKey)
-
senderAddress:
адреса відправника (можна не вказувати при передачі apiKey)
-
contactSender:
ідентифікатор контактної особи відправника (для авторизованих користувачів) або ПІБ контактної особи
-
senderPhone:
телефон відправника (можна не вказувати при передачі apiKey)
-
seatsAmount:
загальна кількість місць відправлення
-
addServices:
додаткові послуги
service: ідентифікатор додаткової послуги
count: кількість -
description:
ідентифікатор опису вантажу
-
weight:
вага вантажу (всіх місць загальна)
-
width:
ширина (максимальна 1го місця)
-
length:
довжина (максимальна 1го місця)
-
height:
висота (максимальна 1го місця)
-
volume:
об'єм вантажу (всіх місць загальний)
-
additionalInformation:
примітка
-
departureCondition:
додаткова умова виїзду
-
payerType:
ідентифікатор типу платника
-
paymentMethod:
ідентифікатор виду оплати
-
recipients:
одержувач вантажу
delivery: ознака доставки вантажу до дверей одержувача
rspRecipient: ідентифікатор відділення одержувача
townRecipient:ідентифікатор міста одержувача
recipientAddress: адреса одержувача
recipient: ідентифікатор одержувача (тільки для авторизованих користувачів)
contactRecipient: ідентифікатор контактної особи одержувача (тільки для авторизованих користувачів)
recipientPhone: телефон одержувача
seatsAmount: кількість місць для цього одержувача
cargoType: ідентифікатор типу вантажу
weight: вага відправлення для цього одержувача
width: ширина
height:висота
deliveryCondition: додаткова умова доставки
addServices: додаткові умови під час доставки вантажу цьому одержувачу
service: ідентифікатор додаткової послуги
count:кількість
units:таблиця місць вантажу
rows: масив місць вантажу в таблиці
weight: вага місця
height: висота місця
length: довжина місц
width: ширина місця
declaredCost: задекларована вартість місця
description: ідентифікатор опису вантажу
cargoType: ідентифікатор типу вантажу
приклад запиту
<request>
<ID>123</ID>
<sender>ТОВ Аллигатор-Плюс</sender>
<senderAddress>ул.Петлюры 6, оф 12</senderAddress>
<senderPhone>0632323232</senderPhone>
<contactSender>Петр</contactSender>
<townSender>8d7f5ea4-9436-11dd-98c6-001cc0108cd1</townSender>
<weight>5</weight>
<seatsAmount>5</seatsAmount>
<description>106c69c5-fe17-4107-a211-ba9f0032e2c5</description>
<addServices>
<service>4293056e-4cb1-406d-a2cd-e8f6d2ae6721</service>
<count>2</count>
</addServices>
<recipients>
<rspRecipient>bbf8e497-33a7-11dd-a17a-001a4d3b885e</rspRecipient>
<cargoType>Стандарт</cargoType>
<declaredCost>300</declaredCost>
<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>
</recipients>
</request>
Відповідь 200
Ідентифікатор (тільки для авторизованих користувачів) і номер створеної заявки.
-
ID:
власний ідентифікатор заявки, переданий у запиті
-
ref:
ідентифікатор створеної заявки
-
number:
номер створеної заявки
приклад відповіді
<response>
<success>true</success>
<data>
<item>
<ID>123</ID>
<ref>f324ef75-33e3-4127-a8b9-d24dd3188784</ref>
<number>009866819</number>
</item>
</data>
</response>
інтерфейси API