API v1.0 - 6. Накладная на груз
6.3. Удаление созданной накладной на груз
Удаление ранее созданной накладных на груз. Возможно до обработки накладной оператором САТ и до помещения накладной в ведомость передачи груза.
Параметры запроса
Заголовки
Текст запроса
Доступные поля:
- ref: идентификатор или массив идентификаторов созданной накладной на груз, полученный в ответе операции "Создание накладной на груз"
Request URL
https://api.sat.ua/study/hs/api/v1.0/documents/nng/{format}/delete
Содержимое ответа
URL-адрес запроса
Параметры запроса
| format | string | Формат данных для получения ответа (xml, json) | |
|
apiKey |
|
string |
Ключ пользователя ТК САТ. Для получения ключа нужно пройти регистрацию. Ключ может быть передан как через параметр URL, так и в заголовке HTTP запроса В режиме тестирования без регистрации используйте ключ: devApiKey |
Текст запроса
Доступные поля:
- ref: идентификатор или массив идентификаторов созданной накладной на груз, полученный в ответе операции "Создание накладной на груз"
<request>
<ref>ee40d084-3b3d-434f-877a-09fee724a5ed</ref>
</request>
[
{
"ref": "ee40d084-3b3d-434f-877a-09fee724a5ed"
}
]
Ответ 200
Значение полей ответа:
- ID: свой идентификатор набора параметров, переданный в запросе
- ref: идентификатор созданной накладной
- number: номер созданной накладной
- cost: рассчитанная стоимость перевозки
- barcode: массив штрихкодов, по количеству мест (поле seatsAmount)
- addServices: массив дополнительных услуг
- service: идентификатор дополнительной услуги
- cost: стоимость дополнительной услуги
Пример ответа
<response>
<success>true</success>
<data>
<item>
<ref>ee40d084-3b3d-434f-877a-09fee724a5ed</ref>
<number>009000359</number>
</item>
</data>
</response>
[
{
"ref": "ee40d084-3b3d-434f-877a-09fee724a5ed",
"number": "009000359"
}
]
