Данный метод используется для удаления группового закза по его номеру. Для запроса API использует структуру application/x-www-form-urlencoded и стандартный HTTP-метод POST.
Входные данные запроса deleteConsignment
# | Название атрибута | Тип | Обязательность | Описание |
---|---|---|---|---|
1 | sessionID | текст | Да | Идентификатор сессии, полученный от сервера после запроса авторизации. |
1 | consignmentReference | число | Да | Номер группового заказа (пары связанных заказов Pickup & Delivery). |
Заголовки:
URL: rest/2/distribution-api/orders/deleteConsignment
Метод: POST
Структура: application/x-www-form-urlencoded.
Пример запроса deleteConsignment
Code Block |
---|
<?xmlversion="1.0" encoding="UTF-8"?>
<apiRequest>
<sessionID>8a0478af973e40c2bbe6679fac1d17a6</sessionID>
<consignments>
<consignment>
<consignmentReference>bo1</consignmentReference>
</consignment>
</consignments>
</apiRequest> |
Пример ответа deleteConsignment
Code Block |
---|
<?xml version='1.0' encoding='UTF-8'standalone='yes' ?>
<apiResponse version="1.0">
<consignments>
<consignment>
<consignmentReference>bo1</consignmentReference>
<orders>
<order>
<orderReference>2311_1</orderReference>
<status>Deleted</status>
</order>
<order>
<orderReference>2311_2</orderReference>
<status>Deleted</status>
</order>
</orders>
</consignment>
</consignments>
</apiResponse> |