API V1.0 – 4.2. ЗМІНА ОФОРМЛЕНОЇ ЗАЯВКИ НА ВИЇЗД
Зміна заявки на виїзд експедитора ТК САТ до відправника (тільки для авторизованих користувачів)
URL-Адреса запиту:
https://api.sat.ua/study/hs/api/v1.0/documents/order/departure/{format}/update[?apiKey]Параметри запиту:
Текст запиту (доступні поля):
-
Допустимі поля:
(жирним виділено поля, правила заповнення яких відрізняються для авторизованих користувачів, що мають apiKey)
-
ID:
власний ідентифікатор заявки. Повертається після створення ref: ідентифікатор заявки
- ref:
-
orderDate:
планована дата і час відправлення вантажу (у форматі DD-MM-YYYY HH:mm:ss)
-
sender:
найменування відправника вантажу (не потрібне під час передання apiKey)
-
rspSender:
ідентифікатор відділення відправника (не вимагається при передачі apiKey)
-
townSender:
ідентифікатор міста відправника (не вимагається при передачі apiKey)
-
senderAddress:
адреса відправника (можна не вказувати при передачі apiKey)
-
contactSender:
ідентифікатор контактної особи відправника (для авторизованих користувачів) або ПІБ контактної особи
-
senderPhone:
телефон відправника (можна не вказувати при передачі apiKey)
-
seatsAmount:
загальна кількість місць відправлення
-
addServices:
додаткові послуги
service: ідентифікатор додаткової послуги
count: кількість -
description:
ідентифікатор опису вантажу
-
weight:
загальна вага вантажу
-
length:
довжина всіх місць відправлення
-
width:
ширина всіх місць відправлення
-
height:
висота всіх місць відправлення
-
volume:
загальний обсяг вантажу
-
additionalInformation:
примітка
-
departureCondition:
додаткова умова виїзду
-
payerType:
ідентифікатор типу платника
-
paymentMethod:
ідентифікатор виду оплати
-
recipients:
масив одержувачів або один одержувач вантажу
- delivery: ознака доставки вантажу до дверей одержувача
- rspSender: ідентифікатор відділення одержувача
- townRecipient: ідентифікатор міста одержувача
- recipientAddress: адреса одержувача
- recipient: ідентифікатор одержувача (тільки для авторизованих користувачів)
- contactRecipient: ідентифікатор контактної особи одержувача (тільки для авторизованих користувачів)
- recipientPhone: телефон одержувача
- seatsAmount: кількість місць для цього одержувача
- cargoType: ідентифікатор типу вантажу
- weight: вага відправлення для цього одержувача
- width: ширина
- height: висота
- deliveryCondition: додаткова умова доставки
- addServices: додаткові умови під час доставки вантажу цьому одержувачу
-- service: ідентифікатор додаткової послуги
-- count: кількість
приклад запиту
<request>
<item>
<ID>123</ID>
<ref>ef588255-3f2e-4c2a-8b86-be8b18f1bb0c</ref>
<sender>ТОВ Аллигатор-Плюс</sender>
<senderAddress>ул.Петлюры 6, оф 12</senderAddress>
<senderPhone>0632323232</senderPhone>
<contactSender>Петр</contactSender>
<townSender>bbf8e4a1-33a7-11dd-a17a-001a4d3b885e</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>
<recievers>
<rspReciever>4293056e-4cb1-406d-a2cd-e8f6d2ae6721</rspReciever>
<cargoType>Стандарт</cargoType>
</recievers>
</item>
</request>
Відповідь 200
Ідентифікатор і номер зміненої заявки.
-
ID:
власний ідентифікатор заявки, переданий у запиті
-
ref:
ідентифікатор створеної заявки
-
number:
номер створеної заявки
приклад відповіді
<response>
<success>true</success>
<data>
<item>
<ID>123</ID>
<ref>ef588255-3f2e-4c2a-8b86-be8b18f1bb0c</ref>
<number>009000039</number>
</item>
</data>
</response>
інтерфейси API