API v1.0 - 7. Ведомость передачи
7.4. Получение списка ведомостей передачи груза
Получение списка ведомостей передачи груза за указанную дату.
Параметры запроса
Заголовки
Request URL
https://api.sat.ua/study/hs/api/v1.0/documents/spreadSheet/{format}/list
Содержимое ответа
URL-адрес запроса
Параметры запроса
| format | string | Формат данных для получения ответа (xml, json) | |
| date |
|
string |
Дата, накладные за которую требуется получить, в формате DD.MM.YYYY |
|
apiKey |
|
string |
Ключ пользователя ТК САТ. Для получения ключа нужно пройти регистрацию. Ключ может быть передан как через параметр URL, так и в заголовке HTTP запроса В режиме тестирования без регистрации используйте ключ: devApiKey |
Ответ 200
Данные по ведомостям передачи за указанный период.
Значение возвращаемых полей:
- ref: идентификатор ведомости передачи груза
- number: номер ведомости передачи груза
- date: дата отправления груза
- phone: контактный телефон
- note: примечание
- documentRef: массив идентификаторов накладных на груз
Пример ответа
<response>
<success>true</success>
<data>
<item>
<ref>00581817-4b5a-47f6-b365-922dc3c42d70</ref>
<number>005003409</number>
<date>05-10-2015</date>
<phone>0632323232</phone>
<note>хрупкий груз</note>
<documentRef>9a0cb936-5709-4956-ad7b-e54e37beefa5</documentRef>
<documentRef>81ccbfbe-2aaa-49c0-895b-01ecc16ba3d2</documentRef>
</item>
</data>
</response>
[
{
"ref": "00581817-4b5a-47f6-b365-922dc3c42d70",
"number": "005003409",
"date": "05-10-2015",
"phone": "0632323232",
"note": "хрупкий груз",
"documentRef": [
"9a0cb936-5709-4956-ad7b-e54e37beefa5",
"81ccbfbe-2aaa-49c0-895b-01ecc16ba3d2"
]
}
]
