API V1.0 – 3.1. ТРЕКІНГ ЗА ВІДПРАВЛЕННЯМ GET
Отримання даних трекінгу за відправленням
- відділення або місто відправлення
- відділення або місто отримання
- вага та об'єм вантажу
- тип вантажу
- додаткові послуги та умови
Допускає передавання для розрахунку до 10 наборів даних.
URL-Адреса запиту:
https://api.sat.ua/study/hs/api/v1.0/tracking/{format}[?number][&ref][&apiKey]Параметри запиту:
format
string
Формат даних для отримання відповіді (xml, json)
number (додатковий)
string
Номер накладної на вантаж
ref (додатковий)
string
Ідентифікатор накладної на вантаж. Доступно тільки в разі зазначення коректного ключа apiKey і тільки за накладними, створеними з цим ключем.
apiKey (додатковий)
string
Ключ користувача ТК САТ. Для отримання ключа потрібно пройти реєстрацію. Ключ може бути переданий як через параметр URL, так і в заголовку HTTP запиту У режимі тестування без реєстрації використовуйте ключ: devApiKey
Відповідь 200
Дані за запитаними накладними на вантаж. Значення полів, що повертаються:
-
number:
номер накладної
-
currentStatus:
поточний статус накладної на вантаж. За виданими накладними всі подальші поля виводяться тільки авторизованим користувачам
-
sum:
сума за накладною на вантаж
-
weight:
вага вантажу
-
width:
ширина всіх місць відправлення
-
length:
довжина всіх місць відправлення
-
height:
висота всіх місць відправлення
-
seatsAmount:
кількість місць
-
volume:
загальний об'єм усіх місць відправлення
-
cargoType:
тип вантажу
-
date:
дата відправлення накладної
-
arrivalDate:
дата прибуття на склад відділення одержувача вантажу
-
type:
тип послуги перевезення
-
rspFrom:
відділення відправлення вантажу
-
rspTo:
відділення отримання вантажу
-
payData:
інформація про платників за перевезення, масив
-
payerId:
ідентифікатор платника
-
sum:
сума оплати
-
states:
інформація про зміну стану накладної, масив
-
date:
дата запису про зміну стану
-
status:
стан
-
town:
місто
приклад відповіді
text/xml
| application/json
<span>
true <span> <span>
009000119 Поступил на склад выдачи 266 15 0 0 0 1 0 Стандарт (от 10 кг) 15.04.2015 15.04.2015 склад-склад Харків Київ Получатель 266 15.04.2015 Принят Харків 15.04.2015 Поступил на склад выдачи Київ </span> </span> </span>
інтерфейси API