Try it — UpdateDocument
SOAP Request

Отредактируйте параметры запроса и нажмите Выполнить для отправки запроса на сервер

UpdateDocument: Обновление информации в документе

  • Создано 16.04.2026
  • Обновлено 16.05.2026
  • Endpoint: UpdateDocument
  • Soap-method: UpdateDocument
Описание

Функция позволяет обновляет информацию о составном грузе в документе, при условии что документ, в который добавляются места, не обработан (не проведен). 

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

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

  • Key — название параметра (варианты в таблице ниже)
  • Value — значение этого параметра
  • ValueType — тип значения этого параметра
Параметр Тип Обязательно Описание
DocumentType string Тип документа для обновления
Number string Номер документа
numbertype string Номер документа, в который будут добавляться грузовые места
Описание параметра data

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

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

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

Таблица параметров (возможные значения Key для Fields). Может быть любое поле из документа, приведем пример по нескольким: 

Параметр Тип Обязательно Описание
ClientNumber string Внешний номер заказа (номер заказа клиента)
InsuranceValue float Страховая стоимость груза
Описание возвращаемого параметра return

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

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

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

Если во время запроса произошла ошибка, информация о ней будет отражена в свойстве Properties (см. раздел Errors). 

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

Параметр Тип Обязательно Описание
DocumentNumber string Номер обновлённого документа
Update boolean Результат обновления: true — успешно, false — ошибка
Примеры запроса/ответа 
<soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:car="http://www.cargo3.ru">
  <soapenv:Header/>
  <soapenv:Body>
    <car:UpdateDocument>
      <car:Login>test</car:Login>
      <car:Password>2016</car:Password>
      <car:data>
        <car:Key>updatedocument</car:Key>
        <car:List>
          <car:Key> UpdateDocument</car:Key>
          <car:Fields>
            <car:Key>ClientNumber</car:Key>
            <car:Value>124578124578</car:Value>
            <car:ValueType>string</car:ValueType>
          </car:Fields>
          <car:Fields>
            <car:Key>InsuranceValue</car:Key>
            <car:Value>100</car:Value>
            <car:ValueType>float</car:ValueType>
          </car:Fields>
        </car:List>
      </car:data>
      <car:parameters>
        <car:Key>parameters</car:Key>
        <car:List>
          <car:Key>DocumentType</car:Key>
          <car:Value>waybill</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
        <car:List>
          <car:Key>Number</car:Key>
          <car:Value>888-0006983-00004806</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
        <car:List>
          <car:Key>numbertype</car:Key>
          <car:Value>innernumber</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
      </car:parameters>
    </car:UpdateDocument>
  </soapenv:Body>
</soapenv:Envelope>
<soap:Envelope
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <m:UpdateDocumentResponse
      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>UpdateDocument</m:Key>
        <m:List>
          <m:Key>Document</m:Key>
          <m:Properties>
            <m:Key>DocumentNumber</m:Key>
            <m:Value xsi:type="xs:string">888-0006983-00004806</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Update</m:Key>
            <m:Value xsi:type="xs:boolean">true</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Properties>
        </m:List>
      </m:return>
    </m:UpdateDocumentResponse>
  </soap:Body>
</soap:Envelope>