DeleteDocuments: Отмена заказа/накладной

SOAP Endpoint: DeleteDocuments Обновлено: 2026-05-16

Endpoint: DeleteDocuments
SOAP-метод: DeleteDocuments
Группа: DeleteDocuments
Создано: 16.04.2026 · Обновлено: 16.05.2026

Описание

Функция отменяет либо делает запрос на отмену документа в системе «Карго». Для заказов и накладных, если документ не пошел в работу, то он отменяется автоматически, иначе формируется запрос на отмену. Можно отменять заказы с типом: «На доставку», «На склад».

Параметры запроса

Параметр	Тип	Обязательно	Описание
login	string	да	Логин пользователя
password	string	да	Пароль
parameters	Element	да	Список параметров

Описание параметра parameters

Содержит список грузовых мест для создания. Содержит Key = "parameters" и список элементов List

List содержит данные о параметрах документа для удаления и причине удаления. Каждый параметр представлен отдельным блоком Properties, содержащим:

Key — название параметра (варианты в таблице ниже)
Value — значение этого параметра
ValueType — тип значения этого параметра

Таблица параметров (возможные значения Key внутри Properties):

Параметр	Тип	Обязательно	Описание
DocumentType	string	да	Тип документа для удаления, должно быть равно «Order» или «Waybill»
Number	string	да	Номер документа, который нужно отменить
Reason	string	да	Причина отмены
ClientContact	string	да	Данные контактного лица для связи
Phone	string	нет	Телефон для связи
Email	string	нет	Почта для связи

Описание возвращаемого параметра return

Содержит пару параметров Key и List содержащие ответ по одному грузовому месту

Структура List пару параметров Key и Properties содержащие информацию по одному из параметров грузового места. Каждый параметр представлен отдельным блоком Properties, содержащим:

Key — название параметра (варианты в таблице ниже)
Value — значение этого параметра
ValueType — тип значения этого параметра

Таблица параметров (возможные значения Key для Properties):

Параметр	Тип	Обязательно	Описание
DocumentType	string	нет	Тип документа
Number	string	нет	Номер документа
Reason	string	нет	Причина удаления (возвращается из запроса)
ClientContact	string	нет	Контактное лицо (возвращается из запроса)
Phone	string	нет	Контактный телефон (возвращается из запроса)
Error	boolean	нет	Флаг ошибки: true — ошибка, false — успех

Пример запроса (XML Request)

xml

<soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:car="http://www.cargo3.ru">
  <soapenv:Header/>
  <soapenv:Body>
    <car:DeleteDocuments>
      <car:login>test</car:login>
      <car:password>2016</car:password>
      <car:parameters>
        <car:Key>parameters</car:Key>
        <car:List>
          <car:Key>parameters</car:Key>
          <car:Properties>
            <car:Key>DocumentType</car:Key>
            <car:Value>Order</car:Value>
            <car:ValueType>string</car:ValueType>
          </car:Properties>
          <car:Properties>
            <car:Key>Number</car:Key>
            <car:Value>888-0000110205</car:Value>
            <car:ValueType>string</car:ValueType>
          </car:Properties>
          <car:Properties>
            <car:Key>Reason</car:Key>
            <car:Value>проверка работы функции</car:Value>
            <car:ValueType>string</car:ValueType>
          </car:Properties>
          <car:Properties>
            <car:Key>ClientContact</car:Key>
            <car:Value>tsaet dfvc</car:Value>
            <car:ValueType>string</car:ValueType>
          </car:Properties>
          <car:Properties>
            <car:Key>Phone</car:Key>
            <car:Value>1234554</car:Value>
            <car:ValueType>string</car:ValueType>
          </car:Properties>
        </car:List>
      </car:parameters>
    </car:DeleteDocuments>
  </soapenv:Body>
</soapenv:Envelope>

Пример ответа (XML Response)

xml

<soap:Envelope
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <m:DeleteDocumentsResponse
      xmlns:m="http://www.cargo3.ru">
      <m:return
        xmlns:xs="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <m:Key>DeleteDocuments</m:Key>
        <m:List>
          <m:Key>Order</m:Key>
          <m:Properties>
            <m:Key>DocumentType</m:Key>
            <m:Value xsi:type="xs:string">Order</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Number</m:Key>
            <m:Value xsi:type="xs:string">888-0000112059</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Reason</m:Key>
            <m:Value xsi:type="xs:string">проверка работы функции</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>ClientContact</m:Key>
            <m:Value xsi:type="xs:string">tsaet dfvc</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Phone</m:Key>
            <m:Value xsi:type="xs:string">1234554</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Error</m:Key>
            <m:Value xsi:type="xs:boolean">true</m:Value>
            <m:ValueType>boolean</m:ValueType>
            <m:List>
              <m:Key>Description</m:Key>
              <m:Value xsi:type="xs:string">Запрос на отмену документа 888-0000112059 уже отправлен</m:Value>
              <m:ValueType>string</m:ValueType>
            </m:List>
          </m:Properties>
        </m:List>
      </m:return>
    </m:DeleteDocumentsResponse>
  </soap:Body>
</soap:Envelope>