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: город
Пример ответа
<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>
{
"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": "Київ"
}
]
}
]
}
