API v1.0 - 3. Трекинг
3.1. Трекинг по отправлению GET
Получение данных трекинга по отправлению
Параметры запроса
Заголовки
Request URL
https://api.sat.ua/study/hs/api/v1.0/tracking/{format}
Содержимое ответа
URL-адрес запроса
Параметры запроса
| 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: сумма оплаты
- date: дата записи об изменении состояния
- status: состояние
- town: город
Пример ответа
<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>
{
"success": "true",
"data": [
{
"number": "009000119",
"currentStatus": "Поступил на склад выдачи",
"sum": 266,
"weight": 15,
"width": 0,
"length": 0,
"height": 0,
"seatsAmount": 1,
"volume": 0,
"cargoType": "Стандарт (от 10 кг)",
"date": "15.04.2015",
"arrivalDate": "15.04.2015",
"type": "склад-склад",
"rspFrom": "Харків",
"rspTo": "Київ",
"payData": [
{
"payerId": "Получатель",
"sum": 266
}
],
"states": [
{
"date": "15.04.2015",
"status": "Принят",
"town": "Харків"
},
{
"date": "15.04.2015",
"status": "Поступил на склад выдачи",
"town": "Київ"
}
]
}
]
}
