API v1.0 - 6. Накладная на груз
6.4. Получение списка накладных на груз
Получение накладных на груз авторизированного отправителя за указанную дату.
Параметры запроса
Заголовки
Request URL
https://api.sat.ua/study/hs/api/v1.0/documents/nng/{format}/list
Содержимое ответа
URL-адрес запроса
Параметры запроса
| format | string | Формат данных для получения ответа (xml, json) | |
|
apiKey |
|
string |
Ключ пользователя ТК САТ. Для получения ключа нужно пройти регистрацию. Ключ может быть передан как через параметр URL, так и в заголовке HTTP запроса В режиме тестирования без регистрации используйте ключ: devApiKey |
| date |
(дополнительный) |
string |
Дата, накладные за которую требуется получить, в формате DD.MM.YYYY |
| number |
(дополнительный) |
string |
Номер накладной, данные по которой запрашиваются |
| ref |
(дополнительный) |
string |
Уникальный идентификатор накладной, данные по которой запрашиваются |
Ответ 200
Данные по накладным за указанный период.
Значение возвращаемых полей:
- ref: идентификатор накладной
- posted: признак обработки накладной оператором САТ
- number: номер накладной
- sender: идентификатор отправителя
- contactSender: идентификатор контакта отправителя
- rspSender: идентификатор отделения отправления
- townSender: идентификатор города отправления
- departure: признак выезда за грузом до дверей отправителя
- delivery: признак доставки груза до дверей получателя
- senderAddress: адрес отправителя
- senderPhone: телефон отправителя
- recipient: идентификатор получателя груза
- contactRecipient:идентификатор контактного лица получателя груза
- rspRecipient: идентификатор отделения получения
- townRecipient: идентификатор города получения
- recipientAddress: адрес получателя
- recipientPhone: телефон получателя
- seatsAmount: количество мест
- payerType: тип плательщика
- paymentMethod: вид оплаты
- description: идентификатор описания груза
- cargoType: идентификатор типа груза
- weight: вес груза
- width: ширина всех мест отправления
- length: длина всех мест отправления
- height: высота всех мест отправления
- volumeGeneral: общий объем всех мест отправления
- additionalInformation: дополнительная информация, примечания
- departureConditionи: идентификатор дополнительного условия выезда
- deliveryCondition: идентификатор дополнительного условия доставки
- addServices: дополнительные условия перевозки
- service: идентификатор дополнительной услуги
- count: количество дополнительных услуг
Пример ответа
<response>
<success>true</success>
<data>
<item>
<ref>d9681bc6-1e5a-411b-8945-cefa059ee780</ref>
<date>21.09.2015</date>
<posted>0</posted>
<number>009000272</number>
<sender>6b216945-9e26-463f-9f5d-c002ae3a8824</sender>
<contactSender>00000000-0000-0000-0000-000000000000</contactSender>
<rspSender>bbf8e497-33a7-11dd-a17a-001a4d3b885e</rspSender>
<townSender>8d7f5ea4-9436-11dd-98c6-001cc0108cd1</townSender>
<departure>0</departure>
<delivery>0</delivery>
<senderAddress/>
<senderPhone/>
<recipient>f99c20ea-182e-11e2-89e8-0017a4770440</recipient>
<contactRecipient>00000000-0000-0000-0000-000000000000</contactRecipient>
<rspRecipient>bbf8e4a1-33a7-11dd-a17a-001a4d3b885e</rspRecipient>
<townRecipient>44a76f22-932a-11da-9860-00024407fbce</townRecipient>
<recipientAddress/>
<recipientPhone/>
<seatsAmount>5</seatsAmount>
<description>106c69c5-fe17-4107-a211-ba9f0032e2c5</description>
<cargoType>Стандарт</cargoType>
<weight>5</weight>
<width>0</width>
<volumeGeneral>0</volumeGeneral>
<additionalInformation/>
<deliveryCondition>5211f93e-4ba2-4406-bd2d-0f021f1987e3</deliveryCondition>
<departureCondition>8a810b11-6184-4be5-b199-9d6285b6d4a1</departureCondition>
<addServices>
<service>4293056e-4cb1-406d-a2cd-e8f6d2ae6721</service>
<count>2</count>
</addServices>
<addServices>
<service>4fdbcdc1-72ed-4e7b-bd69-6a8cd19ee00b</service>
<count>2</count>
</addServices>
</item>
</data>
</response>
{
"success": "true",
"data": [
{
"ref": "d9681bc6-1e5a-411b-8945-cefa059ee780",
"date": "21.09.2015",
"posted": "0",
"number": "009000272",
"sender": "6b216945-9e26-463f-9f5d-c002ae3a8824",
"contactSender": "00000000-0000-0000-0000-000000000000",
"rspSender": "bbf8e497-33a7-11dd-a17a-001a4d3b885e",
"townSender": "8d7f5ea4-9436-11dd-98c6-001cc0108cd1",
"departure": "0",
"delivery": "0",
"senderAddress": "",
"senderPhone": "",
"recipient": "f99c20ea-182e-11e2-89e8-0017a4770440",
"contactRecipient": "00000000-0000-0000-0000-000000000000",
"rspRecipient": "bbf8e4a1-33a7-11dd-a17a-001a4d3b885e",
"townRecipient": "44a76f22-932a-11da-9860-00024407fbce",
"recipientAddress": "",
"recipientPhone": "",
"seatsAmount": 5,
"description": "106c69c5-fe17-4107-a211-ba9f0032e2c5",
"cargoType": "Стандарт",
"weight": 5,
"width": 0,
"volumeGeneral": 0,
"additionalInformation": "",
"deliveryCondition": "5211f93e-4ba2-4406-bd2d-0f021f1987e3",
"departureCondition": "8a810b11-6184-4be5-b199-9d6285b6d4a1",
"addServices": [
{
"service": "4293056e-4cb1-406d-a2cd-e8f6d2ae6721",
"count": 2
},
{
"service": "4fdbcdc1-72ed-4e7b-bd69-6a8cd19ee00b",
"count": 2
}
]
}
]
}
