API V1.0 – 3.2. ТРЕКІНГ ЗА ВІДПРАВЛЕННЯМИ POST
Отримання даних трекінгу за відправленнями
URL-Адреса запиту:
https://api.sat.ua/study/hs/api/v1.0/tracking/{format}[?apiKey]Параметри запиту:
Текст запиту (доступні поля):
-
Масив номерів або ідентифікаторів накладних на вантаж:
-
number:
номер або масив номерів накладних
-
ref :
ідентифікатор або масив ідентифікаторів накладних (Доступно тільки за умови вказівки коректного ключа apiKey і тільки за накладними, створеними з цим ключем).
приклад запиту
<request>
<number>006002524</number>
<number>015010663</number>
<ref>d2eda3e2-4b55-49ad-aeb3-1d728237ac11</ref>
</request>
Відповідь 200
Дані за запитаними накладними на вантаж. Значення полів, що повертаються:
-
number:
номер накладної
-
currentStatus:
поточний статус накладної на вантаж. За виданими накладними всі подальші поля виводяться тільки авторизованим користувачам
-
sum:
сума за накладною на вантаж
-
weight:
вага вантажу
-
width:
ширина всіх місць відправлення
-
length:
довжина всіх місць відправлення
-
height:
висота всіх місць відправлення
-
seatsAmount:
кількість місць
-
загальний об'єм усіх місць відправлення:
volume
-
cargoType:
тип вантажу
-
date:
дата відправлення накладної
-
arrivalDate:
дата прибуття на склад відділення одержувача вантажу
-
type:
тип послуги перевезення
-
rspFrom:
відділення відправлення вантажу
-
rspTo:
відділення отримання вантажу
-
payData:
інформація про платників за перевезення, масив
-
payerId:
ідентифікатор платника
-
sum:
сума оплати
-
states:
інформація про зміну стану накладної, масив
-
date:
дата запису про зміну стану
-
status:
стан
-
town:
місто
приклад відповіді
<response>
<success>true</success>
<data>
<item>
<number>009000119</number>
<currentStatus>Поступил на склад выдачи</currentStatus>
<sum>266</sum>
<weight>15</weight>
<width>0</width>
<length>0</length>
<height>0</height>
<seatsAmount>1</seatsAmount>
<volume>0</volume>
<cargoType>Стандарт (от 10 кг)</cargoType>
<date>15.04.2015</date>
<arrivalDate>15.04.2015</arrivalDate>
<type>склад-склад</type>
<rspFrom>Харків</rspFrom>
<rspTo>Київ</rspTo>
<payData>
<payerId>Получатель</payerId>
<sum>266</sum>
</payData>
<states>
<date>15.04.2015</date>
<status>Принят</status>
<town>Харків</town>
</states>
<states>
<date>15.04.2015</date>
<status>Поступил на склад выдачи</status>
<town>Київ</town>
</states>
</item>
</data>
</response>
інтерфейси API